Skip to main content
GET
Get eKYC identity-verification status

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Response

The current eKYC identity-verification state.

The current eKYC identity-verification state.

data
object

eKYC identity-verification state. A never-started org reports status: not_started; an in-flight session carries the provider-hosted capture URL.

meta
object