When you send a payment through Ripple Payments Direct 2.0, you must provide identityIDs for both the Originator (the sender) and the Beneficiary (the receiver). These identifiers are created once and then reused across payments, reducing the need to send sensitive Personally Identifiable Information (PII) with every transaction.
To create an identityID, you must build a request body that includes the correct set of PII fields for the corridor, currency, and payout method you’re using. These requirements vary depending on local regulations, payout partner integrations, and payment flows.
The Payment Data Requirements Utility below helps you find the exact JSON schema you need. By selecting parameters such as identity type, use case, payout method, country, and currency, you can download or copy a schema that defines the fields required for creating the identityID.
Currently, the Payment Data Requirements utility provides JSON schemas only for U.S. payout corridors. Additional corridors and use cases will be added over time as they become available.
If you have questions about corridors that are not yet listed, or need guidance on specific data requirements, please contact your Ripple representative for assistance.
- Select the appropriate parameters in the form.
- Download or copy the JSON schema.
- Use this schema as the basis for constructing the piiData object in your identity creation payload.
- Submit the completed payload to the Create identity operation (
POST /v2/identities). - Use the returned
identityIDin subsequent payment requests (POST /v2/payments).