API reference

The result format. The public API is not open yet.

Status

Note. The public API is not open yet. This page documents the result format it will return, which is the same JSON the demo shows in its JSON tab.

Method	Path	Purpose
POST	/v1/documents/checks	Create a check
GET	/v1/documents/checks/{id}	Get a result
GET	/v1/documents/checks	List checks
DELETE	/v1/documents/checks/{id}/file	Delete the stored file
POST	/v1/documents/checks/{id}/feedback	Mark as fraud or genuine
GET	/v1/signals	Signal catalog

Requests will authenticate with Authorization: Bearer fw_live_... keys. Test keys (fw_test_...) will return canned results without using credits.

Field	Type	Description
id	string	Prefixed ID, for example chk_01JC8Z6W3T9Q
status	string	queued, processing, completed, or failed
tier	string	standard or deep
verdict	string	ai_generated, likely_tampered, needs_review, or no_issues_found
risk_score	integer	0 to 100
summary	string	One or two sentences
signals	array	Signals that fired, strongest first
extracted	object	Fields read from the document
document	object	File name, type, SHA-256, pages, declared and detected type, metadata
engine_version, ruleset_version	string	What produced the result
checks_run, checks_failed	array	Layers that ran, and checks that could not

Field	Type	Description
id	string	Signal ID, see the signals reference
layer	string	provenance, structure, pixel, content, or history
severity	string	info, low, medium, high, or critical
weight	number	-100 to 100; negative lowers the score
confidence	number	0 to 1
title, description	string	Plain-English explanation
evidence	object	Structured details, such as the expected and printed totals
page, bbox	integer, array	Where on the page: [x0, y0, x1, y1] in analysis pixels (PDF pages are rendered at 200 DPI)