Deel: Complete individual contractor profile setup
Deel workers.completeIndividualContractorProfileSetup: arguments, response, policy and SDK examples.
← Workers operations · Get started
Operation deel.workers_completeindividualcontractorprofilesetup_v2026_01_01
Provider route: POST /onboarding/workers/individual. 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"]["completeIndividualContractorProfileSetup"]>[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.completeIndividualContractorProfileSetup(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.complete_individual_contractor_profile_setup(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 Complete individual contractor profile setup — request body — body data |
Referenced models: Complete individual contractor profile setup — 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 Complete individual contractor profile setup — 200 response body |
Referenced models: Complete individual contractor profile setup — 200 response body
Schemas
Section titled “Schemas”Complete individual contractor profile setup — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
abn | string | Optional | Australian Business Number (11 digits). Required when tax_residence is AU. |
address_confirmed_by_user | boolean | Optional | Whether the user has confirmed the address is correct. |
address_valid | boolean | Optional | Whether the provided address has been validated. |
citizen | string | Required within parent | Citizenship country as an ISO 3166-1 alpha-2 code. |
city | string | Required within parent | City of residence. |
country | string | Required within parent | Country of residence as an ISO 3166-1 alpha-2 code. |
entity_tax_residence | string | Optional | Tax residence country for the entity, if different from the individual. |
id_type | string | Optional | Type of identification document provided. |
legal_status | string | Required within parent | Legal status of the individual contractor. |
personal_id | string | Optional | Passport or national ID number. Required when tax_residence is not US. |
phone | string | Optional | Phone number in E.164 format. |
province | string | Optional | Province or state code within the country. |
ssn | string | Optional | Social Security Number (9 digits, no dashes). Required when tax_residence is US. |
street | string | Required within parent | Street address of the contractor. |
tax_residence | string | Optional | Tax residence country as an ISO 3166-1 alpha-2 code. Defaults to the country field if omitted. |
timezone | string | Optional | IANA timezone identifier. |
zip | string | Required within parent | Postal or ZIP code. |
Complete individual contractor profile setup — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Complete individual contractor profile setup — 200 response body — data |
Referenced models: Complete individual contractor profile setup — 200 response body — data
Complete individual contractor profile setup — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
abn | string | Optional | Australian Business Number (11 digits). |
address_confirmed_by_user | boolean | Optional | Whether the user has confirmed the address is correct. |
address_valid | boolean | Optional | Whether the provided address has been validated. |
citizen | string | Optional | Citizenship country as an ISO 3166-1 alpha-2 code. |
city | string | Optional | City of residence. |
company_type | string | Required within parent | Type of company set up for the contractor. |
country | string | Optional | Country of residence as an ISO 3166-1 alpha-2 code. |
entity_tax_residence | string | Optional | Tax residence country for the entity, if different from the individual. |
id_type | string | Optional | Type of identification document provided. |
legal_status | string | Optional | Legal status of the individual contractor. |
onboarding_step | JSON | Optional | |
onboarding_step (anyOf 1) | string | Alternative | Current onboarding step after setup completes. |
onboarding_step (anyOf 2) | null | Alternative | Current onboarding step after setup completes. |
personal_id | string | Optional | Passport or national ID number. |
phone | string | Optional | Phone number in E.164 format. |
profile_id | JSON | Required within parent | |
profile_id (anyOf 1) | integer | Alternative | Internal profile identifier for the contractor. |
profile_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
province | string | Optional | Province or state code within the country. |
ssn | string | Optional | Social Security Number (9 digits). |
street | string | Optional | Street address of the contractor. |
tax_residence | string | Optional | Tax residence country as an ISO 3166-1 alpha-2 code. |
timezone | string | Optional | IANA timezone identifier. |
zip | string | Optional | Postal or ZIP code. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.workers_completeindividualcontractorprofilesetup_v2026_01_01. Catalog operation: workers_completeindividualcontractorprofilesetup_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:write"]
Pinned headers: {"X-Version": "2026-01-01"}