API Reference

Show KYC details.

get
https://localhost/resources/private/v1/kycs/

Show KYC details by ID or for the current user.

Error codes for 404 responses:

  • KYC_NOT_FOUND_CURRENT - returned when 'current' is used as ID and no KYC exists for the current user
  • NOT_FOUND - returned when a specific KYC ID is not found
Path Params
string
required

The identifier of the KYC.
The identifier can be 'current' or in uuid format.

Example: '123e4567-e89b-12d3-a456-426655440000'

Query Params
string

Allows to request the inclusion of related resources.

Available relations:
* user

Example: user

Responses

Updated about 1 month ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?