GET
/
kyc_links
/
{kycLinkID}
Check the status of a KYC link
curl --request GET \
  --url https://api.bridge.xyz/v0/kyc_links/{kycLinkID} \
  --header 'Api-Key: <api-key>'
{
  "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"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
kycLinkID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Response

Successful KYC link status response

​
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