Deel: List of employee compliance documents
Deel eorWorkerCompliance.getEorworkerComplianceDocuments: arguments, response, policy and SDK examples.
← EOR worker compliance operations · Get started
Operation deel.eorworkercompliance_geteorworkercompliancedocuments
Provider route: GET /eor/workers/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["eorWorkerCompliance"]["getEorworkerComplianceDocuments"]>[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.eorWorkerCompliance.getEorworkerComplianceDocuments(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.eor_worker_compliance.get_eorworker_compliance_documents(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
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 of employee compliance documents — 200 response body |
Referenced models: List of employee compliance documents — 200 response body
Schemas
Section titled “Schemas”List of employee compliance documents — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand List of employee compliance documents — 200 response body — data |
Referenced models: List of employee compliance documents — 200 response body — data
List of employee compliance documents — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
documents | array | Required within parent | List of compliance documents required for the worker. |
documents[] | Model | Each item | Expand List of employee compliance documents — 200 response body — data documents item |
Referenced models: List of employee compliance documents — 200 response body — data documents item
List of employee compliance documents — 200 response body — data documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Required within parent | ISO 3166-1 alpha-2 country code where the document is required. |
description | string | Required within parent | Description of the document requirement. Empty string when no description exists. |
filenames | array | Required within parent | List of uploaded file names. Empty array when no files have been uploaded. |
filenames[] | string | Each item | |
fillable | boolean | Required within parent | Whether the document can be filled through the Deel platform. |
has_template | boolean | Required within parent | Whether a template is available for this document. |
id | string | Required within parent | Unique identifier for the compliance document requirement. Format: uuid |
is_acknowledgement_only_document | boolean | Required within parent | Whether this document only requires acknowledgement without file upload. |
is_consent_required | boolean | Optional | Whether consent is required for acknowledgement-only documents. Only present when is_acknowledgement_only_document is true. |
is_optional | boolean | Required within parent | Whether the document is optional for the worker. Also true when the document is required within 30 days. |
name | string | Required within parent | Display name of the compliance document. |
rejection_message | string | Required within parent | Plain text message explaining why the document was rejected. Empty string when no rejection message exists. |
required_in_30_days | boolean | Required within parent | Whether the document is required within 30 days of employment start. |
status | JSON | Required within parent | Review status of the uploaded document, null if no document has been uploaded yet. |
status (anyOf 1) | string | Alternative | Review 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) | null | Alternative | |
uploaded_at | JSON | Required within parent | |
uploaded_at (anyOf 1) | string | Alternative | ISO 8601 timestamp when the document was uploaded, null if no document has been uploaded. Format: date-time |
uploaded_at (anyOf 2) | null | Alternative | ISO 8601 timestamp when the document was uploaded, null if no document has been uploaded. Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorworkercompliance_geteorworkercompliancedocuments. Catalog operation: eorworkercompliance_geteorworkercompliancedocuments. 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"}