Classic KYC Failure Triggers
Testing in Sandbox
Sandbox and Classic KYC Only
You can use these values to trigger a KYC failure status with different error messages in the Sandbox environment only.
If you are using Advanced KYC, please use the failure triggers detailed here.
Error Messages
A list of possible error messages.
Birthdate
"Registered user must be 18."
"Received birthdate: INPUT_DATE"
"Derived age: AGE"
"Current server date: CURRENT_DATE""Not a valid birthdate, maximum allowed AGE_LIMIT."
"Received birthdate: INPUT_DATE"
"Derived age: AGE"
"Current server date: CURRENT_DATE"Epoch
"Integer not valid epoch."
"Epoch cannot be set in the future. (Parsed epoch as: DATE)""Provided epoch in message has expired; please generate a new message and signature to retry this request. (Parsed epoch as: DATE)"
US Postal Code
"invalid_postal_code"Handle
"This value does not match the required handle pattern: PATTERN"Phone Number
"This value does not match the required phone number pattern: PATTERN"Identity
"Input did not match SSN regex pattern."
"Input did not match EIN regex pattern PATTERN"
Testing Mock Failure Triggers & Tags
| Registration Field | Error Trigger | Outcome Tags & Reasons in Response |
|---|---|---|
| first_name, OR last_name, OR full_name | Fail (case-insensitive) | Name Mismatch, Name Not Verified |
| first_name, OR last_name, OR full_name | documents_required | Status:documents_required |
| first_name, OR last_name, OR full_name | Fraud | failed, fraud warning, and denied fraud |
| first_name, OR last_name, OR full_name | Review | Status: Review |
| street_address_1 | 420 420th Street | Address Not Matched, Address Not Verified |
| birthdate | 1970-04-20 | DOB Miskey, DOB Not Verified |
| identity_alias & identity_value | "identity_alias": "SSN","identity_value": "420420420" | SSN Miskey, SSN Not Verified |
| entity: type & entity_name | "entity": { "type": "business", "entity_name": "420 Inc", | Company Name Not Matched |
| identity_alias & identity_value | "identity_alias": "EIN", "identity_value": "420420420" | FEIN Unmatched, FEIN Document Required |
| device.session_identifier | fail | fraud review, denied KYCdocuments_required |
Passing After Triggering a Failure
After triggering a KYC failure with one of the above triggers and reaching a documents_required status, you have two options if you want to mock the doc upload flow.
Mock a passing KYC status after an initial failure and document upload
When making the /documents call, include the value mock doc passed in the name field of the /documents request. This triggers a passed status.
Mock a documents_received status after an initial failure and document upload
documents_received status after an initial failure and document uploadSo long as you do not pass mock doc passed into the name field of the /documents call, you will reach this status after uploading a doc.
Updated 3 months ago