API Details

Versioning

Verifa uses date-based API versioning. Each version is identified by a release date (e.g. 2026-02-01).

Setting the version

Pass the Verifa-Version header to pin your request to a specific API version:

$curl https://api.withverifa.com/api/v1/sessions \
>  -H "X-API-Key: vk_live_your_key_here" \
>  -H "Verifa-Version: 2026-01-01"

If the header is omitted, the version pinned to your API key at creation time is used. This ensures your integration stays stable even as new versions are released.

Version lifecycle

  • Active — Fully supported, receives bug fixes.
  • Deprecated — Still functional but no longer receives updates. Migrate to a newer version.
  • Retired — Requests return 400 with an upgrade message.

We provide at least 12 months notice before retiring an API version.

Current version

The current API version is 2026-01-01.