GuidesVersioning
Guides

Versioning

Understand Deepvue API versioning, differences between V1 and V2 endpoints, and how to migrate to newer versions.

Overview

Deepvue uses URL-based versioning for its APIs. The version is included in the endpoint path (e.g., /v1/ or /v2/). When a new version of an endpoint is released, the previous version continues to work — allowing you to migrate at your own pace.

Version format

https://production.deepvue.tech/{version}/{endpoint}
VersionStatusDescription
v1StableOriginal release — fully supported
v2StableEnhanced version with improved response data or simplified flows
v3StableLatest version available for select endpoints

Migration guidelines

Check version differences

Review the comparison tables above and the API reference for the specific endpoint. Pay attention to changes in request parameters, response structure, and required headers.

Update your endpoint URLs

Change the version prefix in your API calls from /v1/ to /v2/ (or the appropriate version).

- https://production.deepvue.tech/v1/verification/pan-plus
+ https://production.deepvue.tech/v2/verification/pan-plus

Update your response parsing

Newer versions may return additional fields or restructure existing ones. Update your response parsing logic to handle the new format.

Test with your credentials

Test the updated endpoint with your production credentials. Deepvue does not have a separate sandbox — your trial or live keys work with all API versions.

Both old and new versions use the same authentication. No credential changes are needed when migrating.

Deprecation policy

  • Deepvue does not currently deprecate older API versions. V1 endpoints continue to function alongside V2 and V3.
  • If an API version is ever scheduled for deprecation, affected customers will be notified via email with at least 30 days advance notice.
  • Monitor the Deepvue Dashboard and documentation for version-related announcements.