API reference

Evidence

Verification materials: metadata, masked preview, download.

Download evidence

POST/v1/evidence/{evidence_id}/download

Scopes
evidence:download
Required header
Idempotency-Key

Reveal of the original: a short-lived signed link (TTL in expires_at) for evidence:download with a required reason (EvidenceReveal); the audit event records the reason and digest. The link and bytes are never cached by clients.

Parameters

FieldTypeRequired
evidence_idpathstring (uuid)yes

Request bodyEvidenceReveal

FieldTypeRequired
reason_codeenum: case_review, appeal_review, quality_assurance, customer_support, legal_obligationyes

Responses

  • 200Download
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Get evidence

GET/v1/evidence/{evidence_id}

Scopes
evidence:read

Metadata of one evidence object with its transform description; no bytes.

Parameters

FieldTypeRequired
evidence_idpathstring (uuid)yes

Responses

  • 200Evidence
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Preview evidence

GET/v1/evidence/{evidence_id}/preview

Scopes
evidence:read

Low-resolution masked projection of an admitted image for evidence:read. Video, PDF, chip data, quarantined, rejected and purged objects have no preview (409).

Parameters

FieldTypeRequired
evidence_idpathstring (uuid)yes

Responses

  • 200EvidencePreview
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503