{"templateId":"markdown","versions":[{"version":"v2026.03","label":"v2026.03","link":"/products/payments-direct-2/api-docs/integration-resources/data-requirements-utility-v3","default":true,"active":true,"folderId":"eb16255d"},{"version":"v2025.11","label":"v2025.11","link":"/products/payments-direct-2/v2025.11/api-docs/integration-resources/data-requirements-utility-v3","default":false,"active":false,"folderId":"eb16255d"}],"sharedDataIds":{"sidebar":"sidebar-products/payments-direct-2/@v2025.11/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","direct2CombinedDataRequirementsPicker"]},"type":"markdown"},"seo":{"title":"Data requirements utility (v3)","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com/products/custody","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"data-requirements-utility-v3","__idx":0},"children":["Data requirements utility (v3)"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Identity Management v3"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This utility is for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identity Management v3"]}," only."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The supported payment corridors are:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["US • USD"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["EU • EUR"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["MX • MXN"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["BR • BRL"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["CO • COP"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["CA • CAD"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["GB • GBP"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["NG • NGN"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["SWIFT • USD"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this interactive tool to quickly determine the exact JSON schema requirements for creating Identity and Financial Instrument tokens in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identity Management v3"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every request to the Identity and Financial Instrument endpoints must conform to the specific schemas generated here."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-use-the-utility","__idx":1},"children":["How to use the utility"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Select Identity Type"]}," ","Choose whether the party is an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INDIVIDUAL"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Select Payment Role"]}," ","Specify the party's role in the payment flow: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORIGINATOR"]}," (Sender) or a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BENEFICIARY"]}," (Receiver)."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Select Payout Method (Financial Instrument Type)"]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Choose the required payment rail, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US_ACH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EU_SEPA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BR_PIX"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SWIFT"]},". This selection determines the conditional data fields required for the Identity."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-youll-get","__idx":2},"children":["What you'll get"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Requirements Tables"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Display a simplified, tabular view of all fields pulled directly from the corresponding generated schema."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["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."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identity schema"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Displays the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["complete JSON Schema"]}," used to build the payload for creating an Identity token."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All conditional fields (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateOfBirth"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["registration"]},") required by the selected ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payment Role"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payout Method"]}," are automatically promoted to the required field list and tagged with ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["[Required]"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["[Optional]"]}," to match the selected configuration."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Each generated identity JSON schema can be downloaded by clicking the associated ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Download Schema"]}," button."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Financial instrument schema"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Displays the schema necessary to build the payload for creating the Financial Instrument token (e.g., bank account details, wallet address)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Includes essential metadata describing the underlying payment rail and the supported currency corridors."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Each generated financial instrument JSON schema can be downloaded by clicking the associated ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Download Schema"]}," button."]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"enter-your-selections","__idx":3},"children":["Enter your selections"]},{"$$mdtype":"Tag","name":"Direct2CombinedDataRequirementsPicker","attributes":{},"children":[]}]},"headings":[{"value":"Data requirements utility (v3)","id":"data-requirements-utility-v3","depth":1},{"value":"How to use the utility","id":"how-to-use-the-utility","depth":2},{"value":"What you'll get","id":"what-youll-get","depth":2},{"value":"Enter your selections","id":"enter-your-selections","depth":2}],"frontmatter":{"seo":{"title":"Data requirements utility (v3)"}},"lastModified":"2026-04-03T15:45:06.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments-direct-2/api-docs/integration-resources/data-requirements-utility-v3","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}