---
title: "Generate the Links needs to complete KYC for an individual or business"
method: POST
path: "/kyc_links"
tags: ["KYC Links"]
---

# Generate the Links needs to complete KYC for an individual or business

`POST /kyc_links`

## Headers

- `Idempotency-Key` string, required

## Request body

- CreateKycLinks
  - `full_name` string — Full name of the customer, for a business, this would be the business entity's legal name
  - `email` string, required — Email of the customer
  - `type` 'individual' | 'business', required — Type of the customer (individual vs. business)
  - `endorsements` EndorsementType[] — List of endorsements to request for the generated KYC link. For example, `sepa` endorsement could be requested to allow an `individual` customer to submit `proof-of-address` documents in the KYC flow.
  - `redirect_uri` string — The location where the customer should be redirected after completing the KYC flow. Must be in the form of http:// or https://.
  - `transliterated_first_name` string — Required when the `full_name` of an individual includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~
  - `transliterated_middle_name` string — Required when the `full_name` of an individual includes any non Latin-1 characters and the individual has a middle name. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~
  - `transliterated_last_name` string — Required when the `full_name` of an individual includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~
  - `transliterated_business_legal_name` string — Required if the `full_name` of a business includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~

## Response `200`

KYC Links generated

- IndividualKycLinkResponse
  - `id` string — ID of the KYC link
  - `type` 'individual' | 'business' — Type of the KYC link
  - `customer_id` string — ID of the customer.
  - `full_name` string — Full name of the customer, for a business, this would be the business entity's legal name
  - `email` string — Email of the customer
  - `kyc_link` string — Link to the KYC flow
  - `kyc_status` 'not_started' | 'incomplete' | 'awaiting_questionnaire' | 'awaiting_ubo' | 'under_review' | 'approved' | 'rejected' | 'paused' | 'offboarded' — Status of the KYC flow.
  - `rejection_reasons` RejectionReason[] — Reasons why a customer KYC was rejected
    - `developer_reason` string — Developer information for why a customer was rejected. Not to be shared with the customer.
    - `reason` string — Reason for why a customer was rejected. To be shared with the customer.
    - `created_at` string, nullable — Time of creation of the rejection reason
  - `tos_link` string — Link to the TOS flow
  - `tos_status` 'pending' | 'approved' — Status of the TOS flow
  - `created_at` string, date-time — Time of creation of the KYC link

## Other responses

- `400` — Request containing missing or invalid parameters.
- `401` — Missing or invalid API key
- `500` — Unexpected error. User may try and send the request again.

---

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