> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.withverifa.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withverifa.com/_mcp/server.

# Create a document fingerprint

POST https://api.withverifa.com/api/v1/documents/fingerprints
Content-Type: application/json

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`).


Reference: https://docs.withverifa.com/api-reference/documents/create-document-fingerprint

## Authentication

- `X-API-Key` header (required) — Organization API key. Keys are prefixed with `vk_live_` (production) or `vk_sandbox_` (sandbox).

## Request

### Headers

- `Idempotency-Key` (string, optional) — Unique key for idempotent requests. Cached for 24 hours. Sending the same key with different parameters returns `422`.
- `Verifa-Version` (date, optional) — API version date string (e.g. `2026-02-01`). If omitted, the version pinned to your API key is used.

### Body (application/json)

This endpoint expects an object.

- `fingerprint_hash` (string, required) — Cryptographic hash of the document.
- `fingerprint_type` (string, optional) — Type of fingerprint algorithm (e.g. sha256, phash).
- `source` (string, optional) — Source or reason this fingerprint was added.
- `reason` (string, optional) — Human-readable reason for flagging this fingerprint.
- `metadata` (map from string to any, optional) — Arbitrary key-value metadata.

## Response

### 201

Document fingerprint created.

- `id` (string, required) — Fingerprint record ID.
- `fingerprint_hash` (string, required) — Cryptographic hash of the document.
- `fingerprint_type` (string, required) — Type of fingerprint algorithm (e.g. sha256, phash).
- `is_active` (boolean, required) — Whether this fingerprint is actively being matched.
- `flagged_at` (datetime, required) — Timestamp when this fingerprint was created.
- `org_id` (string, optional, nullable) — Organization ID (null for global fingerprints).
- `source` (string, optional, nullable) — Source or system that added this fingerprint.
- `source_document_id` (string, optional, nullable) — Document ID that generated this fingerprint, if any.
- `reason` (string, optional, nullable) — Human-readable reason for flagging.
- `metadata` (map from string to any, optional) — Arbitrary key-value metadata.
- `created_by` (string, optional, nullable) — User or API key that created this fingerprint.

## Errors

### 400 Bad Request Error

Invalid request parameters.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 401 Unauthorized Error

Missing or invalid API key.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 422 Unprocessable Entity Error

Request validation failed.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

## Examples

**Request**

```json
{
  "fingerprint_hash": "string"
}
```

**Response**

```json
{
  "id": "string",
  "fingerprint_hash": "string",
  "fingerprint_type": "string",
  "is_active": true,
  "flagged_at": "2024-01-15T09:30:00Z",
  "org_id": "string",
  "source": "string",
  "source_document_id": "string",
  "reason": "string",
  "metadata": {},
  "created_by": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.withverifa.com/api/v1/documents/fingerprints"

payload = { "fingerprint_hash": "string" }
headers = {
    "X-API-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.withverifa.com/api/v1/documents/fingerprints';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"fingerprint_hash":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withverifa.com/api/v1/documents/fingerprints"

	payload := strings.NewReader("{\n  \"fingerprint_hash\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.withverifa.com/api/v1/documents/fingerprints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fingerprint_hash\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.withverifa.com/api/v1/documents/fingerprints")
  .header("X-API-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fingerprint_hash\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.withverifa.com/api/v1/documents/fingerprints', [
  'body' => '{
  "fingerprint_hash": "string"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.withverifa.com/api/v1/documents/fingerprints");
var request = new RestRequest(Method.POST);
request.AddHeader("X-API-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"fingerprint_hash\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-API-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["fingerprint_hash": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.withverifa.com/api/v1/documents/fingerprints")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```