Manually overriding ID document results | API

If you are handling the remediation of ID documents via your own platform you can use the following endpoints to update the various elements of an ID Document.

Liveness

To update the liveness check result (e.g. if the UAP image has been manually reviewed by your user) the following endpoints can be used.  In each case, a "reason" string parameter should be sent in the request body - e.g. "We have reviewed the image and confirmed it is correct".

PUT /api/v2/ci/entities/{entityId}/idv-entries/{entryId}/verify-liveness

PUT /api/v2/ci/entities/{entityId}/idv-entries/{entryId}/reject-liveness

PUT /api/v2/ci/entities/{entityId}/idv-entries/{entryId}/refer-liveness

ID Documents

To update result of an ID Document (e.g. if the document image has been manually reviewed by your user) the following endpoints can be used.  In each case, a "reason" string parameter should be sent in the request body - e.g. "We have reviewed the image and confirmed it is correct".

PUT /api/v2/ci/entities/{entityId}/idv-entries/{entryId}/id-document/{idDocumentId}/verify

PUT /api/v2/ci/entities/{entityId}/idv-entries/{entryId}/id-document/{idDocumentId}/reject

PUT /api/v2/ci/entities/{entityId}/idv-entries/{entryId}/id-document/{idDocumentId}/refer

Supporting (non-Biometric Documents)

To update result of a Supporting Document (e.g. if the document image has been manually reviewed by your user) the following endpoint can be used.

PUT /api/v2/ci/entities/{entityId}/idv-entries/{entryId}/non-biometic-documents/review

The request body should be structured as follows:

[

  {

    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

    "result": 0,

    "comments": "string"

  }

]

"ID" - The ID of the Supporting Document.

"Comments" - A supporting comment (e.g. 'We have reviewed the document and are happy to pass it")

"Result" should be one of the following values:

0 = NotPerformed

1 = AutoPass

2 = AutoFail

3 = PendingManualCheck

4 = ManualPass

5 = ManualFail

6 = ManualRefer

7 = Requested