Capabilities

documents.inspect

Inspect the original document file (image/PDF) with a vision model and compare visible values against the saved document fields.

post/capabilities/documents.inspect

Request

  • Base URL: https://developer.api.receiptor.ai/v1
  • URL: https://developer.api.receiptor.ai/v1/capabilities/documents.inspect
  • Auth: one of:
    • API key in header x-receiptor-api-key
    • HTTP bearer

Request body

idstring required

Document ID to inspect

fieldsstring[]

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

maxPagesinteger

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

Response

Successful response

successboolean
codeinteger

Example response

{
  "success": true,
  "code": 200
}

Changes

No recorded changes to this operation across all 12 revisions of this API.