Skip to main content
POST
documents.inspect

Authorizations

x-api-key
string
header
required

API key prefixed with sk_. Obtain from the Receiptor AI dashboard.

Body

application/json
id
string
required

Document ID to inspect

Minimum string length: 1
fields
enum<string>[]

Specific fields to inspect from file. Defaults to core financial fields.

Available options:
merchant,
amount,
currency,
docDate,
invoiceId,
receiptId,
taxAmount,
subtotal,
paymentMethod,
category,
summary,
docType
maxPages
integer
default:3

For PDFs, maximum pages to inspect (1-5). Defaults to 3.

Required range: 1 <= x <= 5

Response

Successful response

success
boolean
Example:

true

code
integer
Example:

200

data
object