GET
/
customers
/
{customerID}
/
kyc_link
Retrieve a hosted KYC Link for an existing customer
curl --request GET \
  --url https://api.bridge.xyz/v0/customers/{customerID}/kyc_link \
  --header 'Api-Key: <api-key>'
{
  "url": "https://bridge.withpersona.com/verify?inquiry-template-id=itmpl_NtIXpb9AbEYCPxGo5iRbc9d2&reference-id=75d2f259-6810-4cde-a9b9-83eca42b0ebf"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
customerID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

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"

Response

A Hosted URL for KYC

​
url
string
required

A hosted KYC link