URL conventions and query parameters
Standardised URL patterns and query parameters ensure consistent behaviour across all SSO (OAuth) screens and in-app actions.
URL structure standards
Base URL requirements
All SSO (OAuth) screens must be hosted at consistent endpoints relative to the broker's CRM URL:
- Base Pattern:
https://brokerCrmUrl.com/ - Consistency: Avoid mixing domains (
broker.comandmy.broker.comshould not coexist) - SSL Required: All URLs must use HTTPS protocol
Screen URL patterns
Login/signup screen
https://brokerCrmUrl.com/auth/login
Trading account creation
https://brokerCrmUrl.com/account/create
In-app action screens
https://brokerCrmUrl.com/inapp/{action}
Success/callback URLs
https://brokerCrmUrl.com/callback/success
Mandatory query parameters
Core parameters
| Parameter | Screen(s) | Required? | Data type | Description |
|---|---|---|---|---|
token | In-app actions | Yes | string | The OT token required for authorisation. |
account | In-app actions | Yes (deposits/withdrawals); No (others) | integer | The number of a specific trading account linked to the user. |
Optional query parameters
Display and behaviour parameters
| Parameter | Screen(s) | Required? | Data type | Description |
|---|---|---|---|---|
lang | All screens | No | string | The language of the device OS. Takes Alpha-2 (ISO 639-1) codes. |
source | All screens | No | string | Application type: "Web", "Android", "iOS", "MacOS", "Desktop". |
theme | All screens | No | string | Preferred colour scheme: "light" or "dark". |
firstLogin | Login/signup | No | boolean | Flag for first login attempt on current device. |
partnerId | Login/signup | No | string | A unique partner identifier string assigned to a user or account. |
UTM tracking parameters
| Parameter | Screen(s) | Required? | Data type | Description |
|---|---|---|---|---|
utm_source | All screens | No | string | Source channel for user transfer to SSO (OAuth) screen. |
utm_medium | All screens | No | string | Content type that encouraged user to click link. |
utm_campaign | All screens | No | string | Marketing campaign name for user transfer. |
utm_term | All screens | No | string | Keyword that user engaged with for transfer. |
utm_gclid | All screens | No | string | Google Click identifier for transferred user. |
URL examples
Login screen with parameters
https://brokerCrmUrl.com/auth/login?lang=en&source=Web&theme=light&firstLogin=true&partnerId=somePartnerId
Mobile login screen
https://brokerCrmUrl.com/auth/login?lang=es&source=iOS&theme=dark&firstLogin=false
In-app deposit screen
https://brokerCrmUrl.com/inapp/deposit?token=abc123&account=123456&lang=en&source=Android
KYC screen with UTM tracking
https://brokerCrmUrl.com/inapp/kyc?token=xyz789&lang=fr&utm_source=email&utm_campaign=kyc_reminder