Skip to content

Deel: List of worker compliance documents

Deel workers.listOfWorkerComplianceDocuments: arguments, response, policy and SDK examples.

← Workers operations · Get started

Operation deel.workers_listofworkercompliancedocuments_v2026_01_01

Provider route: GET /workers/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"]["listOfWorkerComplianceDocuments"]>[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.listOfWorkerComplianceDocuments(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_of_worker_compliance_documents(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

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

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

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

List of worker compliance documents — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand List of worker compliance documents — 200 response body — data

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

List of worker compliance documents — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
documentsarrayRequired within parentList of compliance documents required for the worker.
documents[]ModelEach itemExpand List of worker compliance documents — 200 response body — data documents item

Referenced models: List of worker compliance documents — 200 response body — data documents item

List of worker compliance documents — 200 response body — data documents item
FieldTypePresenceDescription and constraints
$objectRoot
countryJSONRequired within parent
country (anyOf 1)stringAlternativeISO 3166-1 alpha-2 country code where the document is required.
country (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country code where the document is required.
descriptionstringRequired within parentDescription of the document requirement. Empty string when no description exists.
filenamesarrayRequired within parentList of uploaded file names. Empty array when no files have been uploaded.
filenames[]stringEach item
fillablebooleanRequired within parentWhether the document can be filled through the Deel platform.
has_templatebooleanRequired within parentWhether a template is available for this document.
idstringRequired within parentUnique identifier for the compliance document requirement.
Format: uuid
is_acknowledgement_only_documentbooleanRequired within parentWhether this document only requires acknowledgement without file upload.
is_consent_requiredbooleanOptionalWhether consent is required for acknowledgement-only documents. Only present when is_acknowledgement_only_document is true.
is_optionalbooleanRequired within parentWhether the document is optional for the worker. Also true when the document is required within 30 days.
namestringRequired within parentDisplay name of the compliance document.
rejection_messagestringRequired within parentPlain text message explaining why the document was rejected. Empty string when no rejection message exists.
required_in_30_daysbooleanRequired within parentWhether the document is required within 30 days of employment start.
statusJSONRequired within parentReview status of the uploaded document, null if no document has been uploaded yet.
status (anyOf 1)stringAlternativeReview status of the uploaded document, null if no document has been uploaded yet.
Known values: AWAITING_EX_REVIEW, AWAITING_EXTERNAL_REVIEW, REJECTED, APPROVED, ON_HOLD
status (anyOf 2)nullAlternative
uploaded_atJSONRequired within parent
uploaded_at (anyOf 1)stringAlternativeISO 8601 timestamp when the document was uploaded, null if no document has been uploaded.
Format: date-time
uploaded_at (anyOf 2)nullAlternativeISO 8601 timestamp when the document was uploaded, null if no document has been uploaded.
Format: date-time

SDK function policy ID: deel.workers_listofworkercompliancedocuments_v2026_01_01. Catalog operation: workers_listofworkercompliancedocuments_v2026_01_01. 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-01-01"}

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.