Skip to main content
POST
Create Customer Identification V2

Authorizations

X-API-Key
string
header
required

API Key

Headers

IDEMPOTENCY-KEY
string
required

a UUID ensuring an Customer Identification operation is only processed once

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the identification will be created under scope of the sub-partner

X-API-Version
string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01.

Path Parameters

id
string<uuid>
required

the ID of the Customer to create an Identification for

Body

application/json; charset=utf-8

The Identification data to be used for the identification

Identification Create Params V2

The params required to create an identification v2, we support three types of identification:

  • Link: where a link is provided to the customer for access to the identification process.
  • Token: where a token is provided in the request from which verification data can be extracted and where the token is generated by the third party provider
  • Person: where the identification details of the person for which the identification process is being created are provided in the request
type
enum<string>
required
Available options:
Link
Example:

"Link"

with_edd
boolean

whether to initialize the identification with the full EDD process

Response

POST Customer Identification Succeeded

Identification

The entity wrapping our KYC/KYB process and underlying providers

created_at
string<date-time>
required
id
string<uuid>
required
status
enum<string>
required

The Process status of the identification

The various state transitions an identification can go through.

Available options:
Pending,
Processed,
PendingReview,
Approved,
Declined,
Expired,
Archived
updated_at
string<date-time>
required
customer_id
string<uuid>

Absent on a referral partner's identification (partner-keyed record)

partner_id
string<uuid>

The owning partner for partner-keyed (referral) records

residence_country
string

ISO 3166-1 alpha-2 (2 letter) country code of the verified residence address; only set on the customer's most recent identification while it is approved

review_comment
string
step_status
BusinessIdentificationStepStatus · object
url
string
with_edd
boolean