Identity Verification codes
Beta
Last updated: November 28, 2024
Checkout.com's Identity Verification products can have the following:
- Identity Verification statuses
- Identity Verification attempt statuses
- Identity Verification response codes – Also applicable to Face Authentication
- AML Verification statuses
- Face Authentication statuses
Information
When we add new response codes, we always ensure backward compatibility. However, we recommend basing your business rules on the status
value and using response_codes
as additional information.
Identity verifications can have the following statuses in API responses and webhook notifications:
Status | Description | Recommended action | Response codes |
---|---|---|---|
| You successfully created the identity verification. | None | |
| You successfully created an attempt and the identity verification session is available. | Redirect the user to the web flow using the | None |
| The user is performing the capture. | Wait for the next status. | None |
| Checkout.com is checking the identity verification data. | Wait for the next status. | None |
| The user's identity was successfully verified | Accept the user's request. |
|
| The user's identity was not successfully verified due to an irregularity. | Refuse the user's request. | Document issue |
| Checkout.com could not complete all of the required checks and the user needs to retry the flow. | User engagement | |
| Checkout.com could not complete the checks and you can no longer retry. | No action is available. |
|
| The user refused to perform the identity verification. | Suggest an alternative way of verifying their identity. |
|
Each attempt for an identity verification can have the following statuses in API responses and webhook notifications:
Status | Description |
---|---|
| The |
| The |
| The user is performing the capture. |
| Checkout.com is checking the identity verification data. |
| The user successfully completed the flow in this attempt. |
| Checkout.com could not complete the checks and you can no longer retry. |
| The user exited the web flow without completing the capture. |
| The user explicitly refused to perform the capture. |
| You created a new attempt and this attempt is terminated. |
Response code | Summary | Description | Status |
---|---|---|---|
|
| Checkout.com approved the identity verification or face authentication. |
|
User engagement issue | |||
|
| The user was not redirected to or did not start the web flow. |
|
|
| The user clicked a button to state they wanted to perform the flow later. | |
|
| The user clicked a button to state they did not have their ID document with them. | |
|
| The user did not give access to their device camera when instructed. | |
|
| The user left the flow before the capture stage and the verification URL expired after 15 minutes. | |
Technical issue | |||
|
| The user's connection was too poor to perform the capture. |
|
|
| The user's browser was not suitable for video streaming. | |
|
| The user's device did not have a camera. | |
|
| The user switched tabs or applications during the flow. | |
|
| The user did not receive the SMS. | |
Document capture issue | |||
|
| The user's document video was too blurry. |
|
|
| The user performed the document capture in poor light. | |
|
| The user did not capture the front of the document. | |
|
| The user did not capture the back of the document. | |
|
| Part of the document was hidden in the capture. | |
|
| The user did not move the document dynamically. | |
|
| The document's barcode was not readable. | |
Face capture issue | |||
|
| The face video was too blurry. |
|
|
| The user captured the face video in poor light. | |
|
| The user did not present their face to the camera. | |
|
| The user did not present a full front view of their face. | |
|
| The user did not move enough to prove liveness. | |
|
| The user also captured another person's face. | |
Internal error | |||
|
| Checkout.com could not complete the identity verification due to an internal error. |
|
|
| The videos received could not be played. | |
Document issue | |||
|
| The user presented an expired document. |
|
|
| The user presented a document that we do not accept. | |
|
| The user presented a damaged document. | |
Copy issue | |||
|
| The user presented a photocopy of the document. |
|
|
| The user presented a screenshot of the document. | |
Identity fraud | |||
|
| The user presented a counterfeit or falsified document. |
|
|
| The user presented a document that has been declared lost or stolen. | |
|
| The user presented the front and back of two different documents. | |
|
| The user's face in the face video did not match the document photograph. | |
|
| The user presented a physical or digital photo or video of another person's face. | |
|
| The user altered their appearance. | |
|
| The user digitally altered the videos. | |
|
| The face authentication face video does not match any previous identity verification or face authentication for this user. | |
Suspicious behavior | |||
|
| The user's identity did not match the details they provided. |
|
|
| The user used a device that has been technically altered. | |
|
| The user seems to have performed the capture under coercion. | |
User refusal | |||
|
| The user clicked a button to refuse to perform the flow. |
|
Programmatic actions | |||
|
| The user forcibly closed the flow and the verification URL is no longer valid. |
|
AML verifications can have the following statuses in API responses and webhook notifications:
Status | Description | Recommended action |
---|---|---|
| You successfully created the AML verification. | Wait for the next status. |
| Checkout.com is generating the risk score or performing database checks. | Wait for the next status. |
| The risk score is | Accept the user’s request. |
| The risk score is | |
| The risk score returned | Refuse the user’s request. |
Face authentications can have the following statuses and response codes:
Status | Description | Recommended action |
---|---|---|
| You successfully created a face authentication. | |
| You successfully created an attempt. | Redirect the user to the |
| The user is capturing their face video. | Wait for the next status. |
| Checkout.com is checking the face video. | Wait for the next status. |
| The user is successfully authenticated. | Accept the user's request to access services. |
| The user was not authenticated. | Refuse the user's request to access services, or create a new face authentication. |
| Checkout.com could not perform all the required checks. | |
| Checkout.com could not perform all the required checks and you can no longer retry. | No further action is available. |
| The user refused to start the web flow. | Suggest another way for the user to confirm their identity. |