---
title: "Get extraction status"
method: GET
path: "/api/v1/external/shipments/{shipmentId}/documents/{documentId}/extraction"
tags: ["Documents"]
---

# Get extraction status

`GET /api/v1/external/shipments/{shipmentId}/documents/{documentId}/extraction`

## Request

- Base URL: `https://api.wove.com`
- URL: `https://api.wove.com/api/v1/external/shipments/{shipmentId}/documents/{documentId}/extraction`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/wove/apis/wove-external-api/docs/api/v1/external/shipments/:shipmentId/documents/:documentId/extraction/get.ts> (a function with typed inputs; its response is checked against the schema)

Get the extraction status and results for a document.

## Path parameters

- `shipmentId` string, required
- `documentId` string, required

## Response `200`

Extraction status retrieved successfully

- object
  - `success` boolean
  - `data` object
    - `status` 'pending' | 'processing' | 'completed' | 'failed'
    - `extractedData` object
    - `confidence` number
    - `extractedAt` string, date-time
    - `extractionMethod` string

---

[API](https://skmtc.dev/wove/apis/wove-external-api.md) - [All operations](https://skmtc.dev/wove/apis/wove-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wove/apis/wove-external-api/revisions/37290e267e07?raw)
