Skip to main content

Gets an ID Proofing request

GET 
/api/web/v1/idproofing/:requestId

Gets an ID Proofing request. Caller requires the IDPROOFING:VIEW permission.

Request​

Path Parameters

    requestId stringrequired

    The UUID of the ID Proofing request.

Responses​

Successful

Schema

    backImageClassified boolean

    Returns true if the document back image was successfully classified into a known document.

    backImageUploadTime date-time

    The time when the document ID back image was uploaded.

    deviceCheckResult stringrequired

    Possible values: [ALLOW, DENY, NONE, REVIEW]

    The device risk assessment result. A result of DENY will not allow to continue with an ID Proofing request.

    documentAuthenticationResult string

    Possible values: [NONE, UNKNOWN, PASSED, FAILED, SKIPPED, ATTENTION]

    The ID document authentication result.

    faceMatch boolean

    Returns true if the document photo and the selfie matched.

    faceMatchScore int32

    Face match score normalized to the range 0-100, where 80 or higher is considered a match. Clients should rely on the faceMatch attribute rather than the raw score.

    frontImageClassified boolean

    Returns true if the document front image was successfully classified into a known document.

    frontImageUploadTime date-time

    The time when the document ID front image was uploaded.

    requestId stringrequired

    ID Proofing request identifier.

    requestTime date-timerequired

    The time when the request was initiated.

    state stringrequired

    Possible values: [COMPLETE, IMAGE, INIT]

    The state of the request.

Loading...