Skip to navigation

Get an upload URL for a qualification's supporting document

View as Markdown

Registers a supporting document against the qualification and returns a short-lived presigned S3 URL to upload the file bytes to directly. PUT the file to uploadUrl, sending every header in requiredHeaders unchanged (notably Content-Type). The bytes go straight to S3, never through this API. The document appears in GET …/documents once the upload completes. 404 if the qualification is unknown or belongs to another institution.

Authentication

AuthorizationBearer

Paste a Keycloak access token (no "Bearer " prefix)

Path parameters

qualificationIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
filenamestringOptional
The file's name, e.g. "transcript.pdf".
contentTypestringOptional

MIME type, e.g. "application/pdf"; sent as-is when uploading to uploadUrl.

Response

OK
idstringOptionalformat: "uuid"
The document id, used to download the file later.
uploadUrlstringOptionalformat: "uri"

PUT the file bytes here. Short-lived; expires within minutes.

requiredHeadersmap from strings to stringsOptional

Headers that must be sent unchanged on the upload PUT (e.g. Content-Type).

Errors

400
Bad Request Error