---
title: "Get beneficiary form schema"
method: GET
path: "/beneficiaries/schema"
tags: ["Beneficiaries"]
---

# Get beneficiary form schema

`GET /beneficiaries/schema`

Returns the form schema containing all fields required to create a beneficiary for the given country, currency, entity type, and transfer method combination. Use this to dynamically render the beneficiary creation form.

## Query parameters

- `bankCountryCode` string, required — Two-letter ISO 3166-1 alpha-2 country code for the bank location
- `accountCurrency` 'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SRD' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR' | 'ZMW' | 'ZWL', required — Three-letter ISO 4217 currency code for the beneficiary account
- `entityType` 'PERSONAL' | 'COMPANY', required — Whether the beneficiary is an individual or a company
- `transferMethod` 'LOCAL' | 'SWIFT' — Transfer method: SWIFT for international wire transfers, LOCAL for domestic transfers
- `localClearingSystem` string — Local clearing system for domestic transfers (e.g., NPP, BANK_TRANSFER, BPAY for Australia). Only applicable when transferMethod is LOCAL.
- `fieldValues` object — Current values of fields with refresh=true. Used to get dynamic schema updates based on user selections.

## Response `200`

OK

- object — Form schema response containing all fields needed to collect beneficiary details
  - `fields` object[], required — Array of form fields with their display and validation configuration
    - `path` string, required — Dot-notation path to the field in the beneficiary request object
    - `enabled` boolean, required — Whether this field should be displayed
    - `required` boolean, required — Whether this field is required for submission
    - `field` object — Field definition with type, label, and options
      - `type` 'INPUT' | 'SELECT' | 'RADIO' | 'TRANSFER_METHOD' | 'DYNAMIC_SELECT', required — The type of form input to render
      - `label` string — Display label for the field
      - `placeholder` string — Placeholder text for input fields
      - `description` string — Detailed description of the field
      - `tip` string — Tooltip information shown on hover
      - `example` string — Example value for the field
      - `default` string — Default value to pre-populate the field
      - `key` string — Unique key identifier for the field
      - `options` object[] — Available options for SELECT and RADIO field types
        - `label` string, required — Display label for the option
        - `value` string, required — Value to submit when selected
        - `flightTime` object — Expected transfer time for TRANSFER_METHOD options
          - `min` number — Minimum number of time units for the transfer
          - `max` number — Maximum number of time units for the transfer
          - `unit` string — Time unit (e.g., 'day', 'hour')
        - `transferLimit` object — Transfer amount limits for TRANSFER_METHOD options
          - `min` number — Minimum transfer amount
          - `max` number — Maximum transfer amount
        - `processingTime` string — Human-readable processing time description
      - `refresh` boolean — When true, changing this field's value should trigger a schema refresh. Note: only documented API parameters (transfer_method, local_clearing_system) actually update the schema.
    - `rule` object — Validation rules for the field
      - `pattern` string — Regex pattern for field validation
      - `type` string — Validation type identifier
  - `selectedTransferMethod` 'LOCAL' | 'SWIFT' — The transfer method used to generate this schema. When not provided in the request, LOCAL is auto-selected if available.
  - `selectedLocalClearingSystem` string — The local clearing system used to generate this schema, if applicable.

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403
- `404` — 404
- `409` — 409
- `412` — 412
- `422` — 422
- `429` — 429
- `500` — 500
- `501` — 501
- `503` — 503

---

[API](https://skmtc.net/session/apis/session-services-api.md) · [All operations](https://skmtc.net/session/apis/session-services-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/session/session-services-api/versions/bec3de84da9e/schema)