Modifying the details of an existing submission (Upload Documents)

PATCH

/submissions/{{submission_ref}}

Last modified:2024-08-09 12:14:50

Maintainer:Not configured

This end point allows additional information to be added to a previously submitted submission. This is a partial update call, which does not update every detail every
time, only the modified ones. It will usually be in response to a request for additional
information during the screening process.

The request is HTTP PATCH (RFC 5789), multipart/form-data (RFC7578) and holds the updated details of the submission and/or the files that serve as Proof of Immunity

If the operation was successful, the response message is HTTP 200 OK. If the request cannot be processed due to misformatted or untranslatable data, the API should response with HTTP 400 Bad Request error.

If the submission_ref is not valid then the API should response with HTTP 404 Not Found error.
If the request cannot be processed due to data validation errors, the API should respond with HTTP 403 Forbidden and an appropriate error response.

Request

Authorization

Add parameter in header

API-Key

Example:

API-Key: ********************

Header Params

Body Params multipart/form-data

Responses

🟢200Modifying the details of an existing submission

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request PATCH '/submissions/{{submission_ref}}' \
--header 'API-Version: {{api_version}}' \
--header 'API-Key: <api-key>' \
--form 'file=""'

Response Example

[
    ""
]

Modified at 2024-08-09 12:14:50

Creating a new submission

Make final form submission (after uploading documents)