> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getclean.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> getclean's own MCP server is at https://mcp.getclean.ai/mcp. The /mcp path of this docs site is Mintlify's search over these pages, not getclean.
> Every answer of the API opens with outcome. A page that could not be read is a record whose outcome says why, never an HTTP error; read outcome before anything else.
> The API's contract is the OpenAPI 3.1 file at https://docs.getclean.ai/openapi.yaml; the SDKs are generated from it.
> The product's name is written getclean, in lower case.

# Scanned claim files with a confidence on every value

> Upload a scanned claim file and get your fields filled from it. Each value comes with the words it was read from, its page, and a number for how sure the reading is, so a person checks only the values that need it.

A claims handler gets a file of 80 scanned pages: a claim form, 3 invoices, a police report, and a photo of a receipt. A tool reads the total of an invoice as 1,800 where the paper says 7,800, and nothing marks that number as less certain than the others. This page builds an intake in which each value comes with the words it was read from and a number for how sure the reading is. A person then checks the few values that need it, and not all 200.

## The run in 4 steps

### Upload the file with your fields

Send the file once, with the fields of your claim system as a template. Name the language of the scan, which helps the recognition.

```json Fields sent with the file to upload_contents theme={"theme":"css-variables"}
{
  "json_schema": {
    "type": "object",
    "properties": {
      "policy_number": { "type": "string" },
      "date_of_loss": {
        "type": "string",
        "description": "The day the damage happened, as the claim form states it"
      },
      "cause_of_loss": {
        "type": "string",
        "description": "What caused the damage, in the words of the claim form"
      },
      "invoice_total": {
        "type": "string",
        "description": "The total of the repair invoice, with its currency"
      },
      "police_report_number": { "type": "string" }
    }
  },
  "recognition_languages": ["de"],
  "max_characters": 0
}
```

### Follow the job

A scan of 80 pages is read as a job, page by page. The job says how far it is: how many pages are read, how many failed, and how many remain. With `wait` set, the SDKs follow the job and return the record when it is done.

A page is not lost if the job ends early. A job that a spending limit or its time limit stops returns the pages read so far, and its outcome says that the record is partial.

### Read each value with its confidence

Each field of your template comes back with a status. This response is cut to the status, the words, the confidence, and the page of each field.

```json Part of the response theme={"theme":"css-variables"}
{
  "schema_statuses": {
    "/policy_number":        { "status": "found", "text": "Versicherungsschein-Nr. 48 2291 7730", "confidence": 0.98, "page_number": 1 },
    "/date_of_loss":         { "status": "found", "text": "Schadentag: 14.03.2026", "confidence": 0.96, "page_number": 1 },
    "/cause_of_loss":        { "status": "found", "text": "Leitungswasserschaden im Keller", "confidence": 0.93, "page_number": 2 },
    "/invoice_total":        { "status": "found", "text": "Gesamtbetrag 7.800,00 EUR", "confidence": 0.61, "page_number": 12 },
    "/police_report_number": { "status": "unread" }
  }
}
```

Of the 5 fields, 3 were read with a confidence over 0.9, and your system takes them. The total of the invoice was read with 0.61, so it goes to a person. The number of the police report is `unread`: it could be on a page that was not read well, so the file is not marked as "no police report".

### Show a person the page, not the file

Each scanned page comes with a picture of it. The handler sees the picture of page 12 beside the words "Gesamtbetrag 7.800,00 EUR", confirms the amount, and goes on. Of 80 pages, a person looks at the few that need it.

## What the claims auditor can check

| The claims auditor asks | What the intake has |
| - | - |
| Where was this amount read from? | The words as recognized, with their page. |
| How sure was the reading? | A confidence for each value, each block, and each page. |
| Which values did a person confirm? | Your own log: the values under your bar went to a person. |
| Was the whole file read? | The count of pages read, and each page that failed. |

## Know the limits

A model fills the fields, and each value is bound to words of the file. The confidence is about the recognition of those words. It is not a measure of whether the model chose the right words for the field.

Handwriting comes as flat text or not at all, and no notice says so. A claim form that is filled in by hand needs a person.

The tables of a scan come as text, so the lines of an invoice are not cells.

A photo is read as one scanned page.

For the calls, see [Turn PDFs, Office files, and scans into evidence you can cite by page](https://docs.getclean.ai/read/pdfs-scans-and-documents.md) and [Fill your fields, each with the words it came from](https://docs.getclean.ai/read/extract-fields-with-citations.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.