Changelog

​

Redesigned order quote responses

• POST /accounts/{account_id}/order-quotes no longer returns a single generic OrderQuote object. It returns a union discriminated on quote_type, with one variant per instrument and order mode: amc_market_cash, bill_market_cash, bond_fixed_coupon_market_cash, bond_zero_coupon_market_cash, etf_market_cash, etf_limit_cash, etf_market_quantity, etf_limit_quantity, mmf_market_cash, or sell. Switch on quote_type before reading a quote.
• The flat economics fields moved under an estimate object and dropped the estimated_ prefix: estimated_price, estimated_quantity, and estimated_cash are now estimate.price, estimate.quantity, and estimate.cash. fees, net_cash_amount, max_cost, and min_proceeds moved under estimate too. Each variant only carries the fields that apply to it.
• instrument is now the full instrument object instead of an ID string.

• order_type on every variant, indicating whether the quote is for a market or limit order.
• currency on every variant.
• Instrument-specific economics in estimate: yield, annual_income, and accrued_interest for fixed income, plus notional, cost, price_buffer_percentage, and asof where they apply.
• reservation object on every variant with what a placement would set aside: a cash amount vs a unit quantity (amount, denomination).
• created_at on every variant.

​

Enhanced idempotency key error handling

• idempotency_key_conflict error code when the Idempotency-Key was already used for a resource outside the scope of this request.
• idempotency_key_expired error code when the Idempotency-Key was already used, and the resource it created is older than the replay window.

​

Fee charge collection tracking and earnings breakdowns

• collected_amount on Retrieve a fee charge for the cash collected so far.
• outstanding_amount on Retrieve a fee charge for what’s still owed on the charge.
• collections array on Retrieve a fee charge with a history of collection events per fee charge.
• gross_capital on earnings responses for capital gains before fees and taxes.
• gross_income on earnings responses for income earnings before fees and taxes.

​

Document references and confirmation type

• reference on List account documents responses for the order or object the document evidences (order ID for confirmations, null for period documents).
• order_confirmation on DocumentType for account document requests and responses.
• position_not_open error code when you try to update a closed or closing position.

​

Fixed-income instrument schema updates

• Removed par_value from Bill responses. par_value is still present on Bond instruments.

​

Enhanced fund details and fee variant support

• New fields on ETF instrument responses: display_name, headline, currency_sentence, rhp_years, and fund_base_currency.
• Retrieve a fee endpoint to look up a specific fee by ID, including its variants.
• variants array on Fee objects containing scoped fee variants per instrument, instrument type, portfolio type, or transaction type.

​

OAuth token endpoint RFC 6749 compliance

• 401 Unauthorized response for client authentication failures on Issue an OAuth token, with an OAuthErrorBody payload following RFC 6749 §5.2.

• 400 Bad Request response on POST /auth/token now uses OAuthErrorBody schema with error and error_description fields (RFC 6749 §5.2) instead of the standard error envelope.

​

Permissions and reference expansion

• List permissions to retrieve effective permissions for the authenticated actor, including scope and conditional details.
• portfolio_transfer enum value on reference types for tracking portfolio transfers.

​

Identify the end person on each request

• Person-Id request header for our person ID (per_…) you’re acting on behalf of. Send this whenever the request concerns an end person. See Attribution.
• Optional Client-User-Id request header for your own identifier of the same end user, for log correlation and support.
• Error codes person_id_too_long and client_user_id_too_long when either header exceeds 255 characters.

​

Fixed person reads

• Retrieve a person no longer returns 500 when optional person columns are null in storage.

​

More reliable valuation

• trading_increment on instrument responses.

• GET /accounts/{account_id}/valuation uses the latest price per timestamp across providers.

• Unrealized earnings percentage on GET /accounts/{account_id}/earnings no longer errors on zero cost basis.

​

On-the-run bills and fixed-income pricing detail

• GET /bills/otr to retrieve the on-the-run bill matrix for an issuer country. Periods with no matching bill are omitted.
• ETF as an instrument type on List instruments and Retrieve an instrument.
• accrued_interest on GET /prices responses.
• next_coupon_date on fixed income instruments.

​

Person creation and claim history

• Create a person to create a person from claims with verification evidence. See Persons.
• joint_customer as a customer type on Retrieve a customer.
• archived_at and lifecycle on person claim responses.
• Idempotent onboarding submissions: a duplicate pending Submit an onboarding application returns 409 conflict.

• List claims for a person now defaults to include_history=true (full audit trail, newest first). Pass ?include_history=false to collapse to the current pending and verified row per claim type. See Claims.

​

Events, legal documents, and lifecycle webhooks

• GET /legal-documents and related version and file download endpoints.
• Retrieve a person claim.
• Webhook event types delivered to your registered endpoints: order.placed, order.pending, order.executing, order.filled, order.settled, order.cancelled, trade.executed, trade.settled, position.opened, position.closing, position.closed, account.opened, account.suspended, account.activated, account.closing, account.closed, and customer.closed. See Webhooks.

• POST /auth/token accepts only the client_credentials grant.
• purpose is required on POST /signed-uploads.

​

Event reads and webhook delivery

• List events for tenant-scoped event reads.
• Automatic webhook delivery with retries for subscribed event types. See Deliveries.

​

Initial API release

• Authentication with bearer tokens. See Authentication.
• Onboarding for persons, claims, and applications. See Onboarding.
• Trading, holdings, valuation, and payments endpoints across accounts.
• Webhooks with at-least-once delivery, signature verification, and automatic retries. See Webhooks.
• Idempotency support for write requests. See Idempotency.