post https://bank.sandbox.cybrid.app/api/identity_verifications
Creates an Identity Verification.
Identity Verifications
Identity Verifications confirm an individual's identity with for the purpose of inclusion on the platform. This know-your-customer (KYC) process is a requirement for individuals to be able to transact. At present, we offer support for Cybrid performing the verification or working with partners to accept their KYC/AML process and have it attested to in our platform.
State
| State | Description |
|---|---|
| storing | The Platform is storing the identity verification details in our private store |
| waiting | The Platform is waiting for the customer to start the identity verification process |
| pending | The Platform is waiting for the customer to finish the identity verification process |
| reviewing | The Platform is waiting for compliance to review the identity verification results |
| expired | The identity verification process has expired |
| completed | The identity verification process has been completed |
Outcome
| State | Description |
|---|---|
| passed | The customer has passed the identity verification process |
| failed | The customer has failed the identity verification process |
Failure Codes
| Code | Description |
|---|---|
| id_check_failure | Failure due to an issue verifying the provided ID |
| id_quality_check_failure | Failure due to an issue verifying the provided ID based on the image quality |
| id_barcode_check_failure | Failure due to an issue verifying the provided ID based on the barcode |
| id_mrz_check_failure | Failure due to an issue verifying the provided ID based on the machine-readable zone (MRZ) |
| id_presence_check_failure | Failure due to an issue verifying the provided ID based on the presence of the ID |
| id_expiration_check_failure | Failure due to an issue verifying the provided ID based on the expiration date |
| id_double_side_check_failure | Failure due to an issue verifying the provided ID based on both sides not being provided |
| id_type_allowed_check_failure | Failure due to an issue verifying the provided ID based on the type provided |
| id_country_allowed_check_failure | Failure due to an issue verifying the provided ID based on the issuing country |
| id_digital_replica_check_failure | Failure due to an issue verifying the provided ID based on it being a digital replica |
| id_paper_replica_check_failure | Failure due to an issue verifying the provided ID based on it being a paper replica |
| database_check_failure | Failure due to an issue verifying the provided information against authoritative data sources |
| selfie_failure | Failure due to an issue verifying the provided selfie photo |
| selfie_pose_check_failure | Failure due to an issue verifying the provided selfie photo based on incorrect poses |
| selfie_quality_check_failure | Failure due to an issue verifying the provided selfie photo based on the image quality |
| country_comparison_check_failure | Failure due the customer verification being performed out of country |
| duplicate_person_check_failure | Failure due to a customer already existing for this person |
| prohibited_person_check_failure | Failure due to a person being on prohibited from accessing the service |
| name_check_failure | Failure due to an issue verifying the name of the person |
| address_check_failure | Failure due to an issue verifying the address of the person |
| account_number_check_failure | Failure due to an issue verifying the account number of the person |
| dob_check_failure | Failure due to an issue verifying the date of birth of the person |
| id_number_check_failure | Failure due to an issue verifying an identification number of the person |
| phone_number_check_failure | Failure due to an issue verifying the phone number of the person |
| email_address_check_failure | Failure due to an issue verifying the email address of the person |
| document_type_check_failure | Failure due to the type of document provided not being the correct type |
| document_quality_check_failure | Failure due to an issue verifying the document based on the image quality |
| compliance_rejection | Failure due to compliance rejecting the identity verification |
| plaid_failure | Failure due to an issue interacting with Plaid |
| plaid_item_login_required | Failure due to the Plaid token for the account requiring re-login |
| plaid_invalid_product | Failure due to the Plaid product not being supported (contact support) |
| plaid_no_accounts | Failure due to the Plaid token having access to no accounts |
| plaid_item_not_found | Failure due to Plaid not being able to find the associated account |
| decision_timeout | Failure due to an issue verifying the email address of the person |
| requested_failure | In sandbox, the caller requested that the process failed |
| deleted_account | Failure due to the bank account having been deleted before a decision was made |
Required scope: identity_verifications:execute