Get an extraction's status, holding the request until it changes
The extraction's live status. With wait, the request is held until the extraction leaves processing or the wait elapses, then answered with the ordinary payload, so a handful of calls replaces a polling loop. Choose a wait shorter than your own client or tool timeout; a response after the full wait is an ordinary processing response, so call again. Without wait, leave at least 5 seconds between calls.
Every response is HTTP 200 with a top-level status of exactly one of processing, input_required, completed, failed, cancelled; success is true for all of them except failed. Branch on status, and treat a value you do not recognise as non-terminal. The completed and cancelled responses carry the account's remaining balance.
Rate limit: 120 requests per minute per API key; a held request counts as one.
Request
- Base URL: https://api.invoicedataextraction.com/v1
- URL: https://api.invoicedataextraction.com/v1/extractions/{extraction_id}
- Auth: HTTP bearer
Path parameters
The extraction_id returned by submitExtraction.
Query parameters
Seconds to hold the request open, 1 to 45. The response is sent as soon as the extraction leaves processing or when the time is up, whichever comes first. Omit it for the current status at once.
own or team. Team admins default to team and see every team member's extractions; everyone else defaults to own, and a non-admin passing team gets 403 FORBIDDEN. Under team, items carry submitted_by.
Response
The status, in the shape of the status it reports.
Changes
No recorded changes to this operation across all 1 revision of this API.