Skip to main content
POST
/
v1
/
businesses
/
{businessId}
/
kyb-link
Get KYB Link
curl --request POST \
  --url https://api.cadanapay.com/v1/businesses/{businessId}/kyb-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refreshURL": "<string>",
  "returnURL": "<string>"
}
'
{
  "id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
  "url": "<string>",
  "expiresAt": 1716796800
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

​
businessId
string
required

The unique identifier for the business

Body

application/json

Common request body for endpoints that generate hosted (link-out) URLs.

​
refreshURL
string
required

The URL the user will be redirected to if the link is expired

​
returnURL
string
required

The URL that the user will be redirected to upon leaving or completing the linked flow.

Response

create kyb link response

​
id
string<uuid>
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

​
url
string
​
expiresAt
number

The timestamp when the KYB link will expire

Example:

1716796800