BRbridge
Customers

Retrieve a hosted KYC Link for an existing customer

Changed on

The page at the returned URL will guide the user through a Bridge KYC flow. This can be used by existing customers to provide additional KYC information required for certain features or services that Bridge offers.

For example, to enable an existing customer to use the SEPA/Euro services, they are required to provide proof of address. An additional parameter, endorsement=sepa, can be included to request a KYC link specifically for this purpose

get/customers/{customerID}/kyc_link

Request

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

Path parameters

customerIDstring required

A UUID that uniquely identifies a resource

Query parameters

endorsement'sepa' | 'spei' | 'cards'

An endorsement is the approval required for a customer to use a particular product or service offered by Bridge

redirect_uristring
Example:http%3A%2F%2Fexample.com%2Fredirect

An optional url encoded link that users will be redirected to after completing the hosted KYC flow.

dedicatedboolean

When true, the returned link opens the dedicated hosted flow, which collects only the information still outstanding for the customer (optionally scoped by endorsement). If nothing is left to collect, url is an empty string.

Response

A Hosted URL for KYC

urlstring required

A hosted KYC link

Changes