Skip to content

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.

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 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.complete_individual_contractor_profile_setup(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.dataModelRequired within parentExpand Complete individual contractor profile setup — request body — body data

Referenced models: Complete individual contractor profile setup — request body — body data

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Complete individual contractor profile setup — 200 response body

Referenced models: Complete individual contractor profile setup — 200 response body

Complete individual contractor profile setup — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
abnstringOptionalAustralian Business Number (11 digits). Required when tax_residence is AU.
address_confirmed_by_userbooleanOptionalWhether the user has confirmed the address is correct.
address_validbooleanOptionalWhether the provided address has been validated.
citizenstringRequired within parentCitizenship country as an ISO 3166-1 alpha-2 code.
citystringRequired within parentCity of residence.
countrystringRequired within parentCountry of residence as an ISO 3166-1 alpha-2 code.
entity_tax_residencestringOptionalTax residence country for the entity, if different from the individual.
id_typestringOptionalType of identification document provided.
legal_statusstringRequired within parentLegal status of the individual contractor.
personal_idstringOptionalPassport or national ID number. Required when tax_residence is not US.
phonestringOptionalPhone number in E.164 format.
provincestringOptionalProvince or state code within the country.
ssnstringOptionalSocial Security Number (9 digits, no dashes). Required when tax_residence is US.
streetstringRequired within parentStreet address of the contractor.
tax_residencestringOptionalTax residence country as an ISO 3166-1 alpha-2 code. Defaults to the country field if omitted.
timezonestringOptionalIANA timezone identifier.
zipstringRequired within parentPostal or ZIP code.
Complete individual contractor profile setup — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
abnstringOptionalAustralian Business Number (11 digits).
address_confirmed_by_userbooleanOptionalWhether the user has confirmed the address is correct.
address_validbooleanOptionalWhether the provided address has been validated.
citizenstringOptionalCitizenship country as an ISO 3166-1 alpha-2 code.
citystringOptionalCity of residence.
company_typestringRequired within parentType of company set up for the contractor.
countrystringOptionalCountry of residence as an ISO 3166-1 alpha-2 code.
entity_tax_residencestringOptionalTax residence country for the entity, if different from the individual.
id_typestringOptionalType of identification document provided.
legal_statusstringOptionalLegal status of the individual contractor.
onboarding_stepJSONOptional
onboarding_step (anyOf 1)stringAlternativeCurrent onboarding step after setup completes.
onboarding_step (anyOf 2)nullAlternativeCurrent onboarding step after setup completes.
personal_idstringOptionalPassport or national ID number.
phonestringOptionalPhone number in E.164 format.
profile_idJSONRequired within parent
profile_id (anyOf 1)integerAlternativeInternal profile identifier for the contractor.
profile_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
provincestringOptionalProvince or state code within the country.
ssnstringOptionalSocial Security Number (9 digits).
streetstringOptionalStreet address of the contractor.
tax_residencestringOptionalTax residence country as an ISO 3166-1 alpha-2 code.
timezonestringOptionalIANA timezone identifier.
zipstringOptionalPostal or ZIP code.

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

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.