Stability policy

The REST API is versioned in the URL path. The current version is v1, served at https://api.optsens.com/api/v1.

What we promise within v1

• Existing response properties are not removed or renamed.
• Existing endpoint paths, parameters and authentication do not change.
• New properties, new endpoints and new optional parameters may be added at any time. Build your integration to ignore unknown properties.
• Enum values may gain new members (for example a new consent action). Treat enums as open sets.

Breaking changes

Changes that cannot be made compatibly ship as a new version under a new path (/api/v2). When that happens:

• v1 keeps working through a published sunset period.
• The changelog announces the new version, the migration steps and the sunset date, tagged breaking.

Deprecations

Deprecated properties or endpoints are marked in this reference and in the changelog before removal, and removals only happen with a version change.