For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Getting Started
    • Introduction
    • How Verifa Works
    • Quickstart
    • Choosing an Integration Method
  • Use Cases
    • KYC Onboarding
    • Age Verification
    • AML Compliance
    • Fraud Prevention
    • Marketplace Trust & Safety
  • Core Concepts
    • Overview
    • Sessions
    • Verifications & Checks
    • Workflows
    • Identities
    • Cases
    • Screening & Reports
    • Lists
  • Integration Guides
    • Overview
    • JavaScript SDK
    • Web Capture Flow
    • API-Only Integration
    • Mobile SDK
    • Webhooks Guide
    • MCP Server
    • Migrating from Persona
  • API Details
    • Overview
    • Authentication
    • Pagination
    • Rate Limiting
    • Versioning
    • Errors
    • Webhooks
    • Idempotency
    • Key Inflection
    • Data Access
    • Data Retention
  • Tutorials
    • Creating Your First Verification Session
    • Creating a Workflow
    • Receiving Webhooks & Validating Signatures
    • Handling Webhook Events
    • Custom Document Types & AI Extraction
  • Best Practices
    • Testing
    • Preventing Duplicates
    • Fraud Signals
    • Changelog
  • API Reference
On this page
  • Setting the version
  • Version lifecycle
  • Current version
  • Related
API Details

Versioning

Was this page helpful?
Previous

Errors

Next
Built with

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.

Related

  • Key Inflection — Control response JSON key casing
  • Errors — Error codes including version-related 400 responses
  • Authentication — API key setup and version pinning