ScreenlyyIDDocs
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.

GEThttps://api.screenlyyid.com/api/v1/document/result

Headers#

NameTypeRequiredDescription
x-api-keystringYesYour ScreenlyyID API key
x-correlation-idstring (uuid)YesCorrelation ID for this customer check

Responses#

StatusDescription
200Successful response

Response body (200)#

FieldTypeRequiredDescription
VerificationsobjectNo
Verifications.DateOfExpirationobjectNo
Verifications.DateOfExpiration.ScorestringNo
Verifications.DateOfExpiration.LevelstringNo
Verifications.DocumentLivenessobjectNo
Verifications.DocumentLiveness.ScorestringNo
Verifications.DocumentLiveness.LevelstringNo
Verifications.FaceVerificationobjectNo
Verifications.FaceVerification.ScorestringNo
Verifications.FaceVerification.LevelstringNo
Verifications.MrzOcrCrossCheckobjectNo
Verifications.MrzOcrCrossCheck.Fieldsarray of objectNo
Verifications.MrzOcrCrossCheck.Fields[].InputFieldNamestringNo
Verifications.MrzOcrCrossCheck.Fields[].OcrTextValuestringNo
Verifications.MrzOcrCrossCheck.Fields[].OcrTextValueNormalizedstringNo
Verifications.MrzOcrCrossCheck.Fields[].MrzTextValuestringNo
Verifications.MrzOcrCrossCheck.Fields[].DistancestringNo
Verifications.MrzOcrCrossCheck.Fields[].ScorestringNo
Verifications.MrzOcrCrossCheck.ScorestringNo
Verifications.MrzOcrCrossCheck.LevelstringNo
Verifications.OverallOcrFieldsConfidenceobjectNo
Verifications.OverallOcrFieldsConfidence.ScorestringNo
Verifications.OverallOcrFieldsConfidence.LevelstringNo
Verifications.PassiveLivenessobjectNo
Verifications.PassiveLiveness.ScorestringNo
Verifications.PassiveLiveness.LevelstringNo
DecisionobjectNo
Decision.ScorestringNo
Decision.LevelstringNo
LivenessResultobjectNo
LivenessResult.ResultstringNo
LivenessResult.ScorestringNo
FaceMatchResultobjectNo
FaceMatchResult.Scoreinteger (int32)Yes
FaceMatchResult.IsMatchbooleanYes

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'