---
title: "Status of an extraction job and, once finished, its result"
method: GET
path: "/extractions/{jobId}"
---

# Status of an extraction job and, once finished, its result

`GET /extractions/{jobId}`

## Request

- Base URL: `/api/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/extractions/{jobId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/cdc/apis/zia-translation-service/docs/extractions/:jobId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `jobId` string, required

## Response `200`

Status of the job; `Retry-After` is set while it is `PENDING` or `RUNNING`

- ExtractionJob
  - `jobId` string, required
  - `status` 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED', required
  - `submittedAt` string, date-time
  - `result` ExtractionResponse
    - `profile` string
    - `documentType` string: Free classification of the document (informative)
    - `pages` PageClassification[]: Classification of each page of the file, present when the pages are classified (unclassified pages are absent). The fields and collection rows then come from the `MAIN` pages only.
      - `page` integer, required: 1-based page of the file
      - `documentRole` 'MAIN' | 'SUPPORTING' | 'OTHER', required: `MAIN`: page of the invoice addressed to the insurance or to the insured person (source of the values); `SUPPORTING`: supporting document (e.g. invoice of a manufacturer addressed to the provider); `OTHER`: blank page, separator, unreadable page.
      - `documentType` 'FORM' | 'INVOICE' | 'CREDIT_NOTE' | 'REMINDER' | 'QUOTE' | 'PRESCRIPTION' | 'REPORT' | 'COVER_LETTER' | 'POWER_OF_ATTORNEY' | 'OTHER': Generic type of the document the page belongs to
      - `formId` string: Identifier printed on a form (e.g. `300.001`), when the page belongs to a form
      - `confidence` number, double
      - `evidence` string: Text that justifies the classification (title, recipient...)
    - `fields` object: Values found, by key; a key that was not found is absent
    - `collections` object: Rows of each requested collection (row = values by field name)
    - `warnings` string[]
  - `error` object
    - `code` 'UNREADABLE_DOCUMENT' | 'EXTRACTION_FAILED' | 'INTERNAL_ERROR'
    - `message` string

## Other responses

- `404`: Unknown or expired job

## Changes

- **2026-10-23** `17816f6177b4`: 1 info
  - added the optional property `result/pages` to the response with the `200` status
- **2026-10-23** `db02012fc3ba`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cdc/apis/zia-translation-service/changes/extractions/:jobId/get.md)

---

[API](https://skmtc.dev/cdc/apis/zia-translation-service.md) - [All operations](https://skmtc.dev/cdc/apis/zia-translation-service/llms.txt) - [OpenAPI document](https://skmtc.dev/cdc/apis/zia-translation-service/revisions/17816f6177b4?raw)