Skip to main content
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

​
email
string
required

Email of the customer

Minimum length: 1
​
type
enum<string>
required

Type of the customer (individual vs. business)

Available options:
individual,
business
​
full_name
string

Full name of the customer, for a business, this would be the business entity's legal name

Minimum length: 1
​
endorsements
enum<string>[]

List of endorsements to request for the generated KYC link. For example, sepa endorsement could be requested to allow an individual customer to submit proof-of-address documents in the KYC flow.

​
redirect_uri
string

The location where the customer should be redirected after completing the KYC flow. Must be in the form of http:// or https://.

Response

KYC Links generated

​
id
string

ID of the KYC link

​
type
enum<string>

Type of the KYC link

Available options:
individual,
business
​
customer_id
string

ID of the customer.

​
full_name
string

Full name of the customer, for a business, this would be the business entity's legal name

​
email
string

Email of the customer

​
kyc_link
string

Link to the KYC flow

​
kyc_status
enum<string>

Status of the KYC flow.

Available options:
not_started,
incomplete,
awaiting_questionnaire,
awaiting_ubo,
under_review,
approved,
rejected,
paused,
offboarded
​
rejection_reasons
object[]

Reasons why a customer KYC was rejected

​
tos_link
string

Link to the TOS flow

​
tos_status
enum<string>

Status of the TOS flow

Available options:
pending,
approved
​
created_at
string<date-time>

Time of creation of the KYC link