Upload a document against a submission

POST

/api/submissions/{submission_id}/documents

Documents

Last modified:2026-07-27 09:06:51

Maintainer:Not configured

Uploads a single file (JPG, PNG or PDF) and attaches it to the submission's file_upload records, incrementing the submission's docs_uploaded count by 1. Documents are generic - they are not tagged to a specific required-document name; the API only tracks a running uploaded count against the required_documents list from the required-documents endpoint. Only usable while the submission has not yet been finalised (form_date_submitted is still the zero-date placeholder); once submitted, this returns 403.

Request

Authorization

API Key

Add parameter in header

API-KEY

Example:

API-KEY: ********************

Path Params

Header Params

Body Params multipart/form-dataRequired

Responses

🟢200

application/json

Document uploaded successfully.

Bodyapplication/json

🟠400

🟠403

🟠401Unauthorised

🟠404SubmissionNotFound

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/submissions//documents' \
--header 'API-VERSION;' \
--header 'API-KEY: <api-key>' \
--form 'file=@""'

Response Example

200 - Success

{
    "response": {
        "submission_id": 12345,
        "file_id": 988,
        "docs_uploaded_count": 1
    }
}

Modified at 2026-07-27 09:06:51

List documents uploaded against a submission

Delete an uploaded document