Skip to main content
GET
Check the status of a KYC link

Authorizations

Api-Key
string
header
required

Path Parameters

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*

Response

Successful KYC link status response

id
string

ID of the KYC link

type
enum<string>

Type of the KYC link

Available options:
individual,
business
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

Link to the KYC flow

kyc_status
enum<string>

Status of the KYC flow.

Available options:
not_started,
incomplete,
awaiting_questionnaire,
awaiting_ubo,
under_review,
approved,
rejected,
paused,
offboarded
rejection_reasons
object[]
deprecated
read-only

Reasons why a customer KYC was rejected

Link to the TOS flow

tos_status
enum<string>

Status of the TOS flow

Available options:
pending,
approved
created_at
string<date-time>

Time of creation of the KYC link