Migration Notes

This page records breaking changes and migration steps for each major version.

v2.x → Current (v2.x)

No breaking changes within v2. Follow the standard upgrade procedure.

v2.0 is a major version with breaking changes. Read the full migration guide before upgrading a production deployment.

Area	Change
SDK `DeploymentMode`	`Mode.Hybrid` renamed to `Mode.EnterpriseHybrid`. Update all SDK configurations.
Ingest API	`POST /v1/ingest/session` — the `metadata.tags` field changed from `string[]` to `Record<string, string>`. Update your SDK to v2+ before migrating the API.
Database schema	`sessions` table adds a non-null `schema_version` column with default `2`. Migration script `migrations/v2_upgrade.sql` populates this for existing rows.
Environment variables	`HYBRID_MODE_ENDPOINT` renamed to `VERIPROOF_COMMITMENT_ENDPOINT`. Update Function App settings before deploying v2 code.

Update the VERIPROOF_COMMITMENT_ENDPOINT environment variable on both Function Apps (rename from HYBRID_MODE_ENDPOINT)
Apply the schema migration: psql ... -f migrations/v2_upgrade.sql
Update your AI application’s SDK to v2.x and change DeploymentMode.Hybrid to DeploymentMode.EnterpriseHybrid
Deploy the v2 Function Apps
Deploy the v2 SPA
Validate with GET /v1/system/health — response will include "schemaVersion": 2

v0.x was a preview release. Contact your Veriproof account manager for v0 → v1 migration assistance if needed.