Skip to main content
POST
/
v2
/
kyc-link
Generate a KYC link
curl --request POST \
  --url https://production.hifibridge.com/v2/kyc-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rails": [],
  "redirectUrl": "<string>",
  "recipientEmail": "<string>",
  "templateId": "<string>"
}
'
{
  "kycLinkUrl": "http://dashboard.hifibridge.com/production/kyc-link?sessionToken=768fb84ad65284cb5fffda212f5e779829318acwdab5a36efbf83c4f44369c73"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
userType
enum<string>
required
Available options:
INDIVIDUAL,
BUSINESS
​
rails
enum<string>[]

KYC rails to unlock for the user, if not provided, only wallet will be created

Available options:
USD,
SOUTH_AMERICA_STANDARD,
AFRICA_GENERAL,
AFRICA_NIGERIA
​
redirectUrl
string

URL to redirect to after KYC information is submitted, userId will be appended to the URL as a query parameter

​
recipientEmail
string

Email address to send the KYC link to if provided (only in production)

​
templateId
string

Template ID to use for the KYC link, please contact HIFI for more information

Response

Success

​
kycLinkUrl
string

KYC link to be shared with the user