> This page is for API, version 2026-01-01 (Stable) (default). > For other versions, use one of these documentation indexes: > - 2026-01-01 (Stable) (default): https://developer.deel.com/api/stable/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.deel.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server. # List compliance documents of a worker contract GET https://api.letsdeel.com/rest/workers/contracts/{contract_id}/compliance-documents 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` Reference: https://developer.deel.com/api/reference/endpoints/workers/list-worker-contract-compliance-documents-v-2026-08-25 ## Authentication - `Authorization` header (bearer token, required) — ## 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.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication) - `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/ ## Servers - `https://api.letsdeel.com/rest` (Production, default) - `https://api-staging.letsdeel.com/rest` (Demo) ## Request ### Path parameters - `contract_id` (string, required) — Public id of the Global Payroll contract the documents belong to. ### Query parameters - `limit` (integer, optional, default: 20) — Maximum number of documents to return per page. - `cursor` (string, optional) — Opaque `next_cursor` value from the previous response, passed back unchanged. Omit for the first page. ## Response ### 200 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. - `data` (list of WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataItems, required) — Documents on this page. - `has_more` (boolean, required) — Whether another page follows this one. - `next_cursor` (string, required, nullable) — Opaque token to pass as `cursor` to fetch the next page. Null on the last page. Never construct or parse one. - `total_count` (integer, required) — Total number of documents for the contract, across every page. ## Errors ### 400 Bad Request Error Bad request — `limit` is outside 1 to 100, or `cursor` is not a token a previous response handed out. - `errors` (list of WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Errors that occurred while processing the request. ### 401 Unauthorized Error Unauthorized — the access token is missing, expired or invalid. - `errors` (list of WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Errors that occurred while processing the request. ### 403 Forbidden Error Forbidden — the worker does not hold this contract, or the token lacks the required scope. - `errors` (list of WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Errors that occurred while processing the request. ### 404 Not Found Error Not found — no contract of the authenticated worker matches `contract_id`. - `errors` (list of WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Errors that occurred while processing the request. ### 422 Unprocessable Entity Error Unprocessable entity — the contract is not a Global Payroll contract, so compliance documents are not available on this endpoint. The error code is `WORKER_TYPE_NOT_SUPPORTED`. - `errors` (list of WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Errors that occurred while processing the request. ### 500 Internal Server Error Operation failed. - `request` (ApiErrorRequest, optional) - `errors` (list of ApiError, optional) ## Types ### WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataItems - `id` (string, required) — Public UUID of the compliance document requirement. Use it as `document_id` on the other endpoints. - `name` (string, required) — Display name of the document, in the worker language. - `country` (string, required, nullable) — ISO 3166-1 alpha-2 country code the requirement applies to. Null for a requirement that applies everywhere. - `filenames` (list of string, required) — Names of the files submitted against this requirement. Empty array when nothing has been submitted. - `created_at` (string, required, nullable) — When the submission was created. Carries the same value as `uploaded_at`. - `updated_at` (string, required, nullable) — When the submission was last changed. Null when nothing has been submitted. - `description` (string, required) — What the document asks for, in the worker language. Empty string when the requirement has no description. - `is_required` (boolean, required) — Whether the worker has to submit this document. A requirement with a 30-day grace period after the employment start reads `true`: it is required, only not immediately. - `uploaded_at` (string, required, nullable) — When the submission was created. Null when nothing has been submitted. - `has_template` (boolean, required) — Whether a template is provided for this document. - `submission_status` (string, required, nullable) — Reads `REVIEWING` while a submission is not final yet. Null at every other time. - `is_acknowledgement_only_document` (boolean, required) — Whether the document only has to be acknowledged, with no file to submit. - `is_consent_required` (boolean, optional) — Whether the worker has to consent. Present only for acknowledgement-only documents that declare the flag. ### WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems - `code` (string, required) — Machine-readable error code. - `message` (string, required) — Human-readable explanation. - `field` (string, optional, nullable) — Field that caused the error, when the error is about one. ### ApiErrorRequest - `method` (string, optional) — The HTTP method of the failed request - `url` (string, optional) — The relative URL of the failed request - `status` (double, optional) — The status code of the response - `api_req_id` (string, optional) — The request ID of the failed request - `docs` (string, optional) — A link to the official documentation for the requested endpoint resource - `source` (string, optional) — The source handler which produced the returned error - `code` (double, optional) — The code of the source handler which produced the returned error ### ApiError - `message` (string, optional) — A description of the returned error - `path` (string, optional) — The JSON path where input validation failed ## Examples **Response** ```json { "data": [ { "id": "c106a26a-21bb-5538-8bf2-57095d1976c1", "name": "Passport or National ID", "country": "US", "filenames": [ "passport_scan.pdf" ], "created_at": "2026-01-05T14:30:00.000Z", "updated_at": "2026-01-06T08:15:00.000Z", "description": "Please upload a clear copy of your passport or national ID card.", "is_required": true, "uploaded_at": "2026-01-05T14:30:00.000Z", "has_template": false, "submission_status": "REVIEWING", "is_acknowledgement_only_document": false }, { "id": "4b1f0d61-9c6a-4a5f-9f2f-6b0d3a1f77aa", "name": "Direct Deposit Authorization", "country": "US", "filenames": [], "created_at": null, "updated_at": null, "description": "Complete and sign the direct deposit form.", "is_required": true, "uploaded_at": null, "has_template": true, "submission_status": null, "is_acknowledgement_only_document": false } ], "has_more": true, "next_cursor": "eyJpZCI6IjRiMWYwZDYxLTljNmEtNGE1Zi05ZjJmLTZiMGQzYTFmNzdhYSJ9", "total_count": 12 } ``` **SDK Code** ```python Workers_listWorkerContractComplianceDocuments-v2026-08-25_example import requests url = "https://api.letsdeel.com/rest/workers/contracts/37nex2x/compliance-documents" querystring = {"cursor":"eyJpZCI6IjRiMWYwZDYxLTljNmEtNGE1Zi05ZjJmLTZiMGQzYTFmNzdhYSJ9","limit":"20"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Workers_listWorkerContractComplianceDocuments-v2026-08-25_example const url = 'https://api.letsdeel.com/rest/workers/contracts/37nex2x/compliance-documents?cursor=eyJpZCI6IjRiMWYwZDYxLTljNmEtNGE1Zi05ZjJmLTZiMGQzYTFmNzdhYSJ9&limit=20'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Workers_listWorkerContractComplianceDocuments-v2026-08-25_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.letsdeel.com/rest/workers/contracts/37nex2x/compliance-documents?cursor=eyJpZCI6IjRiMWYwZDYxLTljNmEtNGE1Zi05ZjJmLTZiMGQzYTFmNzdhYSJ9&limit=20" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Workers_listWorkerContractComplianceDocuments-v2026-08-25_example require 'uri' require 'net/http' url = URI("https://api.letsdeel.com/rest/workers/contracts/37nex2x/compliance-documents?cursor=eyJpZCI6IjRiMWYwZDYxLTljNmEtNGE1Zi05ZjJmLTZiMGQzYTFmNzdhYSJ9&limit=20") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java Workers_listWorkerContractComplianceDocuments-v2026-08-25_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.letsdeel.com/rest/workers/contracts/37nex2x/compliance-documents?cursor=eyJpZCI6IjRiMWYwZDYxLTljNmEtNGE1Zi05ZjJmLTZiMGQzYTFmNzdhYSJ9&limit=20") .header("Authorization", "Bearer ") .asString(); ``` ```php Workers_listWorkerContractComplianceDocuments-v2026-08-25_example request('GET', 'https://api.letsdeel.com/rest/workers/contracts/37nex2x/compliance-documents?cursor=eyJpZCI6IjRiMWYwZDYxLTljNmEtNGE1Zi05ZjJmLTZiMGQzYTFmNzdhYSJ9&limit=20', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp Workers_listWorkerContractComplianceDocuments-v2026-08-25_example using RestSharp; var client = new RestClient("https://api.letsdeel.com/rest/workers/contracts/37nex2x/compliance-documents?cursor=eyJpZCI6IjRiMWYwZDYxLTljNmEtNGE1Zi05ZjJmLTZiMGQzYTFmNzdhYSJ9&limit=20"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Workers_listWorkerContractComplianceDocuments-v2026-08-25_example import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/workers/contracts/37nex2x/compliance-documents?cursor=eyJpZCI6IjRiMWYwZDYxLTljNmEtNGE1Zi05ZjJmLTZiMGQzYTFmNzdhYSJ9&limit=20")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```