Skip to main content
POST
/
clients
Create a client
curl --request POST \
  --url https://api-sandbox.ledgersyncappv2.com/v3/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "email": "jsmith@example.com",
  "name": "<string>",
  "metadata": {}
}
'
{
  "id": "cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0",
  "created_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "email": "jsmith@example.com",
  "name": "<string>",
  "metadata": {},
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Pass your secret key in the Authorization header as a Bearer token: Authorization: Bearer sk_test_... (sandbox) or Bearer sk_live_... (production).

Keys are created in the developer portal and the plaintext secret is shown exactly once at creation. Treat them like passwords — never embed them in mobile apps or front-end code.

Headers

​
Idempotency-Key
string

Safe-retry key for POSTs. Send any unique string per logical request (a UUIDv4 is great). If the network drops and you retry with the same Idempotency-Key within 24 hours, you get the exact same response back instead of creating a duplicate.

Cached responses include failures (4xx and 5xx) too. If a call failed because of a bad input and you want to try again with the corrected input, use a fresh key — otherwise you'll keep getting the cached failure.

Maximum string length: 255
Example:

"6f1a8c50-3e9c-4d4a-b1f5-2c5b9a2f7d11"

Body

application/json
​
external_id
string | null
​
email
string<email> | null
​
name
string | null
​
metadata
object

Response

Client created. The returned id (e.g. cli_01HXYZ...) is what you'll pass to every connection and account call.

​
id
string
required
Example:

"cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0"

​
created_at
string<date-time>
required
​
external_id
string | null

Integrator-supplied identifier; useful for joining to your own systems.

​
email
string<email> | null
​
name
string | null
​
metadata
object

Free-form key-value pairs for integrator use. Max 20 keys.

​
updated_at
string<date-time>