Receipts

Extract receipt data asynchronously with webhook notification

Submits a receipt for asynchronous AI extraction. Returns a job ID immediately.

When extraction completes (or fails), a webhook POST is sent to the callbackUrl with the full extraction result as JSON payload.

Webhook payload includes:

  • event: "receipt.extraction.completed" or "receipt.extraction.failed"
  • jobId, status, filename, durationMs
  • result: full ReceiptExtractionResult (on success)
  • error: error message (on failure)

Security: If callbackSecret is provided, the webhook includes an X-DocGen-Signature header with HMAC-SHA256 of the payload for verification.

Jobs are kept in memory for 30 minutes and then auto-cleaned.

post/api/receipts/extract-async

Request

  • Base URL: https://api.dokmatiq.com
  • URL: https://api.dokmatiq.com/api/receipts/extract-async
  • Auth: API key in header X-API-Key

Query parameters

callbackUrlstring

Webhook URL to notify on completion

callbackSecretstring

Shared secret for HMAC-SHA256 webhook signature

Response

Job accepted

Changes

No recorded changes to this operation across all 1 revision of this API.