Improved

Schema examples migrated to standard OpenAPI examples

Broker API

Broker API request and response examples now use the standard OpenAPI examples keyword instead of the legacy x-examples extension. Values, order, and formatting are preserved, so the wire contract is unchanged and downstream tooling such as SDK generators can now read them.

  • Operation-level examples are now attached to the media types for the Onfido SDK token response, the Onfido SDK outcome request, and the order estimation request, making them visible in the API reference.
  • Empty example maps have been removed and a few example values corrected so they validate against their schemas.
  • Adds PAPER_ONLY to the account status enum, documented as an account limited to paper trading.
  • Adds accounts to the admin action category enum on the admin action events stream.

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
  • POST /v1/accounts
  • GET /v1/accounts
  • GET /v1/accounts/{account_id}
  • PATCH /v1/accounts/{account_id}
  • GET /v1/trading/accounts/{account_id}/account
  • GET /v2/events/admin-actions