GET /extraction/{request_id}
Retrieve an extraction status. This endpoint allows the status of the extraction to be checked based on the extraction identifier (request_id). Each of the extraction IDs should be checked individually before their results are retrieved.
Headers
Authorization (required) - Requires the standard authentication header used in the system.
Parameters
-
request_id Path Required
the extraction to query status. This is the extraction identifier returned from a successful POST /extraction response (request_id)
-
200 OKThe response successfully returned
-
403 ForbiddenInvalid or missing authentication token.
-
404 Not FoundThe extraction does not exist or has been cleaned up.
-
500 Internal Server ErrorSomething went wrong unrelated to the users request.
Response Data
-
request_id
the request identifier to check the status
-
file_id
the id of the document extracted
-
status
the status of your request. One of either queued, processing, or complete
-
error
if an error occurs, you may get a standard error response
{
"file_id": "<file_id>",
"status": "complete",
"request_id": "<request_id>"
}
Need Help?
Couldn’t find the information you were looking for or need more assistance?
Contact Support