Docs › API reference › Hosted SDK data
Get hosted SDK decision result
Returns the decision result for a verification run through the hosted SDK.
This endpoint is for customers using the WebView (mobile or web) implementation. Unlike Get decision results, it does not need a session ID, which the WebView implementation does not expose.
GET
https://api.screenlyyid.com/api/v1/document/resultHeaders#
| Name | Type | Required | Description |
|---|---|---|---|
x-api-key | string | Yes | Your ScreenlyyID API key |
x-correlation-id | string (uuid) | Yes | Correlation ID for this customer check |
Responses#
| Status | Description |
|---|---|
200 | Successful response |
Response body (200)#
| Field | Type | Required | Description |
|---|---|---|---|
Verifications | object | No | |
Verifications.DateOfExpiration | object | No | |
Verifications.DateOfExpiration.Score | string | No | |
Verifications.DateOfExpiration.Level | string | No | |
Verifications.DocumentLiveness | object | No | |
Verifications.DocumentLiveness.Score | string | No | |
Verifications.DocumentLiveness.Level | string | No | |
Verifications.FaceVerification | object | No | |
Verifications.FaceVerification.Score | string | No | |
Verifications.FaceVerification.Level | string | No | |
Verifications.MrzOcrCrossCheck | object | No | |
Verifications.MrzOcrCrossCheck.Fields | array of object | No | |
Verifications.MrzOcrCrossCheck.Fields[].InputFieldName | string | No | |
Verifications.MrzOcrCrossCheck.Fields[].OcrTextValue | string | No | |
Verifications.MrzOcrCrossCheck.Fields[].OcrTextValueNormalized | string | No | |
Verifications.MrzOcrCrossCheck.Fields[].MrzTextValue | string | No | |
Verifications.MrzOcrCrossCheck.Fields[].Distance | string | No | |
Verifications.MrzOcrCrossCheck.Fields[].Score | string | No | |
Verifications.MrzOcrCrossCheck.Score | string | No | |
Verifications.MrzOcrCrossCheck.Level | string | No | |
Verifications.OverallOcrFieldsConfidence | object | No | |
Verifications.OverallOcrFieldsConfidence.Score | string | No | |
Verifications.OverallOcrFieldsConfidence.Level | string | No | |
Verifications.PassiveLiveness | object | No | |
Verifications.PassiveLiveness.Score | string | No | |
Verifications.PassiveLiveness.Level | string | No | |
Decision | object | No | |
Decision.Score | string | No | |
Decision.Level | string | No | |
LivenessResult | object | No | |
LivenessResult.Result | string | No | |
LivenessResult.Score | string | No | |
FaceMatchResult | object | No | |
FaceMatchResult.Score | integer (int32) | Yes | |
FaceMatchResult.IsMatch | boolean | Yes |
Code samples#
curl --request GET \
--url 'https://api.screenlyyid.com/api/v1/document/result' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'x-correlation-id: YOUR_CORRELATION_ID'const response = await fetch(
"https://api.screenlyyid.com/api/v1/document/result",
{
"method": "GET",
"headers": {
"x-api-key": "YOUR_API_KEY",
"x-correlation-id": "YOUR_CORRELATION_ID"
}
}
);
const result = await response.json();import requests
response = requests.get(
'https://api.screenlyyid.com/api/v1/document/result',
headers={
"x-api-key": "YOUR_API_KEY",
"x-correlation-id": "YOUR_CORRELATION_ID"
}
)
result = response.json()using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
client.DefaultRequestHeaders.Add("x-correlation-id", "YOUR_CORRELATION_ID");
var response = await client.GetAsync("https://api.screenlyyid.com/api/v1/document/result");
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();