Simulate KYC approval (sandbox only)

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

Simulate KYC approval (sandbox only)

cURL

curl --request POST \
  --url https://api.bridge.xyz/v0/customers/{customerID}/simulate_kyc_approval \
  --header 'Api-Key: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>'

200

SimulateKycApprovalResponse

{
  "success": true,
  "customer_id": "00000000-0000-0000-0000-000000000000",
  "kyc_status": "approved",
  "message": "Simulated KYC approval processed. Customer endorsements will be evaluated."
}

Authorizations

Api-Key · string · header · required

Headers

Idempotency-Key · string · required

Path Parameters

customerID · string · required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Pattern: [a-z0-9]*

Response

200

application/json

KYC approval simulated successfully

Response from the simulate KYC approval endpoint

success · boolean · required

Whether the simulation succeeded

customer_id · string · required

The ID of the customer whose KYC was simulated

kyc_status · enum<string> · required

Status of the KYC flow.

Available options: not_started, incomplete, awaiting_questionnaire, awaiting_ubo, under_review, approved, rejected, paused, offboarded

message · string · required

Human-readable description of what was processed