Skip to main content
GET
Get onboarding status
Where the wallet stands in bank onboarding: whether the registration form is filled, the terms of service are accepted, and how far identity verification has got. Poll it while a verification flow is on screen. Returns 404 until the wallet has been registered.

Authorizations

x-calm-publishable-key
string
header
required

Publishable key identifying the calling app.

Query Parameters

wallet
string
required
Pattern: ^0x[a-fA-F0-9]{40}$

Response

Wallet state.

created_at
string<date-time>
required
form_filled_at
string<date-time> | null
required
has_accepted_terms_of_service
boolean
required
identity_verification_status
enum<string>
required
Available options:
not_started,
incomplete,
awaiting_questionnaire,
awaiting_ubo,
under_review,
active,
rejected,
paused,
offboarded
wallet
string
required
Pattern: ^0x[a-fA-F0-9]{40}$