Get required documents for a submission
GET
/api/submissions/{submission_id}/required-documents
Documents
Last modified:2026-07-27 09:06:51
Maintainer:Not configured
docs_required_document_list siteconfig entry, keyed by the candidate's clearance_type). docs_required is computed the same way as at submission creation time: true only while the submission's form_type is one of clinical / clinical_occupational_health / clinical_occupational_health_icsg / roi_clinical_occupational_health, the client has allow_upload enabled, and zero documents have been uploaded so far. required_documents is always an empty array when docs_required is false.Request
Path Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/submissions//required-documents' \
--header 'API-VERSION;' \
--header 'API-KEY: <api-key>'Response Response Example
200 - Documents still required
[
{
"response": {
"submission_id": 12345,
"docs_required": true,
"docs_uploaded_count": 0,
"required_documents": [
{
"name": "Tuberculosis",
"description": "Please provide documentary proof of either BCG vaccination administered, BCG scar sited by a competent healthcare professional, Heaf test grade 2 or greater, or a positive Mantoux result (>= 5mm) within the last 5 years."
},
{
"name": "Hepatitis B",
"description": "Please provide evidence of your most recent blood test result AND documentary proof of your vaccination details and boosters (if possible). If you are a true non-responder or have acquired natural immunity, supporting documentary evidence needs to be supplied."
}
]
}
}
]Modified at 2026-07-27 09:06:51