Export to JSON

A JSON export profile turns a finished transaction into a single structured document: the extracted fields with their confidence and review state, per-field bounding boxes, a per-page block that carries everything needed to place coordinates back onto the original page, and the transaction's metadata. It is the recommended way to feed results into another system, including a custom review (human-in-the-loop) client.

To produce it, add an Export activity to your workflow with a JSON profile, then retrieve the output (see Accessing OCR & Field Data for the API calls).

Options

Configured on the JSON profile (see the Export activity for the full table):

Field Filter (default all fields): export all fields, or only an included set, or everything except an excluded set. Fields are named by their display path with / for nesting: Supplier/Name for a group child, Line Items/Description for a repeating-group column. See Filtering fields.
Include Field Details (default on): keeps confidence, reasoning, confirmation state, and bounding boxes alongside each value. Turn off to keep just the value, the simplest way to shrink the file.
Include Page Full Text (default off): each page's OCR text.
Include Page OCR Data (default off): word-level OCR layout.
Pretty Print (default on): indented, readable JSON. Turn off for a compact, single-line file.
Exclude JSON Paths (advanced): strip specific branches from the finished file by path. See Reducing file size.

The per-page block and the transaction metadata are always included and have no toggle.

The coordinate contract

Every bounding box in the export, both field boxes and OCR word boxes, is expressed in the rasterized page-image pixel space with a top-left origin. This is the same image the platform ran OCR on, which you can export as a JPG profile alongside the JSON. A box therefore drops directly onto that page image with no conversion.

To place a coordinate onto the original page instead (for example the source PDF), use the page's image_transform block:

original_coordinate = rasterized_coordinate / render_scale

Output structure

{
  "transaction_id": "…",
  "tenant_id": "…",
  "project_id": "…",
  "transaction": {
    "exported_at": "…",
    "status": "…",
    "created_at": "…",
    "source_file_names": ["invoice.pdf"],
    "metadata": { "customer_ref": "ACME-42", "cost_center": "EU-1" }
  },
  "documents": [
    {
      "document_id": "…",
      "document_type": "invoice",
      "classification_confidence": 0.97,
      "fields": {
        "invoice_number": {
          "value": "INV-1001",
          "confidence": 0.99,
          "reasoning": "Found under INVOICE NO. label",
          "is_confirmed": true,
          "bounding_boxes": [
            { "coordinates": [10, 10, 100, 30], "page_index": 1 }
          ]
        }
      },
      "pages": [
        {
          "page_number": 1,
          "transaction_page_number": 1,
          "source_filename": "invoice.pdf",
          "source_file_page_number": 1,
          "image_transform": {
            "rasterized_width": 2480,
            "rasterized_height": 3508,
            "source_width": 595.32,
            "source_height": 841.92,
            "source_unit": "point",
            "render_scale": 4.166,
            "effective_dpi": 300.0,
            "coordinate_system": "top-left-origin",
            "rotation": 0
          }
        }
      ]
    }
  ]
}

Fields

Each field carries its value and, when Include Field Details is on, confidence, reasoning, is_confirmed, and a bounding_boxes list of where the value was found. Groups and repeating groups nest the same shape under value.

bounding_boxes[].coordinates: [x1, y1, x2, y2] in rasterized pixels (top-left, bottom-right).
bounding_boxes[].page_index: the 1-based page number the box belongs to, matching page_number in the pages array.

Pages

Each page records how it maps to its source file and, in image_transform, the frame for mapping coordinates:

Field	Meaning
`rasterized_width` / `rasterized_height`	Pixel size of the OCR'd image. This is the coordinate space of every bounding box.
`source_width` / `source_height`	Original page size. For PDF sources this is in points (1/72 inch); for image sources it is the source image's pixels.
`source_unit`	`point` (PDF source) or `pixel` (image source).
`render_scale`	Rasterized pixels per source unit, the same on both axes. Divide a coordinate by this to reach the source page.
`effective_dpi`	`render_scale x 72` for PDF sources, or `null` for image sources. This is the true scale, and is more reliable than any nominal DPI because pages are normalized during rasterization.
`coordinate_system`	Always `top-left-origin`.
`rotation`	Display rotation in degrees clockwise, applied after OCR. Exported coordinates are pre-rotation, so apply this yourself if you render the rotated view.

Page OCR (optional)

With Include Page Full Text, each page gains a full_text string. With Include Page OCR Data, each page gains an ocr block:

"ocr": {
  "language": "en",
  "detected_language": "en",
  "words": [
    { "text": "INV-1001", "bounding_box": [10, 10, 100, 30], "confidence": 0.99 }
  ]
}

OCR word boxes use the key bounding_box and, like field boxes, are in rasterized pixel coordinates.

Transaction

The transaction block is always present. Alongside exported_at and status, it carries the transaction's own record: created_at, source_file_names, a timing summary, and a metadata object. The metadata object holds the key-value pairs supplied when the transaction was created (through the upload form or the API), so any reference your system attached, such as an order number or a customer id, comes back with the results. Platform-internal keys are filtered out.

Filtering fields

By default every extracted field is exported. The Field Filter narrows that set:

Include only exports just the listed fields and drops the rest.
Exclude exports everything except the listed fields.

Fields are named by their display path, using / for nested fields. This is the same filter used by every format (JSON, XML, CSV, Excel):

Path	Selects
`Invoice Number`	A top-level field.
`Supplier/Name`	The `Name` child inside the `Supplier` group.
`Line Items/Description`	The `Description` column of the `Line Items` repeating group, in every row.
`Supplier`	The whole `Supplier` group and all of its children.

Matching is case-insensitive, and a field's id also matches (so older profiles that listed field ids keep working). Naming a parent includes or excludes its entire subtree. Naming only children keeps the parent as a container holding just those children.

Reducing file size

Large exports are usually dominated by per-field metadata and OCR layout. In order of impact:

Turn off Include Field Details removes confidence, reasoning, confirmation state, and bounding boxes from every field, leaving just values. This is the single biggest reduction.
Field Filter drops fields you do not need at all.
Turn off Include Page OCR Data and Include Page Full Text if you do not use the word-level layout or page text.
Exclude JSON Paths removes specific branches from the finished file by path, one per line, with * as a wildcard. It runs last, after every other option, so it can reach anything in the output:
```
documents.*.fields.*.reasoning
documents.*.pages.*.ocr
transaction.timing
```
A path that matches nothing is ignored, so it is safe to keep a standard list across profiles.

Next steps

Accessing OCR & Field Data: how to retrieve these results over the API and build your own review client.
Pair Export with a Notification step to tell an external system where to download the results.

Options​

The coordinate contract​

Output structure​

Fields​

Pages​

Page OCR (optional)​

Transaction​

Filtering fields​

Reducing file size​

Next steps​