BRbridge
KYC Links

Get all KYC links.

Changed on

Retrieve the full list of kyc links.

get/kyc_links

Request

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

Query parameters

customer_idstring

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

emailstring

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

starting_afterstring

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_beforestring

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)

limitinteger

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

Response

Successful KYC links status response

countinteger required

total number of items in data

Changes

  • a390532e9fc6Revision changes
    • warning

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