Skip to main content

​
Steps to onboard and activate a customer

1

Create a new customer

2

Request their signature on the terms.

3

Verify the customer’s identity using one of these methods:

  • Direct Iron KYC link
  • Sumsub token sharing

​
Customer Status During Lifecycle

Onboarding lifecycle
  1. Signings Required The customer has not yet reviewed and signed all necessary documents.
  2. Identification Required The customer has not completed the required identification process.
  3. Active The customer has fulfilled all onboarding requirements and can access IRON services.
Status Reversion
  • If a need arises to repeat the KYB/C process during a customer’s lifecycle, you can initiate a new identification. This action transitions the customer’s status to -IdentificationRequired* and blocks access to Iron services until the process is completed.
  • Status Reversion: If new compliance actions are required, a customer’s status may revert from Active to Signings Required or Identification Required.

​
KYC Status

Identification Status values Pending → Customer has not started the process Processed → Customer has completed the input process PendingReview → Identification is ready for review by Compliance Team Approved Rejected → Identification has been approved by Compliance Team Rejected → Identification has been rejected by Compliance Team Typical State Flow: Pending → Processed → PendingReview → Approved / Rejected

​
Onboarding via API

To onboard customers using the API, follow these steps:
1

Create a Customer

Use the POST /customers endpoint to create a new customer.
curl --request POST \
     --header 'content-type: application/json; charset=utf-8' \
     --header 'idempotency-key: <unique-request-id>' \
     --header 'x-api-key: <your-api-key>' \
     --data '{"name": "new_amazing_customer", email: "[email protected]"}' \
     --url 'https://api.sandbox.iron.xyz/api/customers'
2

Retrieve Documents

Retrieve the required legal documents using the GET /documents endpoint.
curl --request GET \
     --header 'accept: application/json; charset=utf-8' \
     --header 'x-api-key: <your-api-key>' \
     --url 'https://api.sandbox.iron.xyz/api/customers/<customer_id>unsigned-documents'
3

Sign Documents

For each document retrieved, use the POST /customers/{id}/signings endpoint to mark it as signed.
curl --request POST \
     --header 'accept: application/json; charset=utf-8' \
     --header 'idempotency-key: <unique-request-id>' \
     --header 'x-api-key: <your-api-key>' \
     --data '{"document_id": <id_of_document>, "signed": true}' \
     --url 'https://api.sandbox.iron.xyz/api/customers/<customer_id>/signings'
4

Create an Identification

Finally, initiate the identification process using the POST /customers/{id}/identifications endpoint.
curl --request POST \
     --header 'accept: application/json; charset=utf-8' \
     --header 'idempotency-key: <unique-request-id>' \
     --header 'x-api-key: <your-api-key>' \
     --url 'https://api.sandbox.iron.xyz/api/customers/<customer_id>/identifications' \
     --data '{}'
For detailed guidance, see the Onboard a Customer Recipe.

​
Onboarding via Partner Dashboard

If you don’t have your own user interface, you can onboard customers using the Partner Dashboard:
1
Log In: Access the Partner Dashboard .
2
Navigate to Customers: Go to the “Customers” section and click the Onboard New button.
3
Create a Label: Assign a temporary label to identify the customer.
4
Generate a Signup Link: After creating the label, generate a signup link to share with the customer. They can complete the onboarding flow using IRON’s user interface.
Notes
  • API Integration: Ensure you handle idempotency-key correctly to avoid duplicate operations.
  • Compliance Requests: If additional information is needed, our compliance team will contact you directly.