Counterparties

Check counterparty field requirements

Retrieve the list of conditionally required or applicable fields for creating a counterparty together with their constraints.

:::note [Note] This feature is not available in Sandbox. :::

When creating a counterparty via the Create a counterparty endpoint, certain fields (such as first_name, last_name, company_name, tax_id, route, or account_type) become required depending on the counterparty's bank country, currency, and profile type. This read-only endpoint allows you to discover these contextual fields dynamically, along with their validation rules and available options.

Only the fields relevant to the specific context are returned. The input parameters (country, currency, and recipient_type) are intentionally excluded from the response.

For more details, see the guide: Check counterparty field requirements section in Create a counterparty.

get/counterparties/fields

Request

  • Base URL
    https://b2b.revolut.com/api/1.0
  • Auth
    HTTP bearer

Query parameters

countrystring required

The country of the bank, provided as a 2-letter ISO 3166 code.

Example:GB

The country where the counterparty's bank account is located.

currencystring required

ISO 4217 currency code in upper case.

The currency of the counterparty's bank account.

recipient_type'personal' | 'business' required

The type of the counterparty profile. Indicates whether the counterparty is a personal or business account.

routestring

The routing method for the corridor. When omitted, the response includes fields for the default route. For example, for USD to US, the default is ach.

Response

The applicable and conditionally required fields for creating the counterparty

Changes

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