Deel: List compliance documents of a worker contract
Deel workers.listWorkerContractComplianceDocuments: arguments, response, policy and SDK examples.
← Workers operations · Get started
Operation deel.workers_listworkercontractcompliancedocuments_v2026_08_25
Provider route: GET /workers/contracts/{contract_id}/compliance-documents. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["workers"]["listWorkerContractComplianceDocuments"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.workers.listWorkerContractComplianceDocuments(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.workers.list_worker_contract_compliance_documents(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.contract_id | string | Required within parent | Maximum length: 64 Minimum length: 1 |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional | Maximum length: 512 Minimum length: 1 Pattern: ^[A-Za-z0-9_-]+$ |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List compliance documents of a worker contract — 200 response body |
Referenced models: List compliance documents of a worker contract — 200 response body
Schemas
Section titled “Schemas”List compliance documents of a worker contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Documents on this page. |
data[] | Model | Each item | Expand Retrieve one compliance document of a worker contract — 200 response body — data |
has_more | boolean | Required within parent | Whether another page follows this one. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Opaque token to pass as `cursor` to fetch the next page. Null on the last page. Never construct or parse one. |
next_cursor (anyOf 2) | null | Alternative | Opaque token to pass as `cursor` to fetch the next page. Null on the last page. Never construct or parse one. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of documents for the contract, across every page. Minimum: 0 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve one compliance document of a worker contract — 200 response body — data
Retrieve one compliance document of a worker contract — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Required within parent | |
country (anyOf 1) | string | Alternative | ISO 3166-1 alpha-2 country code the requirement applies to. Null for a requirement that applies everywhere. |
country (anyOf 2) | null | Alternative | ISO 3166-1 alpha-2 country code the requirement applies to. Null for a requirement that applies everywhere. |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | When the submission was created. Carries the same value as `uploaded_at`. Format: date-time |
created_at (anyOf 2) | null | Alternative | When the submission was created. Carries the same value as `uploaded_at`. Format: date-time |
description | string | Required within parent | What the document asks for, in the worker language. Empty string when the requirement has no description. |
filenames | array | Required within parent | Names of the files submitted against this requirement. Empty array when nothing has been submitted. |
filenames[] | string | Each item | |
has_template | boolean | Required within parent | Whether a template is provided for this document. |
id | string | Required within parent | Public UUID of the compliance document requirement. Use it as `document_id` on the other endpoints. Format: uuid |
is_acknowledgement_only_document | boolean | Required within parent | 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. |
is_required | boolean | Required within parent | 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. |
name | string | Required within parent | Display name of the document, in the worker language. |
review | JSON | Optional | Outcome of the Deel review of the submission. Present only for worker types whose submissions are reviewed, and only once a review exists. Absent for Global Payroll documents and for contractor documents that are not reviewed. |
review (anyOf 1) | Model | Alternative | Expand Retrieve one compliance document of a worker contract — 200 response body — data review rejection message, status |
review (anyOf 2) | null | Alternative | |
submission_status | JSON | Required within parent | |
submission_status (anyOf 1) | string | Alternative | Reads `REVIEWING` while a submission is not final yet. Null at every other time. |
submission_status (anyOf 2) | null | Alternative | Reads `REVIEWING` while a submission is not final yet. Null at every other time. |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | When the submission was last changed. Null when nothing has been submitted. Format: date-time |
updated_at (anyOf 2) | null | Alternative | When the submission was last changed. Null when nothing has been submitted. Format: date-time |
uploaded_at | JSON | Required within parent | |
uploaded_at (anyOf 1) | string | Alternative | When the submission was created. Null when nothing has been submitted. Format: date-time |
uploaded_at (anyOf 2) | null | Alternative | When the submission was created. Null when nothing has been submitted. Format: date-time |
Referenced models: Retrieve one compliance document of a worker contract — 200 response body — data review rejection message, status
Retrieve one compliance document of a worker contract — 200 response body — data review rejection message, status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Outcome of the Deel review of the submission. Present only for worker types whose submissions are reviewed, and only once a review exists. Absent for Global Payroll documents and for contractor documents that are not reviewed. |
rejection_message | JSON | Required within parent | |
rejection_message (anyOf 1) | string | Alternative | Why the submission was rejected, in the worker language. Null unless the status is `REJECTED`. |
rejection_message (anyOf 2) | null | Alternative | Why the submission was rejected, in the worker language. Null unless the status is `REJECTED`. |
status | string | Required within parent | Where the submission sits in the review. Known values: AWAITING_EX_REVIEW, AWAITING_EXTERNAL_REVIEW, REJECTED, APPROVED, ON_HOLD |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.workers_listworkercontractcompliancedocuments_v2026_08_25. Catalog operation: workers_listworkercontractcompliancedocuments_v2026_08_25. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["worker:read"]
Pinned headers: {"X-Version": "2026-08-25"}