BRbridge
KYC Links

Check the status of a KYC link

Changed on

Retrieve the status of a KYC request from the passed in KYC link id

get/kyc_links/{kycLinkID}

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/kyc_links/{kycLinkID}
  • Auth
    API key in header Api-Key

Response

Successful KYC link status response

idstring

ID of the KYC link

type'individual' | 'business'

Type of the KYC link

customer_idstring

ID of the customer.

full_namestring

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

emailstring

Email of the customer

kyc_linkstring

Link to the KYC flow

kyc_status'not_started' | 'incomplete' | 'awaiting_questionnaire' | 'awaiting_ubo' | 'under_review' | 'approved' | 'rejected' | 'paused' | 'offboarded' | 'deposits_restricted'

Status of the KYC flow.

tos_linkstring

Link to the TOS flow

tos_status'pending' | 'approved'

Status of the TOS flow

created_atstring date-time

Time of creation of the KYC link

Changes

  • a390532e9fc6Revision changes
    • warning

      added the new deposits_restricted enum value to the response property for the response status