Skip to content

Download one of a worker's documents

GET
/v1/workers/{workerId}/documents/{id}/content
curl --request GET \
--url https://api2.recruso.co.uk/v1/workers/1/documents/1/content \
--header 'Authorization: <Authorization>'

Returns the file itself for a document held against a worker in your own agency.

It is always sent as an attachment, named as it was uploaded, with a media type decided by its extension rather than the one it was uploaded with. The file comes from the API and nowhere else: documents are held in private storage, and where is never disclosed.

A document that belongs to a different worker, or to another agency, returns 404 rather than 403, so its existence is never disclosed. So does a document whose file is no longer in storage.

Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.

workerId
required
integer format: int32

The workerId path parameter

id
required
integer format: int32

The id path parameter

OK

string format: binary

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Forbidden

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}