Skip to main content
The following endpoint categories are not included in the Retail API for security and compliance reasons. Deposits and withdrawals must be done through the web portal. You must complete KYC verification through the web portal before you can generate API keys. API keys use signature-based authentication. You don’t need JWT refresh tokens when using API keys.

Funding

All /v1/payments/* endpoints are blocked.
EndpointReason
/v1/payments/depositsMoney movement - web only
/v1/payments/withdrawalsMoney movement - web only
/v1/payments/methodsPayment setup - web only
/v1/payments/transactionsUse web portal
All other /v1/payments/*Financial risk

KYC & Verification

All identity verification endpoints are blocked.
EndpointReason
/v1/kyc/*Onboarding - web only
/v1/verify/phone/*Verification - web only
/v1/verify/email/*Verification - web only

Account Setup Process

  1. Create account - Via web portal
  2. Complete KYC - Via web portal
  3. Verify email/phone - Via web portal
  4. Fund account - Via web portal
  5. Generate API keys - Via web portal (with JWT)
  6. Start trading - Via API

Account Management

Profile changes and security settings must be done via web.
EndpointReason
/v1/users/me (PUT/DELETE)Profile changes - web only
/v1/mfa/*Security setup - web only
/v1/auth/loginUse web login + API keys
/v1/auth/refreshNot needed with API keys

Security Settings via Web Only

  • Enable/disable 2FA - Web portal only
  • Change password - Web portal only
  • Update email - Web portal only
  • Update phone number - Web portal only
  • Delete account - Web portal only