POST
/
kyc_links
Generate the Links needs to complete KYC for an individual or business
curl --request POST \
  --url https://api.bridge.xyz/v0/kyc_links \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{
  "full_name": "<string>",
  "email": "<string>",
  "type": "individual",
  "endorsements": [
    "base"
  ],
  "redirect_uri": "<string>"
}'
{
  "id": "kyc_link_123",
  "full_name": "John Doe",
  "email": "johndoe@johndoe.com",
  "type": "individual",
  "kyc_link": "www.kyclink.com/blah",
  "tos_link": "www.toslink.com/blah",
  "kyc_status": "not_started",
  "tos_status": "pending",
  "customer_id": "cust_123"
}

Authorizations

​
Api-Key
string
header
required

Headers

​
Idempotency-Key
string
required

Body

application/json

Information about the customer to create KYC Links for

The body is of type object.

Response

200
application/json

KYC Links generated

The response is of type object.