DocumentationAPI Endpoints v1API Endpoints v2
API Endpoints v1
Tokeny.com

Get candidates csv

get
https://example.com/servicing/api/tokens//candidates/csv

Get a list of candidates csv
šŸ” Note that the authentication must provide sufficient privileges to access the information of the holder list. The HOLDER_MANAGEMENT permissions grant full access to the data.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Path Params
string
required
Query Params
number
required
ā‰¤ 1000
Defaults to 20

Limit of results to return in one call

number
required
Defaults to 0

Offset to return results from

string

Filter the results by one or more candidate status

string

Filter the results by candidate name

string
string

Filter the results by email

string

Filter the results by type

string

Filter the results by identity check status

string

Filter the results by one or more KYC check status

string
Defaults to createdAt

Sort the results by this field

string
Defaults to ASC

Direction to sort the results

Responses
200

Returned a list of candidates as a CSV file.

400

Candidates retrieval failed due to invalid data.

401

Unauthorized.

403

Token not manageable with this authentication.

404

Token not found.

409

Token is missing qualification ID

Updated 8 months ago

Language
Credentials
Bearer
JWT
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here!

Updated 8 months ago