API Versioning
The Digits Connect API uses route-based versioning with the version number as a URL path prefix.
During the initial API preview, we may make breaking changes to our schema in response to feedback
Our API will be locked in place when we launch app approval submissions later this year.
Version Strategy
Backwards-compatible changes will be applied to existing versions without a version change:
- Adding new optional fields to request/response objects
- Adding new endpoints
- Adding new optional query parameters
Backwards-incompatible changes will be made in new versions:
- Removing or renaming fields
- Changing field types or formats
- Modifying required fields
- Changing endpoint behavior
Migration
As endpoints are promoted beyond /v1, multiple versions will be supported during a transition period to allow developers time to migrate. Deprecated endpoints will include sunset timelines in response headers and documentation.
Updated 3 days ago