Update an existing client

Updates the details of an existing client. The payload completely overwrites the existing corporate and associate details.

Body Params

The updated client details

Request body for updating an existing client's details

string
required

The Mercury-assigned reference of the client you wish to update. Must belong to an Active client under your distributor account.

string
enum
required

The updated assessed risk level: Low, Medium or High.

Allowed:
double
required

The updated anticipated monthly payment volume.

associates
array of objects

The complete updated list of individual associates. This entirely replaces the existing associates.

associates
corporate
object | null

The updated corporate company details. When provided, name and registeredAddress are required.

Responses

401

Missing or invalid x-api-key, x-nonce or Authorization signature. The response has no body.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json