Skip to main content
GET
Get beneficiary validation schema (V2)

Headers

X-Beneficiary-Policy-Version
string

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

Authorization
string
required

The access token.

Query Parameters

country_code
string
required

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

Required string length: 2
currency_code
string
required

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

Required string length: 3
client_id
string
required

The identifier of a client.

Response

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

The declarative FORM_V1 schema describing how to fill in a beneficiary for a given bank country and currency, in the V2 field-name vocabulary. The compiler is a faithful projection of the resolved policy, so the exact set of fields, options and rules varies by bank country/currency.

schema_version
string
required

The FORM_V1 schema shape version.

Example:

"form_v1"

fields
object[]
required

The fields that can be submitted when creating a beneficiary for this bank country and currency.

context
object

Echoes the request's client, bank country and currency.

payee_verification
object

Whether payee/beneficiary verification (e.g. Confirmation of Payee) is required for this bank country/currency, and its type.

bank_account_verification
object

The field groups whose presence triggers a bank-account verification check (e.g. an IBAN, or an account number together with a local routing identifier).

ignored_fields
object[]

Fields accepted by the create payload but not used for this bank country/currency; any value submitted for them is ignored rather than rejected.

rules
object[]

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.