---
title: "Generate a KYC link"
method: POST
path: "/v2/kyc-link"
tags: ["Kyc"]
---

# Generate a KYC link

`POST /v2/kyc-link`

Generate a KYC link to create a user, unlock rails for a user, or submit KYC for a user.

This endpoint allows you to generate a HIFI-hosted KYC link that can be shared with users to collect their KYC information. The collected data can be used for User Creation, KYC Submission, or unlocking KYC rails for the user.

## Request body

- union
  - KycLinkForUserCreation
    - `userType` 'INDIVIDUAL' | 'BUSINESS', required
    - `rails` string[] — KYC rails to unlock for the user, if not provided, only wallet will be created
    - `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
  - KycLinkForUnlockingRails
    - `userId` string, required
    - `rails` string[], required — KYC rails to unlock for the user
    - `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 `200`

Success

- KycLinkObject
  - `kycLinkUrl` string — KYC link to be shared with the user

## Other responses

- `401` — Unauthorized
- `404` — Resource not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/hifibridge/apis/hifi-api.md) · [All operations](https://skmtc.net/hifibridge/apis/hifi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hifibridge/hifi-api/revisions/74d9e530fbea/schema)