Sign in

v33

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-28103497709.6 KB
KYC/KYB Verifications

Submit customer for verification

Trigger KYC (individual) or KYB (business) verification for a customer. The response indicates whether all required information has been provided. If data is missing, the errors array describes exactly what needs to be supplied before verification can proceed.

Call this endpoint again after resolving errors to re-submit.

post/verifications

Request body

customerIdstring required

The ID of the customer to verify

Example request

{
  "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001"
}

Response

Verification status returned. Check verificationStatus and errors to determine next steps.

idstring required

Unique identifier for this verification

customerIdstring required

The ID of the customer being verified

verificationStatus'RESOLVE_ERRORS' | 'PENDING_MANUAL_REVIEW' | 'IN_PROGRESS' | 'APPROVED' | 'REJECTED' | 'READY_FOR_VERIFICATION' required

Current status of the KYC/KYB verification

createdAtstring date-time required

When this verification was created

updatedAtstring date-time

When this verification was last updated

Example response

{
  "id": "Verification:019542f5-b3e7-1d02-0000-000000000001",
  "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
  "verificationStatus": "RESOLVE_ERRORS",
  "errors": [
    {
      "resourceId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "type": "MISSING_FIELD",
      "field": "customer.address.line1",
      "acceptedDocumentTypes": [
        "PASSPORT"
      ],
      "reason": "Business address line 1 is required"
    }
  ],
  "createdAt": "2025-10-03T12:00:00Z",
  "updatedAt": "2025-10-03T12:00:00Z"
}