Skip to content

Versioning and deprecation

The Evaluate endpoint is currently published under /v1.

  • Parse the documented fields you use and ignore unknown response fields.
  • Do not depend on JSON property order.
  • Do not hard-code a tenant-wide rule catalog; enabled rules and actions can vary.
  • Treat a field-type change, field removal, authentication change, or settlement-semantics change as breaking.

Breaking changes require a new versioned contract or an explicitly coordinated migration. Clients should tolerate additive optional response fields, fail safely on unexpected enum values, and surface them for review. Your integration agreement governs whether a particular change is considered compatible.

Public contract changes are recorded in the API changelog. Integration-specific timelines and notice periods are coordinated through the institution’s Vantrace onboarding and support channel. Do not assume a deprecation period that is not stated in your integration agreement.

The public contract does not currently promise Deprecation, Sunset, or Link response headers. Follow the changelog and your integration communication channel until those headers are documented.