# Payload Schema Utility

Use this interactive tool to generate the exact JSON schema for creating identity and financial instrument tokens for any supported corridor in Payments Direct.

Field requirements vary by payment rail, beneficiary type, originator type, and use case. This utility filters the schema for your specific scenario, showing only the fields you need to send.

## How to use the utility

Make selections in the order below. Each step narrows the schema to your scenario.

1. **Identity type** — `INDIVIDUAL` or `BUSINESS`.
2. **Payment role** — `ORIGINATOR` (sender) or `BENEFICIARY` (receiver).
3. **Financial instrument type** — the payment rail, such as `US_ACH`, `EU_SEPA`, or `BR_PIX`. This selection determines the conditional fields required for the identity.


## What the utility returns

**Requirements table.** A scannable, tabular view of the fields the selected scenario requires, with length and pattern constraints. Use this for quick reference during integration. Fields the corridor does not require are not listed; the schemas below carry the complete set. Each field is marked with one of two states:

- **Required.** The [Create an identity](/products/payments-direct-2/api-docs/developer-guides/create-and-manage-identities) or [Add a financial instrument](/products/payments-direct-2/api-docs/developer-guides/create-and-manage-financial-instruments) call fails with a 400 if you omit it.
- **Required at payment.** The identity or instrument is accepted without it, but a payment that needs it is rejected. These are values the payout partner requires at execution rather than at onboarding, so the field is not enforced until you send a payment. Populate them during onboarding anyway: a payment blocked at this stage needs the identity updated before it can be retried.


**Identity schema.** The complete JSON Schema for the [Create an identity](/products/payments-direct-2/api-docs/developer-guides/create-and-manage-identities) request body, including optional fields the table above omits. Conditional fields (such as `dateOfBirth` or `registration`) are automatically promoted into the schema's `required` list when they apply to the selected payment role and rail. Click **Download Schema** to save the JSON locally for use in client code generators.

**Financial instrument schema.** The complete JSON Schema for the [Add a financial instrument](/products/payments-direct-2/api-docs/developer-guides/create-and-manage-financial-instruments) request body, again including optional fields, with the payment rail object (such as `usAch`, `euSepa`, or `brPix`) and the metadata describing the supported currency corridors. Click **Download Schema** to save.

## Enter your selections