Improved
Clearer descriptions and examples across Broker API schemas
November 6th, 2026
Broker API
Improves how several Broker API schemas are documented and rendered. Values, required fields, and response shapes are unchanged.
- Adds a request body description to the create-agreement endpoint.
- Adds an example to the idempotency key conflict response on the create-journal endpoint (
code: 42210000,message: idempotency key reused with a different request body). account_type,account_sub_type, andminor_identityonAccountCreationRequestnow render their own descriptions and thetradingdefault foraccount_typecorrectly.- On
AdminActionEventGeneral, thebelongs_toandcreated_bydescriptions no longer repeat the deprecation notice, which now renders on its own with its sunset date.
Affected Endpoints
POST /v1/accountsPOST /v1/agreementsPOST /v1/journalsGET /v2/events/admin-actions