Customer verification tracks identity checks and compliance validations performed through external verification providers. Each verification has a status lifecycle: pending → verified / failed / expired.
Use verifications for KYC/KYB compliance, age verification, or business entity validation.
List customer verifications
Returns a paginated list of verifications for the org. Pass ?customer_id=
query Parameters
customer_idFilter by customer UUID
statusFilter by verification status
verification_typeFilter by verification type
occurred_afterFilter by created_at >= (RFC3339)
occurred_beforeFilter by created_at < (RFC3339)
limitPage size limit
cursorPagination cursor
List customer verifications › Responses
Paginated list of verifications with cursor
Create a customer verification
Initiates a new verification for a customer by calling the verification provider and storing the result. customer_id is supplied in the request body.
Create a customer verification › Request Body
check_typecustomer_idproviderverification_typeCreate a customer verification › Responses
Created verification wrapped in data envelope
actor_idcheck_typecreated_atcustomer_idexpires_atidlast_checked_atorganization_idproviderprovider_referencereasonresult_payloadstatusupdated_atverification_typeverified_atGet a customer verification
Returns a single verification by ID
path Parameters
idVerification UUID
Get a customer verification › Responses
Verification wrapped in data envelope
actor_idcheck_typecreated_atcustomer_idexpires_atidlast_checked_atorganization_idproviderprovider_referencereasonresult_payloadstatusupdated_atverification_typeverified_atUpdate verification status
Admin override to transition a verification's status (e.g., approve, reject, expire)
path Parameters
idVerification UUID
Update verification status › Request Body
statusUpdate verification status › Responses
Updated verification wrapped in data envelope
actor_idcheck_typecreated_atcustomer_idexpires_atidlast_checked_atorganization_idproviderprovider_referencereasonresult_payloadstatusupdated_atverification_typeverified_at