Learn how API versions are managed for stable and reliable integrations
SingleView Open Banking APIs follow a structured versioning strategy to ensure stability, backward compatibility, and a smooth integration experience for developers. Versioning allows us to introduce improvements, enhancements, and new features while maintaining compatibility with existing integrations.
v2. All the product releases for this version will adopt the v2 standard, and their endpoints will be prefixed accordingly.API Archives.SingleView uses URI-based versioning to manage API versions.
Each version is included in the API base path and is structured as
https://
{{Domain}}/{{Version}}/api/observice/{{Service/Use Case Name}}
This approach ensures that applications can continue using a specific version of the API without being affected by future updates.
Whenever possible, updates are introduced in a way that maintains backward compatibility.
Examples of backward-compatible changes include:
These updates do not require changes to existing integrations.
When changes affect existing functionality, a new API version is released.
Examples of breaking changes include:
In such cases, the updated functionality will be introduced in a new version, allowing existing integrations to continue operating on the previous version.
Each API version follows a defined lifecycle:
Stage | Description |
|---|---|
Active | Fully supported version recommended for integrations |
Deprecated | Older version scheduled for retirement |
Retired | Version no longer supported |
Developers are encouraged to migrate to the latest supported version to benefit from new features and improvements.
All version updates and changes are communicated through the Changelog section of the documentation.
The Changelog provides information on:
To ensure long-term compatibility:
If you have questions regarding API versioning or migration between versions, contact us at info@onesingleview.com