Clients

Get clients

Get all clients for a contact.

get/clients

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/clients
  • Auth: API key in header x-api-key

Query parameters

statusinteger

Filter. Client relationship status (0: active, 1: inactive, 2: dead, 3: blocked).

pageinteger

The desired page number for pagination.

page_sizeinteger

The number of items per page for pagination.

Response

List of clients

account_numberinteger

The Ebury account number of a client.

address_line_1string

The first address line of a client.

address_line_2string

The second address line of a client.

citystring

The city name of a client.

client_idstring required

Identifier of the client.

client_namestring required

Name of the client.

client_entity_idstring

The identifier of the client's legal Ebury entity.

client_entity_namestring

The name of the client's legal Ebury entity.

client_entity_country_iso3string

The ISO 3166-1 alpha-3 code of the client's legal Ebury entity's country.

country_codestring

The ISO 3166-1 alpha-2 code of the client's country.

country_namestring

The name of the client's country.

is_mifidboolean

Whether the client is a MiFID client.

post_codestring

The post code of the client.

state_provincestring

The state or province of the client.

status'Active' | 'Inactive' | 'Closed' | 'Blocked' required

Status of the client.

brand_namestring required

Brand name of the client.

Changes

No recorded changes to this operation across all 1 revision of this API.