Skip to main content
POST
Create customer

Authorizations

API-KEY
string
header
required

Your partner API key. The key must carry the onboarding permission.

Body

application/json
email
string<email>
required

Unique across the partner's customers.

firstName
string
required
Maximum string length: 100
lastName
string
required
Maximum string length: 100
dateOfBirth
string
required

DD-MM-YYYY. Must be a real past date, and the customer must be at least 18.

country
string
required

ISO 3166-1 alpha-3, e.g. ARE.

questionnaire
object
required

Sections of items. A single-select item uses { "value": "..." }; a multi-select uses { "values": [ ... ] }. Every accepted code is listed on the questionnaire reference page.

customFields
object
required
phone
string
Maximum string length: 50
nationality
string

ISO alpha-3. Defaults to country.

gender
enum<string>
Available options:
M,
F
tin
string
taxResidenceCountry
string

ISO alpha-3.

placeOfBirth
string
addressLine1
string
addressLine2
string
city
string
state
string
postalCode
string
externalReferenceId
string

Your own reference. Echoed back, not stored.

Response

Customer created or imported.

userId
string<uuid>
userType
string
Example:

"INDIVIDUAL"

status
string
Example:

"INITIATED"

sumsubApplicantId
string
warnings
string[]

Present on an import: fields that were ignored because identity came from the share token.