Versioning

Path‑based versions

The API version is a prefix on every path: today that is /v1. When a new major version ships, it will live under its own prefix (for example /v2) and this documentation will gain a matching version — use the version switcher in the header to move between them.

https://api-ocr.vanguardinitiative.com/v1/ocr/scan
                                       └── version

Compatibility policy

Within a version we only make additive, backward‑compatible changes:

• New endpoints may be added.
• New fields may appear in responses.
• New optional request fields may be accepted.

We will not, within the same version, remove fields, change a field’s type, or change the meaning of an existing code. Build clients that ignore unknown fields so they keep working as the API grows.

Deprecations

When an endpoint is eventually retired in a future major version, the current version keeps working — you migrate on your own schedule by moving to the new prefix.