Anton.Docs
Dashboard (opens in a new tab)

Export case files and evidence

Every export is an audited event of its own, so a retry is a second export and not a replay.

A case file is one review's formal record as a PDF, for your own auditors and regulators. It is rendered when you ask and never stored. Each call is recorded in your audit log, and once more when the file is rendered, with its size and a SHA-256 of the file.

Before you begin

Export a case file

GET/v1/intelligence/reviews/{id}/case-fileExport a case file

The response is application/pdf, with an X-Export-Id header.

Reference
Not yet tested in sandbox
curl https://api.antonpayments.dev/v1/intelligence/reviews/irv_dbvqsbiukoh4g0rnek30/case-file \
  -H "Authorization: DPoP $ANTON_ACCESS_TOKEN" \
  -H "DPoP: $DPOP_PROOF"

X-Export-Id is the export's reference in your audit log. Keep it beside the file. The export works for any review your account holds, whatever its status.

There is no Idempotency-Key on an export, because each call is a separate audited export. Retrying is safe but it logs another one.

What an API export leaves out

A case file exported with an API credential never contains note text or the names of your team members. Your people get notes in the case files they export from the portal. If an auditor needs the notes, export from the portal.

Export reviews as CSV

GET /v1/intelligence/reviews/export returns reviews opened in [created_after, created_before) as CSV, with codes, ids and the masked subject only. Both bounds are required, RFC 3339 UTC with milliseconds and a Z, and the range is at most 366 days. status narrows it. The audit log records the range, the row count and the file's SHA-256, and the response carries the same X-Export-Id.

An export that would pass 10,000 reviews is 422 export_too_large. Narrow the range and export in pieces.

Retention

Review records are kept for 7 years by default. The period can be extended, beyond 7 years with the Audit Pack, and never shortened. GET /v1/intelligence/reviews/settings shows retention_years.

When it goes wrong

422case_file_too_large
The case file is too large to render as one PDF.
422export_too_large
The CSV would pass 10,000 reviews. Narrow the date range.
422invalid_export_range
The range is not valid, for example longer than 366 days.
403module_not_enabled
The account lacks the Audit Pack.
403insufficient_scope
The credential was created without the intelligence scope. A missing account capability is capability_required.
404resource_missing
The review does not exist, or belongs to another account.

Next

Something wrong or missing here? Open an issue (opens GitHub in a new tab) ↗