Skip to content

Deel: Update a US tax form for the authenticated worker

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

← Workers operations · Get started

Operation deel.workers_replaceataxformforaworker_v2026_01_01

Provider route: PUT /workers/tax-forms/{tax_form_id}. 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"]["replaceAtaxFormForAworker"]>[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.replaceAtaxFormForAworker(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.replace_atax_form_for_aworker(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.tax_form_idstringRequired within parentFormat: uuid
bodyobjectOptional
body.dataModelRequired within parentExpand Update a US tax form for the authenticated worker — request body — body data

Referenced models: Update a US tax form for the authenticated worker — 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 Update a US tax form for the authenticated worker — 200 response body

Referenced models: Update a US tax form for the authenticated worker — 200 response body

1 more schema is linked from the tables above, on the schema pages.

Update a US tax form for the authenticated worker — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Update a US tax form for the authenticated worker — 200 response body — data

Referenced models: Update a US tax form for the authenticated worker — 200 response body — data

Update a US tax form for the authenticated worker — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp of when the tax form was created.
Format: date-time
idstringRequired within parentThe public ID (UUID) of the tax form.
Format: uuid
updated_atstringRequired within parentTimestamp of when the tax form was last updated.
Format: date-time
Create a tax form for the authenticated worker — request body — body / data / form_type: W9 INDIVIDUAL tax number
FieldTypePresenceDescription and constraints
$objectRootTaxpayer identification number.
typestringRequired within parentTax ID type. SSN/ITIN for individuals; EIN also allowed for disregarded entities.
One of: SSN, ITIN, EIN
valuestringRequired within parentTax ID value.
Create a tax form for the authenticated worker — request body — body / data / form_type: W9 COMPANY federal tax classification
FieldTypePresenceDescription and constraints
$objectRootFederal tax classification.
llc_classificationstringOptionalLLC sub-classification. Required when type is 'LLC'.
One of: P, S, C
other_additional_informationstringOptionalAdditional information. Required when type is 'OTHER'.
Maximum length: 100
typestringRequired within parentFederal tax classification type.
One of: C_CORPORATION, S_CORPORATION, OTHER, PARTNERSHIP, LLC, TRUST_ESTATE
Create a tax form for the authenticated worker — request body — body / data / form_type: W9 COMPANY tax number
FieldTypePresenceDescription and constraints
$objectRootTaxpayer identification number.
typestringRequired within parentTax ID type. EIN for most entities; SSN/ITIN/EIN for LLC.
One of: SSN, ITIN, EIN
valuestringRequired within parentTax ID value.
Create a tax form for the authenticated worker — request body — body / data / form_type: W8 BEN mailing address address, address line2, city, country, state, zip code
FieldTypePresenceDescription and constraints
$objectRootMailing address if different from permanent residence.
addressstringRequired within parentMailing address.
Maximum length: 100
address_line2string or nullOptionalMailing address line 2.
Maximum length: 100
citystring or nullOptionalMailing address city.
Maximum length: 50
Minimum length: 1
countrystringRequired within parentISO 3166-1 alpha-2 country code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
statestring or nullOptionalMailing address state.
Maximum length: 10
zip_codestringRequired within parentMailing address ZIP/postal code.
Create a tax form for the authenticated worker — request body — body / data / form_type: W8 BEN tax number
FieldTypePresenceDescription and constraints
$objectRootForeign tax identifying number. At least one of us_tax_number or tax_number is required unless is_ftin_not_legally_required is true.
typestringRequired within parentForeign tax ID type.
One of: FTIN
valuestringRequired within parentForeign tax identifying number.
Maximum length: 20
Create a tax form for the authenticated worker — request body — body / data / form_type: W8 BEN tax treaty benefits form article and paragraph, details, owner resident country, type of income, withholding rate
FieldTypePresenceDescription and constraints
$objectRootTax treaty benefits details. Applicable when is_tax_treaty_enabled is true.
article_and_paragraphstringOptionalArticle and paragraph of the applicable tax treaty.
Maximum length: 100
detailsstringOptionalAdditional details about the treaty claim.
Maximum length: 400
owner_resident_countrystringOptionalCountry of residence of the beneficial owner. Must be a US income tax treaty country.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
type_of_incomestringOptionalType of income covered by the treaty.
Maximum length: 100
withholding_ratenumberOptionalWithholding rate under the treaty (percentage).
Format: double
Maximum: 100
Minimum: 0
Create a tax form for the authenticated worker — request body — body / data / form_type: W8 BEN us tax number
FieldTypePresenceDescription and constraints
$objectRootUS Taxpayer Identification Number.
typestringRequired within parentUS tax ID type.
One of: SSN, ITIN
valuestringRequired within parentUS tax ID value.
Create a tax form for the authenticated worker — request body — body / data / fatca_status: ACTIVE NFFE, PASSIVE NFFE, form type: W8 BEN E tax number
FieldTypePresenceDescription and constraints
$objectRootForeign tax identifying number. At least one of us_tax_number, tax_number, or giin is required unless is_ftin_not_legally_required is true.
typestringRequired within parentForeign tax ID type.
One of: FTIN
valuestringRequired within parentForeign tax identifying number.
Maximum length: 20
Create a tax form for the authenticated worker — request body — body / data / fatca_status: ACTIVE NFFE, PASSIVE NFFE, form type: W8 BEN E tax treaty benefits form Tax treaty benefits details
FieldTypePresenceDescription and constraints
$objectRootTax treaty benefits details.
article_and_paragraphstringOptionalArticle and paragraph of the applicable tax treaty.
Maximum length: 100
detailsstringOptionalAdditional details about the treaty claim.
Maximum length: 400
is_tax_residency_certifiedboolean or nullOptionalWhether tax residency is certified.
Default: false
limitation_typeJSONOptionalLimitation on benefits (LOB) type.
limitation_type (oneOf 1)stringAlternativeLimitation on benefits (LOB) type.
One of: GOVERNMENT, PENSION_TRUST, TAX_EXEMPT, PUBLICLY_TRADED_CORPORATION, SUBSIDIARY, OWNERSHIP_TEST, DERIVATIVE_TEST, ACTIVE_TRADE_TEST, FAVORABLE, NO_ARTICLE, OTHER
limitation_type (oneOf 2)nullAlternative
other_article_and_paragraphstring or nullOptionalOther article and paragraph. Required when limitation_type is 'OTHER'.
Maximum length: 50
owner_resident_countrystringOptionalCountry of residence of the beneficial owner.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
type_of_incomestringOptionalType of income covered by the treaty.
Maximum length: 25
withholding_ratenumberOptionalWithholding rate under the treaty (percentage).
Format: double
Maximum: 100
Minimum: 0

SDK function policy ID: deel.workers_replaceataxformforaworker_v2026_01_01. Catalog operation: workers_replaceataxformforaworker_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.