Skip to main content
GET
Retrieve a hosted KYC Link for an existing customer

Authorizations

Api-Key
string
header
required

Path Parameters

customerID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*

Query Parameters

endorsement
enum<string>

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

Available options:
sepa,
spei,
cards
redirect_uri
string

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

Example:

"http%3A%2F%2Fexample.com%2Fredirect"

dedicated
boolean

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

url
string
required

A hosted KYC link