Retrieves the verification score and trust factor scores. The response has two properties: verifications and decision. See Understanding results .
GET https://api.screenlyyid.com/api/v1/data/{sessionId}/decision/resultCopy URL
Name Type Required Description x-api-keystring Yes Your ScreenlyyID API key x-correlation-idstring (uuid) Yes Correlation ID for this customer check
Path parameters#
Name Type Required Description sessionIdstring Yes
Responses#
Status Description 200Successful response
Response body (200)#
Field Type Required Description Verificationsobject No Verifications.DateOfExpirationobject No Verifications.DateOfExpiration.Scorestring No Verifications.DateOfExpiration.Levelstring No Verifications.DocumentLivenessobject No Verifications.DocumentLiveness.Scorestring No Verifications.DocumentLiveness.Levelstring No Verifications.FaceVerificationobject No Verifications.FaceVerification.Scorestring No Verifications.FaceVerification.Levelstring No Verifications.MrzOcrCrossCheckobject No Verifications.MrzOcrCrossCheck.Fieldsarray of object No Verifications.MrzOcrCrossCheck.Fields[].InputFieldNamestring No Verifications.MrzOcrCrossCheck.Fields[].OcrTextValuestring No Verifications.MrzOcrCrossCheck.Fields[].OcrTextValueNormalizedstring No Verifications.MrzOcrCrossCheck.Fields[].MrzTextValuestring No Verifications.MrzOcrCrossCheck.Fields[].Distancestring No Verifications.MrzOcrCrossCheck.Fields[].Scorestring No Verifications.MrzOcrCrossCheck.Scorestring No Verifications.MrzOcrCrossCheck.Levelstring No Verifications.OverallOcrFieldsConfidenceobject No Verifications.OverallOcrFieldsConfidence.Scorestring No Verifications.OverallOcrFieldsConfidence.Levelstring No Verifications.PassiveLivenessobject No Verifications.PassiveLiveness.Scorestring No Verifications.PassiveLiveness.Levelstring No Decisionobject No Decision.Scorestring No Decision.Levelstring No LivenessResultobject No LivenessResult.Resultstring No LivenessResult.Scorestring No FaceMatchResultobject No FaceMatchResult.Scoreinteger (int32) Yes FaceMatchResult.IsMatchboolean Yes
Code samples#
cURL JavaScript Python C# Copy
curl --request GET \
--url 'https://api.screenlyyid.com/api/v1/data/YOUR_SESSION_ID/decision/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/data/YOUR_SESSION_ID/decision/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/data/YOUR_SESSION_ID/decision/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/data/YOUR_SESSION_ID/decision/result");
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();