Terminal onboarding (JWT)

The /v1/firm-control/me/* routes are reserved for the trader-facing terminal authenticating with a user JWT. Firm API keys cannot call them — attempts return 403 firm_key_not_permitted. Document these only if you ship a custom trader terminal. Most prop firm integrators do not need them.

Auth

Authorization: Bearer <jwt>

Endpoints

Method	Path	`operationId`	Purpose
`GET`	`/v1/firm-control/me/firm`	`resolveMyFirm`	Resolve the firm the JWT belongs to.
`GET`	`/v1/firm-control/me/scopes`	`resolveMyScopes`	Effective scopes for the JWT.
`GET`	`/v1/firm-control/me/market-data-onboarding`	`getMarketDataOnboarding`	Current market-data onboarding state.
`POST`	`/v1/firm-control/me/market-data-onboarding/accept-invitations`	`acceptFirmInvitations`	Accept pending firm invitations.
`POST`	`/v1/firm-control/me/market-data-onboarding/complete`	`completeMarketDataOnboarding`	Mark onboarding complete (pro/non-pro attestation).
`GET`	`/v1/firm-control/me/pending-relationships`	`listMyPendingRelationships`	Pending firm relationships awaiting acceptance.

Resolve current firm

GET /v1/firm-control/me/firm

{
  "firm_id": "7b8a...",
  "slug": "acme",
  "name": "Acme Capital",
  "role_slugs": ["trader"]
}

Resolve scopes

GET /v1/firm-control/me/scopes

{
  "scopes": ["orders:write", "fills:read", "balances:read"],
  "market_data_tier": "non_pro"
}

Market-data onboarding

GET /v1/firm-control/me/market-data-onboarding

Returns the form state the terminal renders for new traders (pro/non-pro questionnaire, signed agreements).

POST /v1/firm-control/me/market-data-onboarding/accept-invitations
POST /v1/firm-control/me/market-data-onboarding/complete

Posted by the terminal as the trader progresses through the onboarding flow.

Pending relationships

GET /v1/firm-control/me/pending-relationships

Returns firm relationships the trader has been invited to but not yet accepted. The terminal renders these as “Accept invite” cards.

Backend integrators provisioning traders programmatically should use Generate account + Confirm acceptance instead of asking traders to walk through the terminal flow.

Overview

Account Provisioning

Terminal Embed

Firm & Users

Staff & RBAC

Offerings & Acceptance

API Keys

Webhooks

Realtime WebSocket

Operations

Firm Backoffice Reads