Flag a document as compromised

Creates a fingerprint for the document and marks it as compromised. Future sessions submitting a document with the same fingerprint will be automatically flagged.

Required scope: documents:write

Authentication

X-API-Keystring

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

Path parameters

document_idstringRequired

Document ID (doc_*).

Request

This endpoint expects an object.

reasonstringOptional

Human-readable reason for flagging this document.

sourcestringOptional

Source or system that detected the compromise.

Response

Document flagged as compromised.

document_idstring

fingerprint_idstring

fingerprint_hashstring

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://devapi.withverifa.com/api/v1/documents/document_id/flag-compromised \
>	-H "X-API-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

$	curl -X POST https://devapi.withverifa.com/api/v1/documents/document_id/flag-compromised \
>	-H "X-API-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

Flag a document as compromised

Authentication

Path parameters

Headers

Request

Response

Errors

Authentication

Path parameters

Headers

Request

Response

Errors

1	{
2	"document_id": "string",
3	"fingerprint_id": "string",
4	"fingerprint_hash": "string"
5	}