Versioning

How the ComplyAdvantage Mesh API is versioned

A new version of an API endpoint is released whenever a new backwards incompatible change is released.

Backwards-compatible changes

We consider the following changes as backwards compatible:

  • New API endpoints
  • Addition of a response body where none was present before
  • Addition of optional or read-only fields/properties
  • Reordering of fields in the JSON structure
  • Incorporation of new HTTP headers
  • Adding new values to an enum
  • Integration of additional HTTP methods into existing resources