List compliance documents of a worker contract

GET

/workers/contracts/:contract_id/compliance-documents

GET

/rest/workers/contracts/:contract_id/compliance-documents

$ curl -G https://api.letsdeel.com/rest/workers/contracts/37nex2x/compliance-documents \
>      -H "Authorization: Bearer <token>" \
>      -d limit=20 \
>      -d cursor=eyJpZCI6IjRiMWYwZDYxLTljNmEtNGE1Zi05ZjJmLTZiMGQzYTFmNzdhYSJ9

1 {
2   "data": [
3     {
4       "id": "c106a26a-21bb-5538-8bf2-57095d1976c1",
5       "name": "Passport or National ID",
6       "country": "US",
7       "filenames": [
8         "passport_scan.pdf"
9       ],
10       "created_at": "2026-01-05T14:30:00.000Z",
11       "updated_at": "2026-01-06T08:15:00.000Z",
12       "description": "Please upload a clear copy of your passport or national ID card.",
13       "is_required": true,
14       "uploaded_at": "2026-01-05T14:30:00.000Z",
15       "has_template": false,
16       "submission_status": "REVIEWING",
17       "is_acknowledgement_only_document": false
18     },
19     {
20       "id": "4b1f0d61-9c6a-4a5f-9f2f-6b0d3a1f77aa",
21       "name": "Direct Deposit Authorization",
22       "country": "US",
23       "filenames": [],
24       "created_at": null,
25       "updated_at": null,
26       "description": "Complete and sign the direct deposit form.",
27       "is_required": true,
28       "uploaded_at": null,
29       "has_template": true,
30       "submission_status": null,
31       "is_acknowledgement_only_document": false
32     }
33   ],
34   "has_more": true,
35   "next_cursor": "eyJpZCI6IjRiMWYwZDYxLTljNmEtNGE1Zi05ZjJmLTZiMGQzYTFmNzdhYSJ9",
36   "total_count": 12
37 }

Lists the compliance documents the authenticated worker has to satisfy on one of their Global Payroll contracts, together with what has already been submitted against each one. Use it to see what is still outstanding before payroll. Requirements with nothing submitted are included, with an empty filenames array and null timestamps. Retired requirements are excluded, except a retired I9, which stays listed while it can still be submitted. Only Global Payroll contracts are supported.

Token scopes: worker:read

Lists the compliance documents the authenticated worker has to satisfy on one of their Global Payroll contracts, together with what has already been submitted against each one. Use it to see what is still outstanding before payroll. Requirements with nothing submitted are included, with an empty `filenames` array and null timestamps. Retired requirements are excluded, except a retired I9, which stays listed while it can still be submitted. 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.

Query parameters

limitintegerOptional1-100Defaults to 20

Maximum number of documents to return per page.

cursorstringOptionalformat: "^[A-Za-z0-9_-]+$"1-512 characters

Opaque next_cursor value from the previous response, passed back unchanged. Omit for the first page.

Response

Compliance documents returned successfully. created_at and updated_at come from the submission; created_at carries the same value as uploaded_at, and all three are null until something is submitted against the requirement. The language of name and description follows the language preference of the authenticated worker. It cannot be selected per request, and the same document may read differently for two workers of the same organization. Text falls back to English when no published translation exists for that language. total_count, has_more and next_cursor always describe the whole set of requirements for the contract rather than an estimate. next_cursor is an opaque token: pass it back unchanged and never construct or parse one. The set is small — expect tens of documents for one contract, not thousands.

Compliance documents returned successfully. `created_at` and `updated_at` come from the submission; `created_at` carries the same value as `uploaded_at`, and all three are null until something is submitted against the requirement. The language of `name` and `description` follows the language preference of the authenticated worker. It cannot be selected per request, and the same document may read differently for two workers of the same organization. Text falls back to English when no published translation exists for that language. `total_count`, `has_more` and `next_cursor` always describe the whole set of requirements for the contract rather than an estimate. `next_cursor` is an opaque token: pass it back unchanged and never construct or parse one. The set is small — expect tens of documents for one contract, not thousands.

datalist of objects

Documents on this page.

has_moreboolean

Whether another page follows this one.

next_cursorstring or null

Opaque token to pass as cursor to fetch the next page. Null on the last page. Never construct or parse one.

total_countinteger>=0

Total number of documents for the contract, across every page.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found 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'