GET /public/v1/documents/{document_id}/sections/uploads/{upload_id}

Receive the upload status of the document and sections by their upload_id.

Requesting document section upload status is useful to ensure a document section upload is in the expected state before calling additional API methods.

In response, you receive an array with sections_uuid. You can receive information about each section using the Document Section Info endpoint.

    "section_uuids": [
        "H8T8CJofGY6JwTsWsPuDEF",
        "8MwLaU4SaZywqLiDk26mDF"
    ]

Available Document Section Upload Statuses

The following is a complete list of all possible document statuses returned:

Document StatusStatus Description
document_sections_upload.UPLOADEDThe document section upload process has just been created. It is in processing and will be in document_sections_upload.PROCESSED state momentarily.
document_sections_upload.PROCESSEDThe document sections upload is processed and the sections are already created in the document. All aspects of the document sections can be edited in this state.
document_sections_upload.ERRORDocument section upload procces has been failed. For more information check error details in the response.

Servers

Path parameters

Name Type Required Description
upload_id String Yes

Upload ID.

document_id String Yes

Document ID.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.