In-app KYC
In-app KYC enables brokers to embed their Know your customer verification processes directly within cTrader.
Prerequisites
Important
Before implementing In-app KYC, ensure completion of:
- Setup actions: Infrastructure & connectivity, authentication of API calls
- Contracts: Broker identification, screen URL conventions
- Identity options: Either SSO user creation and authorisation or One-time token handoff
Endpoints used
Added by this module
None. In-app KYC opens a verification screen using a token resolved by the identity option; it introduces no broker → cTrader endpoints of its own.
Via the identity option
Token resolution depends on the identity option in use:
- One-time token handoff: the broker redeems the OT token received via the URL —
POST /ctid2/inAppToken/redeem(Block B). - SSO user creation and authorisation: no broker → cTrader call is required; cTrader validates the OT token via the broker CRM's
POST /oauth2/onetime/authorizeendpoint (called by cTrader, not the broker).
Required screens
KYC verification screen
- URL:
https://brokerCrmUrl.com/inapp/kyc - Parameters:
token