Skip to main content
POST
/
v1
/
customers
Create a customer
curl --request POST \
  --url https://api.ledger.so/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "firstName": "Alice",
  "lastName": "Smith",
  "type": "individual"
}
'
{
  "ok": true,
  "data": {
    "id": "cus_abc123",
    "email": "[email protected]",
    "firstName": "Alice",
    "lastName": "Smith",
    "type": "individual",
    "status": "pending",
    "kycStatus": "not_started",
    "capabilities": [],
    "createdAt": "2025-01-15T10:30:00Z"
  }
}

Authorizations

Authorization
string
header
required

API key passed as a Bearer token. Format: ld_<env>_<prefix>_<secret> where <env> is test or live.

Headers

Idempotency-Key
string

Unique key to ensure idempotent request processing. Reusing a key for a different route or method returns 409 Conflict.

Example:

"idk_a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Body

application/json
email
string<email>
required

Customer's email address.

firstName
string
required

Customer's first name.

Example:

"Alice"

lastName
string
required

Customer's last name.

Example:

"Smith"

type
enum<string>
required

Whether this is an individual or business customer.

Available options:
individual,
business

Response

Customer created successfully

ok
boolean
required

Indicates the request was successful.

data
object