Get an intake file upload status

Allowed Scopes: experimental:intake:write

Returns the status of an intake file upload. This is step 2 of 3 in creating an intake from a document, after Create an intake file upload.

A file is processed asynchronously once you have sent it to the presigned URL, so poll this endpoint until it leaves the pending state:

  • pending: the file has not been processed yet. Poll again after a few seconds.
  • ready: processing succeeded and documentId is returned. Pass it to Create an intake.
  • failed: processing failed and reason explains why. Create a new upload to try again.

documentId is only present on a ready upload.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The company ID.

string
required

The upload ID.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json