Region: US
Changelog
Trading DashboardBroker Dashboard
Back to All
Improved

Schema examples migrated to standard OpenAPI 3.1 examples

August 17th, 2026

Example values across the Broker and Trading API descriptions now use the standard OpenAPI 3.1 examples keyword instead of the legacy x-examples extension. Values, ordering, and formatting are preserved, and no request or response contract changes.

  • Component schema examples are now readable by standard OpenAPI tooling, including SDK and mock generators.
  • A few example values that did not validate against their schema have been corrected.
  • Empty example maps have been removed.

Broker API

Three operation-level examples are now attached to request and response media types, so they render in the API reference:

  • Onfido SDK token response on GET /v1/accounts/{account_id}/onfido/sdk/tokens.
  • Onfido SDK outcome request on PATCH /v1/accounts/{account_id}/onfido/sdk.
  • Order estimation request on POST /v1/trading/accounts/{account_id}/orders/estimation.

The account status enum also documents PAPER_ONLY, and the admin action category enum documents accounts.

Affected Endpoints

  • GET /v1/accounts/{account_id}/onfido/sdk/tokens
  • PATCH /v1/accounts/{account_id}/onfido/sdk
  • POST /v1/trading/accounts/{account_id}/orders/estimation