Create a customer

post

https://api.sandbox.audd.digital/customer/customers

Create a customer under your account. Optionally assign the customer to a merchant group on creation with merchantGroupId. Send a unique Idempotency-Key header so the request can be safely retried.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

firstName

string

required

length ≤ 255

lastName

string

required

length ≤ 255

middleName

string

length ≤ 255

string

required

length ≤ 255

phoneNumber

string

required

length ≤ 15

^\+[1-9][0-9]{1,14}$

dateOfBirth

string

required

^[0-9]{2}/[0-9]{2}/[0-9]{4}$

addressLine1

string

required

length ≤ 255

addressLine2

string

length ≤ 255

suburb

string

required

length ≤ 255

postcode

string

required

length ≤ 20

state

string

required

length ≤ 100

country

string

required

^[A-Za-z]{3}$

registrationNumber

string

length ≤ 255

Required for every companyType except INDIVIDUAL.

companyType

string

enum

required

Allowed:

companyBusinessName

string

length ≤ 255

Required when companyType is PRIVATE_COMPANY, PUBLIC_COMPANY, or TRUST.

merchantGroupId

string

length ≤ 255

Optional. Defaults to your company's active default merchant group when omitted.

Headers

Idempotency-Key

string

required

Unique key for this request, exactly 32 characters. Reusing a key with a different body, or while the first request is still in flight, returns 409.

Authorization

string

required

Responses

401

Missing, invalid, or expired token

403

Insufficient token scope, client certificate/source IP not allowed, or the merchant group belongs to another company

404

Merchant group not found

409

A customer with this email already exists for your company, or the Idempotency-Key was reused for a different request or is still in progress

500

Internal server error

201Customer created

400Field-level validation error(s) from backend bean validation, a missing or non-32-character Idempotency-Key, or a merchant group that cannot be assigned (archived, or no active default group)