Extract an invoice or receipt - The Wo Developer Platform

POST

/

v1

/

documents

/

extract

curl --request POST \
  --url https://api.thewo.io/v1/documents/extract \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "documentUrl": "https://example.com/documents/sample-invoice.pdf"
}
'

{
  "id": "trade_document_example_01",
  "status": "completed",
  "documentType": "invoice",
  "extracted": {
    "documentNumber": "INV-2026-104",
    "issuedAt": "2026-10-19",
    "supplier": {
      "name": "Example Paper Goods",
      "taxIdentifier": "SUP-104"
    },
    "buyer": {
      "name": "Northstar Workshop"
    },
    "total": {
      "minorUnits": 245000,
      "currency": "USD"
    },
    "items": [
      {
        "description": "Workshop materials",
        "quantity": 2,
        "unitPrice": {
          "minorUnits": 1000,
          "currency": "USD"
        },
        "lineTotal": {
          "minorUnits": 2000,
          "currency": "USD"
        }
      }
    ]
  },
  "missingFields": [
    "buyer_tax_identifier"
  ],
  "riskFlags": [
    "inconsistent_totals"
  ],
  "confidence": 0.93,
  "usage": {
    "operation": "document_extraction",
    "units": 1
  },
  "createdAt": "2026-10-20T12:00:00.000Z"
}

Authorizations

x-api-key

string

header

required

Headers

Idempotency-Key

string

Optional client key for safely retrying the same logical request. A key is scoped to the customer, product, and operation. Reusing it with a different request returns 409.

Required string length: 1 - 255

Body

application/json

documentUrl

string<uri>

required

Absolute HTTP or HTTPS URL retrievable by The Wo.

Minimum string length: 1

Example:

"https://example.com/documents/sample-invoice.pdf"

expectedType

enum<string>

Optional expected type hint. Does not force the detected response type.

Available options:

invoice,

receipt

language

enum<string>

Optional supported source-language hint. It does not localize the canonical response vocabulary.

Available options:

en,

pt,

es

Response

Extraction completed and usage recorded.

id

string

required

status

any

required

documentType

enum<string>

required

Available options:

invoice,

receipt

extracted

object

required

Option 1
Option 2

Show child attributes

missingFields

enum<string>[]

required

Available options:

document_number,

issued_at,

supplier_name,

supplier_tax_identifier,

buyer_name,

buyer_tax_identifier,

merchant_name,

merchant_tax_identifier,

purchased_at,

subtotal,

tax,

total,

line_items

riskFlags

enum<string>[]

required

Available options:

document_type_mismatch,

low_confidence_critical_field,

inconsistent_totals,

unreadable_section,

incomplete_line_items

confidence

number

required

Required range: 0 <= x <= 1

usage

object

required

Show child attributes

createdAt

string<date-time>

required

curl --request POST \
  --url https://api.thewo.io/v1/documents/extract \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "documentUrl": "https://example.com/documents/sample-invoice.pdf"
}
'

{
  "id": "trade_document_example_01",
  "status": "completed",
  "documentType": "invoice",
  "extracted": {
    "documentNumber": "INV-2026-104",
    "issuedAt": "2026-10-19",
    "supplier": {
      "name": "Example Paper Goods",
      "taxIdentifier": "SUP-104"
    },
    "buyer": {
      "name": "Northstar Workshop"
    },
    "total": {
      "minorUnits": 245000,
      "currency": "USD"
    },
    "items": [
      {
        "description": "Workshop materials",
        "quantity": 2,
        "unitPrice": {
          "minorUnits": 1000,
          "currency": "USD"
        },
        "lineTotal": {
          "minorUnits": 2000,
          "currency": "USD"
        }
      }
    ]
  },
  "missingFields": [
    "buyer_tax_identifier"
  ],
  "riskFlags": [
    "inconsistent_totals"
  ],
  "confidence": 0.93,
  "usage": {
    "operation": "document_extraction",
    "units": 1
  },
  "createdAt": "2026-10-20T12:00:00.000Z"
}