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
      • GETList session documents
      • POSTUpload a document to a session
      • GETDownload a document
      • GETList documents
      • POSTUpload a standalone document
      • GETGet document metadata
      • DELRedact a document
      • PATCHUpdate document metadata
      • GETDownload a document via signed URL
      • GETPreview a document page as JPEG
      • GETList document extractions
      • GETList document checks
      • POSTTrigger document classification
      • POSTTrigger document extraction
      • POSTRun verification checks on a document
      • POSTCompare two documents
      • POSTBulk classify documents
      • POSTBulk extract documents
      • POSTBulk verify documents
      • GETList document fingerprints
      • POSTCreate a document fingerprint
      • DELDelete a document fingerprint
      • POSTFlag a document as compromised
      • POSTCompare a document to a verified identity
      • POSTRun AI-powered document insights
API ReferenceDocuments

Create a document fingerprint

POST
https://devapi.withverifa.com/api/v1/documents/fingerprints
POST
/api/v1/documents/fingerprints
$curl -X POST https://devapi.withverifa.com/api/v1/documents/fingerprints \
>     -H "X-API-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "fingerprint_hash": "string"
>}'
1{
2  "id": "string",
3  "fingerprint_hash": "string",
4  "fingerprint_type": "string",
5  "is_active": true,
6  "flagged_at": "2024-01-15T09:30:00Z",
7  "org_id": "string",
8  "source": "string",
9  "source_document_id": "string",
10  "reason": "string",
11  "metadata": {},
12  "created_by": "string"
13}

Creates a new document fingerprint record. Fingerprints are cryptographic hashes used to flag known-compromised or previously-seen documents.

Required scope: settings:write (or legacy documents:write).

Was this page helpful?
Previous

Delete a document fingerprint

Next
Built with

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Headers

Idempotency-KeystringOptional<=255 characters

Unique key for idempotent requests. Cached for 24 hours. Sending the same key with different parameters returns 422.

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Request

This endpoint expects an object.
fingerprint_hashstringRequired
Cryptographic hash of the document.
fingerprint_typestringOptional

Type of fingerprint algorithm (e.g. sha256, phash).

sourcestringOptional
Source or reason this fingerprint was added.
reasonstringOptional

Human-readable reason for flagging this fingerprint.

metadatamap from strings to anyOptional

Arbitrary key-value metadata.

Response

Document fingerprint created.
idstring
Fingerprint record ID.
fingerprint_hashstring
Cryptographic hash of the document.
fingerprint_typestring

Type of fingerprint algorithm (e.g. sha256, phash).

is_activeboolean
Whether this fingerprint is actively being matched.
flagged_atdatetime
Timestamp when this fingerprint was created.
org_idstring or null

Organization ID (null for global fingerprints).

sourcestring or null
Source or system that added this fingerprint.
source_document_idstring or null
Document ID that generated this fingerprint, if any.
reasonstring or null

Human-readable reason for flagging.

metadatamap from strings to any

Arbitrary key-value metadata.

created_bystring or null
User or API key that created this fingerprint.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error