Verification & Compliance

APIs for identity verification, document management, and consent collection

Verification & Compliance

Shared API surface for managing verification processes, uploading compliance documents, approving submissions, and collecting customer consents. These endpoints are used by both Individual (B2C) and Organization (B2B) onboarding flows.


API Endpoints

Core Verification

Three endpoints handle the full verification lifecycle — from initiation through document upload to admin approval:

EndpointMethodDescription
/verificationsPOSTInitiate a new verification (KYC for individuals, KYB for organizations)
/verifications/{verificationId}/documentsPOSTUpload supporting documents for a verification
/verifications/{verificationId}/approvePOSTAdmin approval after document review

Consent endpoints are scoped per customer type. Three consent types must be accepted before activation: terms, privacy, and data-processing.

EndpointMethodDescription
/customer/individual/{customerId}/consents/{consentType}POSTAccept a consent for an individual customer
/customer/organization/{organizationId}/consents/{consentType}POSTAccept a consent for an organization customer

Verification Flow

flowchart LR
    A[Initiate Verification] --> B[Upload Documents]
    B --> C[Pending Review]
    C --> D{Admin Decision}
    D -->|Approve| E[Approved]
    D -->|Reject| F[Rejected]
    E --> G[Collect Consents]
    G --> H[Ready for Activation]

Individual (B2C) verification flow

flowchart TB
    V1["(1) POST /verifications (IDENTITY_VERIFICATION)"] --> V2["(2) Upload identity document"]
    V2 --> V3["(3) Upload proof-of-address document"]
    V3 --> V4["(4) Approve verification"]
    V4 --> V5["(5) Accept terms consent"]
    V5 --> V6["(6) Accept privacy consent"]
    V6 --> V7["(7) Accept data-processing consent"]

Organization (B2B) verification flow

flowchart TB
    B1["(1) POST /verifications (BUSINESS_VERIFICATION)"] --> B2["(2) Upload certificate of incorporation"]
    B2 --> B3["(3) Upload proof of registered address"]
    B3 --> B4["(4) Approve verification"]
    B4 --> B5["(5) Accept terms consent"]
    B5 --> B6["(6) Accept privacy consent"]
    B6 --> B7["(7) Accept data-processing consent"]

Individual KYC Flow

Step-by-step identity verification for individual (B2C) customers:

StepEndpointPayload Highlights
1. InitiatePOST /verificationstype: "IDENTITY_VERIFICATION", customerId
2. Upload IDPOST /verifications/{id}/documentsdocumentType: "PASSPORT" or "NATIONAL_ID"
3. Upload AddressPOST /verifications/{id}/documentsdocumentType: "PROOF_OF_ADDRESS"
4. ApprovePOST /verifications/{id}/approveAdmin reviews and approves
5. TermsPOST /customer/individual/{id}/consents/termsaccepted: true
6. PrivacyPOST /customer/individual/{id}/consents/privacyaccepted: true
7. Data ProcessingPOST /customer/individual/{id}/consents/data-processingaccepted: true

Organization KYB Flow

Step-by-step business verification for organization (B2B) customers:

StepEndpointPayload Highlights
1. InitiatePOST /verificationstype: "BUSINESS_VERIFICATION", customerId
2. Upload CertPOST /verifications/{id}/documentsdocumentType: "CERTIFICATE_OF_INCORPORATION"
3. Upload AddressPOST /verifications/{id}/documentsdocumentType: "PROOF_OF_REGISTERED_ADDRESS"
4. ApprovePOST /verifications/{id}/approveAdmin reviews and approves
5. TermsPOST /customer/organization/{id}/consents/termsaccepted: true
6. PrivacyPOST /customer/organization/{id}/consents/privacyaccepted: true
7. Data ProcessingPOST /customer/organization/{id}/consents/data-processingaccepted: true

Verification Types

TypeUse CaseCustomer Type
IDENTITY_VERIFICATIONKYC — passport or national ID verificationIndividual (B2C)
DOCUMENT_VERIFICATIONProof of address or supplementary documentsIndividual (B2C)
BUSINESS_VERIFICATIONKYB — corporate entity and UBO verificationOrganization (B2B)

Type to search…

↑↓ navigate open esc close