Create a client

Provision a company account for one of your clients. The id is knowable at once, so poll pollUrl with the returned id in X-Hevn-Account until status is ready — about 30 seconds. An identical resubmit answers 200 with Idempotency-Replayed: true and the same id.

POST /clients

Create a client

cURL

curl --request POST \
  --url https://api.example.com/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "[e-mail]"
}
'

201

{
  "id": "cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "status": "provisioning",
  "createdAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "baseSmartWallet": "<string>",
  "kybStatus": "notStarted",
  "kybApplicationId": "kyb_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "failure": {
    "code": "provisioning_failed",
    "message": "<string>",
    "retriable": false
  },
  "pollUrl": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key · string | null

Your own key for this write, ^[A-Za-z0-9._:-]{1,128}$. A retry with the same key replays the first answer; the same key with a different request is refused.

Example:

"po-inv-2026-114"

X-Hevn-Account · string | null

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key · string | null

Body

application/json

name · string · required

Legal or trading name used to identify the account.

Required string length: 1 - 500

email · string<email> · required

Unique account email used for verification correspondence.

phone · string | null

Phone number in international E.164 format.

Pattern: ^\+[1-9]\d{6,14}$

Response

201

application/json

Successful Response

id · string · required

Stable public identifier for this account.

Pattern: ^(?:cl_)?[A-Za-z0-9._:\-]{1,216}$

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

status · enum<string> · required

Current account-provisioning status.

Available options: provisioning, ready, failed

createdAt · string<date-time> · required

UTC timestamp when the account was created.

name · string | null

Legal or trading name of the account.

email · string | null

Email address associated with the account.

phone · string | null

Phone number in international E.164 format.

baseSmartWallet · string | null

Base smart-wallet address controlled by the account.

kybStatus · enum<string> · default: notStarted

Current business-verification status.

Available options: notStarted, pending, approved, rfi, rejected

kybApplicationId · string | null

Latest immutable business-verification application identifier.

Pattern: ^(?:kyb_)?[A-Za-z0-9._:\-]{1,216}$

Example:

"kyb_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

failure · ClientFailureResponse · object | null

Provisioning failure details, when present.

Show child attributes

pollUrl · string | null

Relative API URL to poll with this response's id in X-Hevn-Account.