GuidesRecipesAPI ReferenceChangelog
API Reference

Create Identity Verification

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

StateDescription
storingThe Platform is storing the identity verification details in our private store
waitingThe Platform is waiting for the customer to start the identity verification process
pendingThe Platform is waiting for the customer to finish the identity verification process
reviewingThe Platform is waiting for compliance to review the identity verification results
expiredThe identity verification process has expired
completedThe identity verification process has been completed

Outcome

StateDescription
passedThe customer has passed the identity verification process
failedThe customer has failed the identity verification process

Failure Codes

CodeDescription
id_check_failureFailure due to an issue verifying the provided ID
id_quality_check_failureFailure due to an issue verifying the provided ID based on the image quality
id_barcode_check_failureFailure due to an issue verifying the provided ID based on the barcode
id_mrz_check_failureFailure due to an issue verifying the provided ID based on the machine-readable zone (MRZ)
id_presence_check_failureFailure due to an issue verifying the provided ID based on the presence of the ID
id_expiration_check_failureFailure due to an issue verifying the provided ID based on the expiration date
id_double_side_check_failureFailure due to an issue verifying the provided ID based on both sides not being provided
id_type_allowed_check_failureFailure due to an issue verifying the provided ID based on the type provided
id_country_allowed_check_failureFailure due to an issue verifying the provided ID based on the issuing country
id_digital_replica_check_failureFailure due to an issue verifying the provided ID based on it being a digital replica
id_paper_replica_check_failureFailure due to an issue verifying the provided ID based on it being a paper replica
database_check_failureFailure due to an issue verifying the provided information against authoritative data sources
selfie_failureFailure due to an issue verifying the provided selfie photo
selfie_pose_check_failureFailure due to an issue verifying the provided selfie photo based on incorrect poses
selfie_quality_check_failureFailure due to an issue verifying the provided selfie photo based on the image quality
country_comparison_check_failureFailure due the customer verification being performed out of country
duplicate_person_check_failureFailure due to a customer already existing for this person
prohibited_person_check_failureFailure due to a person being on prohibited from accessing the service
name_check_failureFailure due to an issue verifying the name of the person
address_check_failureFailure due to an issue verifying the address of the person
account_number_check_failureFailure due to an issue verifying the account number of the person
dob_check_failureFailure due to an issue verifying the date of birth of the person
id_number_check_failureFailure due to an issue verifying an identification number of the person
phone_number_check_failureFailure due to an issue verifying the phone number of the person
email_address_check_failureFailure due to an issue verifying the email address of the person
document_type_check_failureFailure due to the type of document provided not being the correct type
document_quality_check_failureFailure due to an issue verifying the document based on the image quality
document_check_failureFailure due to an issue verifying the documents
name_comparison_check_failureFailure due to a mismatch between the name on the customer account and the name on the provided documents
compliance_rejectionFailure due to compliance rejecting the identity verification
review_requiredThe verification is inconclusive and requires a manual review
user_canceledFailure due to the user canceling the identity verification
plaid_failureFailure due to an issue interacting with Plaid
plaid_item_login_requiredFailure due to the Plaid token for the account requiring re-login
plaid_invalid_productFailure due to the Plaid product not being supported (contact support)
plaid_no_accountsFailure due to the Plaid token having access to no accounts
plaid_item_not_foundFailure due to Plaid not being able to find the associated account
decision_timeoutFailure due to an issue verifying the email address of the person
requested_failureIn sandbox, the caller requested that the process failed
deleted_accountFailure due to the bank account having been deleted before a decision was made
pep_check_failureFailure due to the person being on a Politically Exposed Persons (PEP) list
media_check_failureFailure due to the person being on Adverse Media list
watchlist_check_failureFailure due to the person being on a known government or international watchlist or sanctions list

Required scope: identity_verifications:execute

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The type of identity verification.

Allowed:
string | null

The customer's identifier. Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database.

expected_behaviours
array of strings | null

The optional expected behaviour to simulate.

expected_behaviours
string | null
enum

The identity verification method. Required when type is counterparty, type is kyc, or type is bank_account.

string | null

The counterparty's identifier. Required when type is counterparty.

string | null

The ISO 3166 country 2-Alpha country the customer is being verified in. If not present, will default to the Bank's configured country code. Optional when type is kyc and method is id_and_selfie, type is kyc and method is tax_id_and_selfie, or type is kyc and method is business_registration.

boolean | null
Defaults to false

Whether the collection of the tax id is required during identity verification. This will default to SSN in USA and SIN in Canada. It's not used elsewhere. Optional when type is kyc and method is id_and_selfie.

name
object | null

The customer's name. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, or type is bank_account and method is attested_ownership. Optional when type is kyc and method is watchlists.

address
object | null

The customer's address. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is kyc and method is watchlists or type is bank_account and method is attested_ownership.

date | null

The customer's date of birth. Required when type is kyc and method is attested, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database.

identification_numbers
array of objects | null

The customer's identification numbers. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database.

identification_numbers
string
enum
required

The source of the identification number.

string
required

The ISO 3166 country 2-Alpha country code of the identification number issuer.

string
required

The identification number.

aliases
array of objects | null

The aliases of the customer. Optional when type is kyc and method is attested_business_registration or type is kyc and method is watchlists.

aliases
string | null

The customer's phone number. Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is bank_account and method is attested_ownership.

string | null

The customer's email address. Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is bank_account and method is attested_ownership.

string | null

The customer's website. Required when type is kyc and method is attested_business_registration.

string | null

The customer's nature of business. Required when type is kyc and method is attested_business_registration.

director_customer_guids
array of strings | null

The customer guids of the directors of the business Required when type is kyc and method is attested_business_registration.

director_customer_guids
ultimate_beneficial_owners
array of objects | null

The ultimate beneficial owners of the business with 10% or more ownership Required when type is kyc and method is attested_business_registration.

ultimate_beneficial_owners
string
required
length between 32 and 32

The customer identifier.

number
required

The ownership percentage.

supporting_file_guids
array of strings | null

File guids supporting the verification Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database.

supporting_file_guids
registered_address
object | null

The customer's registered address. Required for attested business registration V3. Optional when type is kyc and method is attested_business_registration.

string | null

The industry the business operates in. Required for attested business registration V3. e.g. 'Crypto / Digital Assets / Blockchain', 'Education', 'Gaming', 'Healthcare / Hospitality', 'Lending / Investments', 'Retail / E-Commerce', etc. Optional when type is kyc and method is attested_business_registration.

string | null

The source of business funds. Required for attested business registration V3. e.g. 'Funds from individual customers', 'Funds from business customers', 'Funds from both individual and business customers', etc. Optional when type is kyc and method is attested_business_registration.

string | null

The destination of business funds. Required for attested business registration V3. e.g. 'To your business account (bank or wallet)', 'To vendors or suppliers', 'To employees or contractors', 'To sellers or merchants', 'Bulk payments or payouts', etc. Optional when type is kyc and method is attested_business_registration.

string | null

The customer's occupation. Required when type is kyc and method is attested_business_associate. Optional when type is kyc and method is attested_id_and_selfie.

boolean | null

Whether biometrics have been verified Required when type is kyc and method is attested_business_associate or type is kyc and method is attested_id_and_database.

string | null

The external bank account's identifier. Required when type is bank_account.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json