Get participant document download URL

Returns a signed URL for the file, valid for 5 minutes. Documents with file_system_type: platform cannot be downloaded through the API and return 409.

Authentication

AuthorizationBearer

API key issued for your account. Send as Bearer token in the Authorization header.

X-Plan-Manager-Idstring

Plan manager UUID. Required on all public API requests to scope data access.

Path parameters

participant_idstringRequiredformat: "uuid"

Participant UUID

document_idstringRequired

Document id (bigint as string)

Response

Signed download URL

download_urlstringformat: "uri"

Signed URL; GET it to download the file

expires_ininteger

Seconds until the URL expires

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error