Skip to main content
POST
/
customers
/
{id}
/
identifications
/
v2
Create Customer Identification V2
curl --request POST \
  --url https://api.sandbox.iron.xyz/api/customers/{id}/identifications/v2 \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "type": "Link",
  "with_edd": true
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "review_comment": "<string>",
  "step_status": {
    "company_beneficiaries": {
      "retry": true,
      "comment": "<string>"
    },
    "company_data": {
      "retry": true,
      "comment": "<string>"
    },
    "company_documents": {
      "retry": true,
      "comment": "<string>"
    },
    "questionnaire": {
      "retry": true,
      "comment": "<string>"
    }
  },
  "url": "<string>",
  "with_edd": true
}

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

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
​
customer_id
string<uuid>
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
​
updated_at
string<date-time>
required
​
review_comment
string
​
step_status
BusinessIdentificationStepStatus · object
​
url
string
​
with_edd
boolean