Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parentMaximum length: 64
Minimum length: 1
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.cursorstringOptionalMaximum length: 512
Minimum length: 1
Pattern: ^[A-Za-z0-9_-]+$

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List compliance documents of a worker contract — 200 response body

Referenced models: List compliance documents of a worker contract — 200 response body

List compliance documents of a worker contract — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentDocuments on this page.
data[]ModelEach itemExpand Retrieve one compliance document of a worker contract — 200 response body — data
has_morebooleanRequired within parentWhether another page follows this one.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeOpaque token to pass as `cursor` to fetch the next page. Null on the last page. Never construct or parse one.
next_cursor (anyOf 2)nullAlternativeOpaque token to pass as `cursor` to fetch the next page. Null on the last page. Never construct or parse one.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of documents for the contract, across every page.
Minimum: 0
total_count (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$objectRoot
countryJSONRequired within parent
country (anyOf 1)stringAlternativeISO 3166-1 alpha-2 country code the requirement applies to. Null for a requirement that applies everywhere.
country (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country code the requirement applies to. Null for a requirement that applies everywhere.
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeWhen the submission was created. Carries the same value as `uploaded_at`.
Format: date-time
created_at (anyOf 2)nullAlternativeWhen the submission was created. Carries the same value as `uploaded_at`.
Format: date-time
descriptionstringRequired within parentWhat the document asks for, in the worker language. Empty string when the requirement has no description.
filenamesarrayRequired within parentNames of the files submitted against this requirement. Empty array when nothing has been submitted.
filenames[]stringEach item
has_templatebooleanRequired within parentWhether a template is provided for this document.
idstringRequired within parentPublic UUID of the compliance document requirement. Use it as `document_id` on the other endpoints.
Format: uuid
is_acknowledgement_only_documentbooleanRequired within parentWhether the document only has to be acknowledged, with no file to submit.
is_consent_requiredbooleanOptionalWhether the worker has to consent. Present only for acknowledgement-only documents that declare the flag.
is_requiredbooleanRequired within parentWhether 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.
namestringRequired within parentDisplay name of the document, in the worker language.
reviewJSONOptionalOutcome 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)ModelAlternativeExpand Retrieve one compliance document of a worker contract — 200 response body — data review rejection message, status
review (anyOf 2)nullAlternative
submission_statusJSONRequired within parent
submission_status (anyOf 1)stringAlternativeReads `REVIEWING` while a submission is not final yet. Null at every other time.
submission_status (anyOf 2)nullAlternativeReads `REVIEWING` while a submission is not final yet. Null at every other time.
updated_atJSONRequired within parent
updated_at (anyOf 1)stringAlternativeWhen the submission was last changed. Null when nothing has been submitted.
Format: date-time
updated_at (anyOf 2)nullAlternativeWhen the submission was last changed. Null when nothing has been submitted.
Format: date-time
uploaded_atJSONRequired within parent
uploaded_at (anyOf 1)stringAlternativeWhen the submission was created. Null when nothing has been submitted.
Format: date-time
uploaded_at (anyOf 2)nullAlternativeWhen 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
FieldTypePresenceDescription and constraints
$objectRootOutcome 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_messageJSONRequired within parent
rejection_message (anyOf 1)stringAlternativeWhy the submission was rejected, in the worker language. Null unless the status is `REJECTED`.
rejection_message (anyOf 2)nullAlternativeWhy the submission was rejected, in the worker language. Null unless the status is `REJECTED`.
statusstringRequired within parentWhere the submission sits in the review.
Known values: AWAITING_EX_REVIEW, AWAITING_EXTERNAL_REVIEW, REJECTED, APPROVED, ON_HOLD

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.