Deel: Create a new worker
Deel workers.createWorker: arguments, response, policy and SDK examples.
← Workers operations · Get started
Operation deel.workers_createworker_v2026_01_01
Provider route: POST /worker. 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"]["createWorker"]>[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.createWorker(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.create_worker(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.data | Model | Required within parent | Expand Create a new worker — request body — body data |
Referenced models: Create a new worker — request body — body data
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 Create a new worker — 201 response body |
Referenced models: Create a new worker — 201 response body
Schemas
Section titled “Schemas”Create a new worker — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a new worker — 201 response body — data |
Referenced models: Create a new worker — 201 response body — data
Create a new worker — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
company | Model | Required within parent | Expand Create a new worker — request body — body data company |
contract_id | string | Required within parent | Associated contract ID Minimum length: 1 |
email | string | Required within parent | Worker's email address Format: email Minimum length: 5 |
first_name | string | Required within parent | Worker's first name Minimum length: 1 |
last_name | string | Required within parent | Worker's last name Minimum length: 1 |
middle_name | string or null | Optional | Worker's middle name |
preferred_firstname | string or null | Optional | Worker's preferred first name |
preferred_lastName | string or null | Optional | Worker's preferred last name |
preferred_name | string or null | Optional | Worker's preferred name |
profile_type | string | Required within parent | Type of worker profile One of: CONTRACTOR, EOR |
timezone | string | Required within parent | Worker's timezone |
Referenced models: Create a new worker — request body — body data company
Create a new worker — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Required within parent | Associated contract ID Minimum length: 1 |
profile_id | string | Required within parent | Created profile ID Minimum length: 1 |
user_id | string | Required within parent | Created user ID Minimum length: 1 |
Create a new worker — request body — body data company
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
personal | Model | Required within parent | Expand Create a new worker — request body — body data company personal |
type | string | Required within parent | Type of company registration One of: COMPANY, INDIVIDUAL |
Referenced models: Create a new worker — request body — body data company personal
Create a new worker — request body — body data company personal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
citizen | string | Required within parent | Citizenship country code |
city | string | Required within parent | City |
country | string | Optional | Country code |
entity_tax_residence | string | Optional | Entity tax residence (only applicable for company type) |
id_type | string | Optional | Type of identification |
legal_status | string | Optional | Legal status (required only when type is INDIVIDUAL) |
personal_id | number | Required within parent | Personal identification number Format: double |
phone | number | Required within parent | Phone number Format: double |
province | string or null | Optional | Province/State |
street | string | Required within parent | Street address |
tax_residence | string | Optional | Tax residence country code |
timezone | string | Optional | Personal timezone |
zip | number | Required within parent | Zip/Postal code Format: double |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.workers_createworker_v2026_01_01. Catalog operation: workers_createworker_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.
Pinned headers: {"X-Version": "2026-01-01"}