Beneficiaries V2

Get beneficiary validation schema (V2)

Returns the declarative FORM_V1 validation schema (metadata) describing the fields, options, constraints, verification requirements and cross-field rules for creating a beneficiary with the given bank country and currency, in the V2 field-name vocabulary. Registered before /v2/beneficiaries/{beneficiary_id} so the static validation-schemas segment is not captured as a beneficiary_id.

get/v2/beneficiaries/validation-schemas

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/v2/beneficiaries/validation-schemas
  • Auth: API key in header x-api-key

Query parameters

country_codestring required

ISO 3166-1 alpha-2 country code of the beneficiary's bank.

currency_codestring required

ISO 4217 currency code of the beneficiary's bank account.

Headers

X-Beneficiary-Policy-Versionstring

The version of the beneficiary validation policy to apply. The latest one is used when omitted.

Response

The declarative FORM_V1 validation schema (metadata) for creating a beneficiary with the given bank country and currency.

schema_versionstring required

The FORM_V1 schema shape version.

rulesobject[]

Cross-field validation rules (e.g. a field becoming required when another field has a given value) that cannot be expressed on a single field alone. Each rule's type selects its shape.

Example response

{
  "schema_version": "form_v1"
}

Changes

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