Create a v2 identity

You need to create an identity for the beneficiary or originating party so they can be identified in the payment request.

Identities in Ripple Payments are objects that correspond to payment participants, such as payment originators and beneficiaries of payments. They contain all of the personally identifiable information (PII) connected to a specific individual or business to ensure proper compliance and proper routing.

This guide walks you through the API calls required to create an identity.

Prerequisite

You should have the following items before you continue:

• An access token to access secured API endpoints.

Create a new identity

Now we'll build the request for an identity token. This token will then be used to create the payment.

This example uses the create a new identity operation to create a new identity of the type BENEFICIARY.

• identityType : This example uses BENEFICIARY to create a beneficiary identity.
• nickName : This example uses a recognizable name such as Successful Business Beneficiary.
• useCaseType : This example uses BUSINESS to indicate creating a business identity.
• piiData : Populate this object with the required PII information for the chosen identityType.

curl -i -X POST \
  https://api.test.ripple.com/v2/identities \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "piiData": {},
    "identityType": "BENEFICIARY",
    "nickName": "MyCompany",
    "useCaseType": "BUSINESS"
  }'

Identity response

Store the identityId value for use later with the create payment operation.

{
  "identityId": "22222222-aaaa-2222-bbbb-222222222222",
  "version": 2
}