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/ so the static validation-schemas segment is not captured as a beneficiary_id.
Headers
The version of the beneficiary validation policy to apply. The latest one is used when omitted.
The access token.
Query Parameters
ISO 3166-1 alpha-2 country code of the beneficiary's bank.
2ISO 4217 currency code of the beneficiary's bank account.
3The 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.
The FORM_V1 schema shape version.
"form_v1"
The fields that can be submitted when creating a beneficiary for this bank country and currency.
Echoes the request's client, bank country and currency.
Whether payee/beneficiary verification (e.g. Confirmation of Payee) is required for this bank country/currency, and its type.
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).
Fields accepted by the create payload but not used for this bank country/currency; any value submitted for them is ignored rather than rejected.
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.