API ReferenceDocuments

Create a document fingerprint

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

Required scope: documents:write

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