Skip to content

Get a list of financial instruments of the identity

Request

List financial instruments for an identity.

Security
Bearer
Path
identity-idstringrequired

Unique UUID string that maps to an identity

Example:2f4ac57f-c5ba-4051-b51f-b3565778717b
Query
versionstring

Version of the identity

Example:version=2
next-tokenstring

The token to use for the next page of results. If provided, the API will return financial instruments after this token.

Example:next-token=eyJrZXkxIjoidmFsdWVfMSIsImtleTIiOiJ2YWx1ZTIifQ==
limitinteger, [ 1 .. 100 ]

The maximum number of financial instruments to return. Default is 10, maximum is 100.

Default:10
Example:limit=20
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/v3/identities/2f4ac57f-c5ba-4051-b51f-b3565778717b/financial-instruments?version=2&next-token=eyJrZXkxIjoidmFsdWVfMSIsImtleTIiOiJ2YWx1ZTIifQ%3D%3D&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Requested financial instruments of the identity in JSON format

Bodyapplication/json
(application/json)
dataArray of objects

The list of the financial instruments that match the query parameters

nextTokenstring

The token to retrieve the next page of results

Response
{ "data": [ { … } ] }