Skip to content

Data requirements utility v3

Identity Management v3

This utility is for Identity Management v3 only.

Identity Management v3 is an upcoming feature. For information on availability, early access, or migration, please contact your Ripple representative.

The supported payment corridors will be:

  • US • USD
  • EU • EUR
  • MX • MXN
  • BR • BRL
  • CO • COP
  • AE • AED
  • CA • CAD
  • GB • GBP
  • Africa • NGN, ZAR, RWF, UGX, CFA, XPF

Use this interactive tool to quickly determine the exact JSON schema requirements for creating Identity and Financial Instrument tokens in Identity Management v3.

Note

Every request to the Identity and Financial Instrument endpoints must conform to the specific schemas generated here.

How to use the utility

  1. Select Identity Type Choose whether the party is an INDIVIDUAL or BUSINESS.

  2. Select Payment Role Specify the party's role in the payment flow: ORIGINATOR (Sender) or a BENEFICIARY (Receiver).

  3. Select Payout Method (Financial Instrument Type)

Choose the required payment rail, such as US_ACH, EU_SEPA, or BR_PIX. This selection determines the conditional data fields required for the Identity.

What you'll get

  1. Requirements Tables

    • Display a simplified, tabular view of all fields pulled directly from the corresponding generated schema.
    • Offer a quick reference guide, highlighting whether each field is Required or Optional, along with its length constraints, without needing to parse the raw JSON.

  2. Identity schema

    • Displays the complete JSON Schema used to build the payload for creating an Identity token.
    • All conditional fields (e.g., dateOfBirth, registration) required by the selected Payment Role and Payout Method are automatically promoted to the required field list and tagged with [Required] or [Optional] to match the selected configuration.
    • Each generated identity JSON schema can be downloaded by clicking the associated Download Schema button.

  3. Financial instrument schema

    • Displays the schema necessary to build the payload for creating the Financial Instrument token (e.g., bank account details, wallet address).
    • Includes essential metadata describing the underlying payment rail and the supported currency corridors.
    • Each generated financial instrument JSON schema can be downloaded by clicking the associated Download Schema button.

Enter your selections

Select Type
Select Role
Select Method