Fetch a stored scan
get_scanFetch a stored scan result by its ID to read back recognised document fields and MRZ without re-running recognition.
Instructions
Fetch the full result of one stored scan by its id, as it was returned when the document was recognised. Input: scan_id – meta.id of a scan_document result, or id of a list_scans row. Output: the same Scan object scan_document returns (meta, document, holder, fields, mrz and the rest) plus a one-line summary, with two differences: the image crops are never stored, so every images slot is null, and quality reads not_checked. Calls GET /v1/scans/{id}; it never re-runs recognition and never charges a credit. Only scans made with a live key under a non-zero retention window are stored, and only until that window ends (retain_hours on the scan, or the account's history-retention setting, one year by default); a scan made with retain_hours 0 was never stored. A key reaches its own account's scans and no other account's. Under a sandbox key – the public one or an account's own sk_sandbox_ key – nothing is stored. Errors: an id that is unknown, belongs to another account, was made with retain_hours 0 or has passed its window is refused as not_found – the cases are not told apart. Use it to read back a document recognised earlier instead of scanning the image again.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scan_id | Yes | The scan's id: meta.id of the scan_document result, or id of a list_scans row (a lower-case UUID). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mrz | Yes | ||
| meta | Yes | ||
| fields | Yes | Every field the engine extracted off the printed document, re-keyed to our vocabulary – the open set. Always present; empty when nothing was extracted. A field read in more than one language appears once per language, so `name` repeats and only `id` is unique. | |
| holder | Yes | ||
| images | Yes | ||
| quality | Yes | ||
| document | Yes | ||
| authenticity | Yes |