GET
/
api
/
v2
/
employers
/
me
/
crew
/
{crew_unique_id}
/
documents
/
{document_id}
/
download
Short-TTL branded download link (scope: crew:documents:download)
curl --request GET \
  --url https://partners.crewpass.co.uk/api/v2/employers/me/crew/{crew_unique_id}/documents/{document_id}/download \
  --header 'Authorization: Bearer <token>'
{
  "document_id": "<string>",
  "download_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "content_type": "<string>",
  "file_name": "<string>"
}

Authorizations

​
Authorization
string
header
required

Partner API key (cpk_live_* / cpk_test_*) as a Bearer token.

Headers

​
authorization
string | null
​
X-Partner-API-Key
string | null

Path Parameters

​
crew_unique_id
string
required
​
document_id
string
required

Response

Successful Response

GET …/documents/{document_id}/download — a short-TTL branded link.

download_url is a CrewPass-hosted proxy link (never a raw storage URL); the bytes are streamed from storage server-side when the link is followed.

​
document_id
string
required
​
download_url
string
required
​
expires_at
string<date-time>
required
​
content_type
string | null
​
file_name
string | null