BRbridge
Sandbox

Simulate KYC approval (sandbox only)

Changed on

Simulates a KYC/KYB approval for a customer in the sandbox environment. This endpoint is not available in production.

Mimics what happens when a customer completes identity verification through the KYC provider in production:

  • Sets the customer's KYC status to approved
  • Populates required entity data (name, address, date of birth) using any data already on the customer, falling back to sandbox defaults
  • Approves any pending endorsements, enabling the customer to initiate transfers

Useful for testing the full customer lifecycle without integrating with a real KYC provider.

post/customers/{customerID}/simulate_kyc_approval

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/customers/{customerID}/simulate_kyc_approval
  • Auth
    API key in header Api-Key

Headers

Idempotency-Keystring required

Response

KYC approval simulated successfully

successboolean required

Whether the simulation succeeded

customer_idstring required

The ID of the customer whose KYC was simulated

kyc_status'not_started' | 'incomplete' | 'awaiting_questionnaire' | 'awaiting_ubo' | 'under_review' | 'approved' | 'rejected' | 'paused' | 'offboarded' | 'deposits_restricted' required

Status of the KYC flow.

messagestring required

Human-readable description of what was processed

Changes

  • a390532e9fc6Revision changes
    • warning

      added the new deposits_restricted enum value to the response property for the response status