GET
/
kyc_links
Get all KYC links.
curl --request GET \
  --url https://api.bridge.xyz/v0/kyc_links \
  --header 'Api-Key: <api-key>'
{
  "count": 2,
  "data": [
    {
      "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": "approved",
      "rejection_reasons": [],
      "tos_status": "approved",
      "customer_id": "cust_123"
    },
    {
      "id": "kyc_link_456",
      "full_name": "Jane Doe",
      "email": "janedoe@janedoe.com",
      "type": "individual",
      "kyc_link": "www.kyclink.com/blah",
      "tos_link": "www.toslink.com/blah",
      "kyc_status": "rejected",
      "rejection_reasons": [
        {
          "developer_reason": "Missing required ID details.",
          "reason": "Cannot validate ID -- upload a clear photo of the full ID",
          "created_at": "2020-01-02T00:00:00.000Z"
        },
        {
          "developer_reason": "Blurry face portrait.",
          "reason": "Cannot validate ID -- upload a clear photo of the full ID",
          "created_at": "2020-01-02T00:00:00.000Z"
        }
      ],
      "tos_status": "approved",
      "customer_id": "cust_456"
    }
  ]
}

Authorizations

​
Api-Key
string
header
required

Query Parameters

​
customer_id
string

If included, filters to KYC links for the customer with the given id

​
email
string

If included, filters to KYC links for the customer with the given email

​
starting_after
string

This is a customer id. If this is specified, the next page that starts with a customer right AFTER the specified customer id on the customer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that customers older than the specified customer id will be returned (shouldn't be set if ending_before is set)

​
ending_before
string

This is a customer id. If this is specified, the previous page that ends with a customer right BEFORE the specified customer id on the customer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that customers newer than the specified customer id will be returned (shouldn't be set if starting_after is set)

​
limit
integer

The number of items to return (default of 10, max of 100)

Response

200
application/json

Successful KYC links status response

The response is of type object.