Sign in

v1

latestOpenAPI 3.0.12026-07-22154142.9 KB
Customers

Create a customer

Creates a customer under the authenticated partner tenant. Returns 201 Created for a new customer, or 200 OK when a customer with the same email already exists and is returned instead of duplicated (created: false). Idempotent on the Idempotency-Key header: replaying the same key returns the original result — the same response and status as the first call — never a duplicate. If a create fails before it commits, the key is released; fix the request and retry with the same key.

post/v1/partner/customers

Headers

Idempotency-Keystring required

Unique key that makes the create safe to retry. Reuse the same value to retry; if the create fails before committing, the key is released, so retry with the same value.

Request body

emailstring required

Customer email address.

firstNamestring required

Customer legal first name.

lastNamestring required

Customer legal last name.

countryOfResidencestring required

ISO 3166-1 alpha-3 country of residence (e.g. USA).

phoneNumberstring

Customer phone number in E.164 format. Optional.

Example request

{
  "email": "founder@example.com",
  "firstName": "Ada",
  "lastName": "Lovelace",
  "countryOfResidence": "USA",
  "phoneNumber": "+12125550100"
}

Response

OK