API

Bring authenticity review into your own systems

A small REST surface for submitting content, following analysis and pulling back structured evidence — including the limitations statement that must travel with every result.

Endpoints

  • POST/v1/scans

    Create a scan from pasted text or an uploaded file.

  • GET/v1/scans/:id

    Retrieve status, likelihood ranges, confidence and flagged passages.

  • GET/v1/scans

    List scans for the organization with filters and pagination.

  • POST/v1/scans/:id/case

    Set case status and attach an internal reviewer note.

  • GET/v1/reports/:id

    Download a generated report as PDF or JSON.

  • GET/v1/usage

    Return scan, storage and API consumption for the billing period.

curl https://api.tracemark.example/v1/scans \
  -H "Authorization: Bearer $VERIAI_API_KEY" \
  -F "file=@submission.pdf" \
  -F "workspace=northfield-english"

{
  "id": "SC-4821",
  "status": "queued",
  "engine": "not_connected",
  "notice": "Detection engine unavailable in this build"
}
Demo

The API surface is documented here as the target contract. No live endpoint is available until a detection backend is connected.

Operations

Predictable behaviour

Keyed per workspace

Keys are scoped to one organization workspace and can be rotated or revoked instantly.

Rate limited

Per-plan limits with clear headers, so batch jobs can back off cleanly.

Auditable

Every API call appears in the organization audit log with the key that made it.