List Kyc Levels

Return the catalog of KYC levels available to this client.

Clients pick a key from this list when calling POST /api/v1/kyc/verify.
The underlying KYC provider is intentionally NOT surfaced — callers should
treat each key as an opaque identifier.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Return the catalog of KYC verification levels available to your client. Each level has a stable key and a human-readable display_name. Pick a key from this list when calling POST /api/v1/kyc/verify.

The key is an opaque, stable identifier — treat it as the value you pass back to the API. The verification backend behind each level is not surfaced.

Only levels that are currently active and accessible to your client are returned. Some levels are available to every client; others are scoped to specific clients. Levels are returned ordered by key.

Authentication & access

  • Requires a client API token: Authorization: Bearer <token>.
  • The caller must hold the kyc.users.read permission and have the OWNER, DEVELOPER, or OPERATIONS role.

Response

200 — returns a levels array. Each entry contains:

FieldDescription
keyStable identifier passed back to the API (e.g. in POST /api/v1/kyc/verify).
display_nameHuman-readable label suitable for rendering verbatim in a UI.

An empty levels array is returned when no levels are active and accessible to your client.

Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json