Skip to content

API changelog

The Evaluate endpoint is versioned under /v1. Material changes to required fields, authentication, decision semantics, response fields, or error behavior are recorded here.

  • Updated the Evaluate authentication contract to require X-Signature-Version: v2, a current X-Timestamp, a fresh UUID in X-Request-ID, and the hex-encoded HMAC-SHA256 X-Signature.
  • Replaced the previous X-Correlation-ID guidance with the caller-generated X-Request-ID across OpenAPI, Postman, Quickstart examples, testing, and reconciliation guidance.
  • Added a copy-paste runnable five-language Quickstart.
  • Added OpenAPI and Postman downloads.
  • Added Concepts, identifier, rate-limit, production-checklist, and versioning guidance.
  • Added transaction-flow and account-mapping diagrams.
  • Reorganized navigation into Getting Started, API Reference, Guides, Production, and Resources.
  • Clarified should_block as the only synchronous settlement gate.
  • Expanded request schema tables with nullable, constraint, and default information.
  • Removed the optional account_snapshot from the minimal Quickstart payload so every language uses the same request shape.
  • Clarified that highest_severity: "low" is the baseline when no rule triggers.
  • None.
  • Published the initial public /v1/engine/evaluate developer documentation.
  • Added authentication, account mapping, data ownership, response, reliability, error, testing, and worked-example guidance.

Documentation-only corrections do not change the API version. See Versioning and deprecation for client compatibility guidance.