v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB
KYC Links

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

post/kyc_links

Headers

Idempotency-Keystring required

Request body

full_namestring

Full name of the customer, for a business, this would be the business entity's legal name

emailstring required

Email of the customer

type'individual' | 'business' required

Type of the customer (individual vs. business)

endorsementsEndorsementType[]

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_uristring

The location where the customer should be redirected after completing the KYC flow. Must be in the form of http:// or https://.

transliterated_first_namestring

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_namestring

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_namestring

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_namestring

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

KYC Links generated

idstring

ID of the KYC link

type'individual' | 'business'

Type of the KYC link

customer_idstring

ID of the customer.

full_namestring

Full name of the customer, for a business, this would be the business entity's legal name

emailstring

Email of the customer

kyc_linkstring

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.

tos_linkstring

Link to the TOS flow

tos_status'pending' | 'approved'

Status of the TOS flow

created_atstring date-time

Time of creation of the KYC link