Skip to main content
GET
Get extracted invoice JSON (API key)

Authorizations

Authorization
string
header
default:Bearer sk_live_…
required

Bearer sk_live_… (include the Bearer prefix)

Path Parameters

id
string<uuid>
required

Invoice id returned from upload

Response

Processing status and extracted invoice JSON

id
string<uuid>
required
processingStatus
enum<string>
required
Available options:
queued,
processing,
completed,
failed,
needs_review
Example:

"completed"

status
enum<string>
required
Available options:
pending,
processing,
extracted,
reviewed,
approved,
rejected,
duplicate
Example:

"extracted"

direction
enum<string>
required

Payable (vendor bill) or receivable (customer invoice).

Available options:
payable,
receivable
Example:

"payable"

ready
boolean
required

True when extraction has finished (completed, needs_review, or failed). Keep polling while false.

Example:

true

validationErrors
string[]
required
Example:
isDuplicate
boolean
required
Example:

false

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
data
object | null

Extracted invoice fields. Null while queued/processing with no result yet.

ocrConfidence
number | null
Example:

92.5

extractionTier
number | null

Platform admin only. Omitted from tenant responses.

Example:

2

extractionProvider
string | null

Platform admin only. Omitted from tenant responses.

Example:

"mistral"

routingReason
string | null

Platform admin only. Omitted from tenant responses.

processingError
string | null
vendor
object | null