Skip to main content
POST
/
customers
Create a new customer
curl --request POST \
  --url https://api.sandbox.iron.xyz/api/customers \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>' \
  --data '
{
  "customer_type": "Business",
  "email": "<string>",
  "external_id": "<string>",
  "name": "<string>"
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "customer_type": "Business",
  "email": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "identification_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "name": "<string>",
  "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "signing_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "status": "UserRequired",
  "updated_at": "2023-11-07T05:31:56Z",
  "active_email": "<string>",
  "external_id": "<string>",
  "spending_limit_euro": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
IDEMPOTENCY-KEY
string
required

a UUID ensuring an Customer operation is only processed once

​
X-SUB-PARTNER-ID
string
required

Optional sub-partner UUID, if provided, the customer will be created for the sub-partner

Body

application/json; charset=utf-8

Parameters required to create a new Customer

Customer Params

Parameters for creating a customer

​
customer_type
enum<string>
required

CustomerType

Customers can either be a commercial business or a natural person

Available options:
Business,
Person
​
email
string
required

The primary point of contact email address for the customer Note that this email address will be used for all API authorization (e.g. 2FA)

​
external_id
string

External ID for the customer, provided by the partner

​
name
string

The name of the customer

Response

POST Customer Succeeded

Customer

The customer object in Iron

​
created_at
string<date-time>
required

Created at timestamp of Customer

​
customer_type
enum<string>
required

CustomerType

Customers can either be a commercial business or a natural person

Available options:
Business,
Person
​
email
string
required

Email of Customer, collected during identification process

​
id
string<uuid>
required

Unique ID of Customer

​
identification_ids
string<uuid>[]
required

Identifications associated with Customer

​
name
string
required

Name of Customer

​
partner_id
string<uuid>
required

Partner ID of the customer

​
signing_ids
string<uuid>[]
required

Signings associated with Customer

​
status
enum<string>
required

The status of the Customer

Available options:
UserRequired,
SigningsRequired,
IdentificationRequired,
Active,
Suspended
​
updated_at
string<date-time>
required

Updated at timestamp of Customer

​
active_email
string

Active email for receiving transaction emails (if different from primary email)

​
external_id
string

External ID for the customer, provided by the partner

​
spending_limit_euro
string

Spending limit of the customer in EURO (cents), null indicates no limit