Get TokenHolders from a token csv

get

https://example.com/servicing/api/tokens/{tokenId}/holders/csv

Get details of all Token Holder profiles which are related to the specified token from different data sources. This will include Holders having tokens, those registered in the Identity Registry, and those the Issuer of the Token can access information of.
🔐 Note that the authentication must provide management rights over the Issuer. The required permission is ISSUER_MANAGEMENT.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tokenId

string

required

Query Params

limit

number

≤ 1000

Defaults to 20

Limit of results to return in one call

offset

number

Defaults to 0

Offset to return results from

sortBy

string

enum

Defaults to balance

sort results by attribute, default: balance

sortDirection

string

Defaults to DESC

set the direction (ASC or DESC) of sorted results by attribute, default: DESC

status

string

filter by holder statuses. One of [Qualified,Failed,InProgress,TokenHolder,Revoked]

string

filter by email field

firstName

string

filter by first name field

lastName

string

filter by last name field

institutionName

string

filter by institution name field

investor

string

filter by first and last name or institution legal name field

identityAddress

string

filter by OnchainID identity address field

countriesOfResidence

string

filter by countries of residence field

identityId

string

filter by identityId

wallet

string

wallet of the investor

typeOfInvestor

string

enum

filter by type of Investor institutional or individual

Allowed:

jwt

string

JWT access token

walletProvider

string

enum

Provider of the wallet address.

Allowed:

Responses

200

Details of all token holder profile.

400

Token Holders retrieval failed due to invalid data.

401

Unauthorized.

403

Token not manageable with this authentication.

404

Token not found.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!