End-users

End-users are the people who use your product. Create one before initiating an onramp or offramp transaction so KYC and limits can be tracked.

The end-user object

Field	Type	Description
id	string	Unique identifier.
email	string	Unique within your account. Used for KYC contact.
name	string \| null	Optional legal name.
country	string (ISO 3166-1)	Two-letter country code. Determines available payment rails.
kycStatus	enum	PENDING, APPROVED, or REJECTED.
createdAt	string (ISO 8601)	When the record was created.

GET/api/v1/end-users

List your end-users

Returns up to 100 end-users belonging to the API key's owner.

200 Response

{
  "data": [
    {
      "id": "clx9p2k3a0000abc",
      "email": "[email protected]",
      "name": "Ada Lovelace",
      "country": "GB",
      "kycStatus": "APPROVED",
      "createdAt": "2026-05-28T10:42:00.000Z"
    }
  ]
}

POST/api/v1/end-users

Create an end-user

Required fields: email, country. Optional: name.

Request body

{
  "email": "[email protected]",
  "name": "Ada Lovelace",
  "country": "GB"
}

201 Response

{
  "id": "clx9p2k3a0000abc",
  "email": "[email protected]",
  "name": "Ada Lovelace",
  "country": "GB",
  "kycStatus": "PENDING",
  "createdAt": "2026-05-28T10:42:00.000Z"
}

Status	Meaning
400	Invalid body. `details` lists offending fields.
409	An end-user with this email already exists under your account.

PATCH/api/v1/end-users/{id}

Update an end-user

Send any subset of email, name, country — at least one. Returns the updated end-user.

Request body

{
  "name": "Ada B. Lovelace",
  "country": "GB"
}

Status	Meaning
400	Invalid body, or no fields provided.
404	No end-user with that id exists under your account.
409	Another end-user already uses that email.