Skip to main content
POST
/
customers
/
{customerID}
/
simulate_kyc_approval
Simulate KYC approval (sandbox only)
curl --request POST \
  --url https://api.bridge.xyz/v0/customers/{customerID}/simulate_kyc_approval \
  --header 'Api-Key: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>'
{
  "success": true,
  "customer_id": "00000000-0000-0000-0000-000000000000",
  "kyc_status": "approved",
  "message": "Simulated KYC approval processed. Customer endorsements will be evaluated."
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.bridge.xyz/llms.txt

Use this file to discover all available pages before exploring further.

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

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