Home
Guides
Developer Dashboard

KYC/KYB Link

HIFI-hosted KYC/KYB link for seamless, ready-to-use onboarding.

Suggest Edits

In addition to creating users and submitting KYC/KYB information via our endpoints, HIFI also provides a ready-to-use hosted KYC/KYB link to help you onboard users more quickly and efficiently.

✨

You can customize the link with your logo. For more information, please contact HIFI.

Generate KYC/KYB Link

For New User

You can create a new user and unlock multiple rails for the user in a single link. All required information will be seamlessly included in the link.

If no rails are provided when creating a user, only the wallet will be created.

curl --request POST \
     --url https://production.hifibridge.com/kyc-link \
     --header 'accept: application/json' \
     --header 'authorization: Bearer zpka_123456789' \
     --header 'content-type: application/json' \
     --data '
{
  "userType": "INDIVIDUAL",
  "rails": ["USD_EURO", "SOUTH_AMERICA_LIGHT"]
}
'

{
    "kycLinkUrl": "https://dashboard.hifibridge.com/production/kyc-link?sessionToken=768fb84ad65284cb5fffda212f5e779829318ac86db5a36efbf83c4f44369c73"
}

For Existing User

You can also generate a link to unlock multiple rails or request updated information for rails previously rejected for an existing user.

curl --request POST \
     --url https://production.hifibridge.com/kyc-link \
     --header 'accept: application/json' \
     --header 'authorization: Bearer zpka_123456789' \
     --header 'content-type: application/json' \
     --data '
{
  "userId": "8dff3730-245e-49f1-bb8d-4a3c90eba13a",
  "rails": ["USD_EURO", "SOUTH_AMERICA_LIGHT"]
}
'

{
    "kycLinkUrl": "https://dashboard.hifibridge.com/production/kyc-link?sessionToken=768fb84ad65284cb5fffda212f5e779829318ac86db5a36efbf83c4f44369c73"
}

More Example

Additionally, you can pass a redirectUrl to redirect the user to a specified page after the information is submitted. The userId of the user will be appended as a query parameter to the URL.
HIFI can also send the KYC/KYB link via email to the address specified using recipientEmail in the request body.

curl --request POST \
     --url https://production.hifibridge.com/kyc-link \
     --header 'accept: application/json' \
     --header 'authorization: Bearer zpka_123456789' \
     --header 'content-type: application/json' \
     --data '
{
  "userId": "8dff3730-245e-49f1-bb8d-4a3c90eba13a",
  "rails": ["USD_EURO", "SOUTH_AMERICA_LIGHT"],
  "redirectUrl": "https://www.hifibridge.com",
  "recipientEmail": "[email protected]"
}
'

{
    "kycLinkUrl": "https://dashboard.hifibridge.com/production/kyc-link?sessionToken=768fb84ad65284cb5fffda212f5e779829318ac86db5a36efbf83c4f44369c73"
}

Updated 18 days ago