KYC reason codes explain why the "kyc" prerequisite returned by the Get Spending Prerequisites endpoint needs attention. They're returned alongside the actions described in KYC Spending Prerequisites. This guide lists existing codes and their meaning.
Using Reason Codes
Reasons are returned in the reasons array of the KYC prerequisite's params. Each reason has code and description properties.
Reason codes could be used to prompt the cardholder to continue their application or to help them through your support team.
The list of codes is non-exhaustive and may grow over time, so your integration should tolerate codes it doesn't recognize.
Incomplete Steps
Incomplete reasons list the steps a cardholder still has to complete in the Immersve-conducted KYC experience. The first reason is the next step the cardholder needs to complete, and each one is removed as soon as the cardholder completes the step.
| Code | Meaning |
|---|---|
| CONTACT_ | Email or phone number not provided. |
| EXPECTED_ | Expected spend amount not provided. |
| RESIDENTIAL_ | Residential address not provided. |
| PROOF_ | Proof of address not provided. |
| IDV_ | Identity verification not completed. |
Checks in Review
The in-review reason is returned while Immersve-conducted KYC checks are ongoing. There is nothing for the cardholder to do while it is returned.
| Code | Meaning |
|---|---|
| CHECKS_ | KYC checks are ongoing. |
Failed Checks
Failure reasons explain why a KYC check was unsuccessful.
| Code | Meaning |
|---|---|
| ID_ | Identity document could not be matched to an issuer database record. |
| NAME_ | Name could not be matched in the required number of databases. |
| ADDRESS_ | Residential address could not be matched in the required number of databases. |
| DOB_ | Date of birth could not be matched in the required number of databases. |
| DOB_ | Date of birth or address could not be verified in the required number of databases. |
| DETAILS_ | Details could not be verified. |
| VISA_ | Eligible visa could not be found or verified. |
| ID_ | ID document was not accepted. |
| ID_ | ID document has expired. |
| ID_ | ID document does not show the full date of birth. |
| ID_ | A side or page of the ID document is missing. |
| ID_ | ID document could not be verified. |
| DOCUMENT_ | Document details are not readable in the photo. |
| DOCUMENT_ | Photo is not of the original document. |
| DOCUMENT_ | Document photo could not be verified. |
| PROOF_ | Proof of address is too old. |
| PROOF_ | Document was not accepted as proof of address. |
| PROOF_ | Full name or address is missing or unreadable on the proof of address. |
| PROOF_ | Proof of address could not be verified. |
| BIOMETRICS_ | Unsuccessful biometrics check. |
| AGE_ | Cardholder does not meet the age requirement. |
| PROFILE_ | Maximum number of profiles reached. |
| KYC_ | Identity verification was reset. The cardholder can start it again. |
| UNKNOWN | The reason is unknown. Contact Immersve support for more details. |