Onboard a new client

post

https://www.api.external.test.mercury.global/api/v1/client

Provisions a new client under your distributor account. Upon creation, the client status is initially Active.

Body Params

The new client details

Request body for onboarding a new client under your distributor account

externalReference

string

required

Your internal reference for this client. Must be unique across all clients under your distributor and cannot be reused.

clientType

string

enum

required

The type of client. One of Limited Company, PLC, Sole Trader, Partnership, Charity, Individual or Trust (not case-sensitive).

Allowed:

riskRating

string

enum

required

The assessed risk level: Low, Medium or High. See GET /api/v1/lookup/client-risk-rating-levels.

Allowed:

expectedMonthlySpend

double

required

The anticipated monthly payment volume in base currency.

associates

array of objects

The individuals associated with this client (directors, UBOs, etc.). Each associate's required fields are listed on the associate object.

associates

corporate

object | null

Corporate company details. Required for non-individual clients. When provided, name, registrationNumber, industryCode and registeredAddress are required.

Responses

401

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

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Client created successfully

400Validation failed — see the errors array

500Internal server error