v4

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-04-277127123.7 KB

Customers

Create customer

Creates a new customer (buyer or seller). If a customer with the same email/phone already exists for this account, the existing record is updated and returned.

Either email or phone (with prefix) is required.

post/customers

Request body

namestring

first_namestring

last_namestring

emailstring email

Required if phone is not provided.

prefixstring

Phone country prefix (e.g. +34). Required with phone.

phonestring

Phone number without prefix. Required if email is not provided.

localestring

Customer's preferred locale.

tagstring

Custom tag for grouping or filtering.

vat_idstring

Tax identification number.

type'CLEARJUNCTION' | 'CURRENCYCLOUD'

Gateway-linked customer type. When set, additional KYC fields become required. CLEARJUNCTION requires id card fields; CURRENCYCLOUD also requires email and phone.

Example request

{
  "name": "John Doe",
  "email": "john@example.com",
  "prefix": "+34",
  "phone": "612345678"
}

Response

Customer created or updated

idinteger

selfstring

uuidstring

typestring nullable

namestring nullable

first_namestring nullable

last_namestring nullable

emailstring email nullable

prefixstring nullable

phonestring nullable

tagstring nullable

metadataobject nullable

created_atstring date-time nullable

connectionsConnections

Hypermedia links to related resources.

Example response

{
  "self": "/2.0/customers/abc123",
  "prefix": "+34"
}