Update a customer

put

https://api.sandbox.audd.digital/customer/customers/{customerId}

Replace the details of a customer under your account. The company is taken from your token, so a customer belonging to another company returns 404. Changing a field used for KYC identity (first, middle or last name, date of birth, or address) pushes the new details to the KYC provider, resets the applicant, and moves the KYC level to REVERIFICATION_REQUIRED, which discards any documents already submitted; the customer must submit them again through a new link from POST /customer/customers/{customerId}/kyc. Sending merchantGroupId moves the customer to that group and clears the current tier; omit it to edit the profile only. Requires the customer.write scope. Send a unique Idempotency-Key header so the request can be safely retried.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

string

required

Public id of the customer to update.

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. Moves the customer to this merchant group and clears the current tier. The customer stays in its current group when omitted.

Headers

Idempotency-Key

string

required

Unique key for this request, exactly 32 characters. Replaying the same key with the same body returns the stored response without updating the customer or resetting the applicant again. 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, or client certificate/source IP not allowed

404

No customer with this id under your company, or the merchant group was not found

409

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

500

Internal server error

200Customer updated

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)