Finalise a submission after required documents have been uploaded
POST
/api/submissions/{submission_id}/submit
Submissions
Last modified:2026-07-27 09:06:51
Maintainer:Not configured
POST /api/submit-form/{submission_ref} endpoint - this path just also accepts the raw submission_id instead of requiring the generated submission_ref (which does not exist yet for a still-pending, docs-required submission). Rejects with 403 'You must upload the requested documents before you can submit the form' if documents are still required at call time. Also rejects with 403 'Form already submitted' for any submission that never required document upload in the first place (those are finalised immediately at creation), so in practice this endpoint is only ever usefully callable for submissions that came back from creation with docs_required=true. On success: marks the submission as fully submitted, generates and stores its submission_ref, updates the candidate record, and sends the completion notification email (with any uploaded documents attached, subject to max_attachment_size).Request
Path Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/submissions//submit' \
--header 'API-VERSION;' \
--header 'API-KEY: <api-key>'Response Response Example
200 - Example 1
[
""
]Modified at 2026-07-27 09:06:51