Get a download URL for one compliance document of a worker contract | Deel

Returns a short-lived URL for the file submitted against a compliance document of one of the authenticated worker Global Payroll contracts. The URL is valid for about 15 minutes: fetch the file with it rather than storing the URL. Pass file to pick a specific file when several were submitted; the first file is returned by default. Documents in the PASSPORT_OR_NATIONAL_ID category are never downloadable through this API, for any token type. Only Global Payroll contracts are supported.

Token scopes: worker:read

Returns a short-lived URL for the file submitted against a compliance document of one of the authenticated worker Global Payroll contracts. The URL is valid for about 15 minutes: fetch the file with it rather than storing the URL. Pass `file` to pick a specific file when several were submitted; the first file is returned by default. Documents in the `PASSPORT_OR_NATIONAL_ID` category are never downloadable through this API, for any token type. Only Global Payroll contracts are supported. **Token scopes**: `worker:read`

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

$ curl -X GET 'https://api.deel.training/rest/v2/contracts' \
>   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.deel.training/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

contract_idstringRequired1-64 characters

Public id of the Global Payroll contract the documents belong to.

document_idstringRequiredformat: "uuid"

Public UUID of the compliance document requirement, as returned in id by the list endpoint.

Query parameters

fileintegerOptional>=0Defaults to 0

Zero-based index of the submitted file to download. Defaults to the first file.

Response

Download URL returned successfully.

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

412

Precondition Failed Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X GET 'https://api.deel.training/rest/v2/contracts' \
>	-H 'Authorization: Bearer YOUR-TOKEN-HERE'