Download document file

Production

https://api.niva.co/v1

GET

/submissions/{submission_id}/documents/{document_id}/download

Redirects (302) to a temporary signed URL of the original file; follow it right away and do not store it. To download an original upload that was merged into another document, pass its merged_documents[].id. Documents Niva retrieved from a registry may have no file and return 404 Document file not available.

TIP

Fetch the Location URL without the apiKey header; the file host does not need it.

Request

Authorization

Add parameter in header

apiKey

Example:

apiKey: ********************

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.niva.co/v1/submissions/sub_3ZMd9KJnvAdYt4mOyW7YQRAp/documents/doc_MAXm5v0B7kZVHorQL8YjV2y9/download' \
--header 'Accept-Language: en' \
--header 'apiKey: <api-key>'

Responses

🔵302Found

Redirect to the document file

Headers

This response does not have a body.

🟠401Unauthorized

🟠404Not Found

🔴500Internal Server Error

Delete document

Rerun validations