User Onboarding
User Onboarding
User onboarding is the first operational dependency for Crypto as a Service. A user must reach ACTIVE status before they can place orders, make withdrawals, or receive deposits.
For the complete onboarding reference (user statuses, onboarding tasks, supported legal ID formats, identity documents, error codes, webhooks, and country-specific rules), see the User Onboarding section.
Quick reference
| Action | Endpoint |
|---|---|
| Create user | POST /crypto/v2/users |
| Get users | GET /crypto/v2/users |
| Get user by ID | GET /crypto/v2/users/USERANYID |
| Get missing onboarding data | GET /crypto/v2/stats/onboarding/missing-personal-data/USERID |
| Submit onboarding action | POST /crypto/v2/onboarding-actions/initial |
Recommended sequence
- Create the user with
POST /crypto/v2/users. - Retrieve missing onboarding requirements.
- Submit required fields and documents.
- Track status via
USER_ONBOARDING_UPDATEwebhooks until the user isACTIVE.
Sandbox behavior
In the sandbox environment, creating a user with the name fail (case-insensitive) triggers a rejection response. Use any other name to simulate a successful onboarding flow.
Updated 27 days ago
Did this page help you?