Deel: Create a tax form for the authenticated worker
Deel workers.createAtaxFormForAworker: arguments, response, policy and SDK examples.
← Workers operations · Get started
Operation deel.workers_createataxformforaworker_v2026_01_01
Provider route: POST /workers/tax-forms. 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"]["createAtaxFormForAworker"]>[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.createAtaxFormForAworker(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_atax_form_for_aworker(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 tax form for the authenticated worker — request body — body data |
Referenced models: Create a tax form for the authenticated 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 tax form for the authenticated worker — 201 response body |
Referenced models: Create a tax form for the authenticated worker — 201 response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Create a tax form for the authenticated worker — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a tax form for the authenticated worker — 201 response body — data |
Referenced models: Create a tax form for the authenticated worker — 201 response body — data
Create a tax form for the authenticated worker — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp of when the tax form was created. Format: date-time |
id | string | Required within parent | The public ID (UUID) of the created tax form. Format: uuid |
Create a tax form for the authenticated worker — request body — body / data / form_type: W9 INDIVIDUAL tax number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Taxpayer identification number. |
type | string | Required within parent | Tax ID type. SSN/ITIN for individuals; EIN also allowed for disregarded entities. One of: SSN, ITIN, EIN |
value | string | Required within parent | Tax ID value. |
Create a tax form for the authenticated worker — request body — body / data / form_type: W9 COMPANY federal tax classification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Federal tax classification. |
llc_classification | string | Optional | LLC sub-classification. Required when type is 'LLC'. One of: P, S, C |
other_additional_information | string | Optional | Additional information. Required when type is 'OTHER'. Maximum length: 100 |
type | string | Required within parent | Federal 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Taxpayer identification number. |
type | string | Required within parent | Tax ID type. EIN for most entities; SSN/ITIN/EIN for LLC. One of: SSN, ITIN, EIN |
value | string | Required within parent | Tax 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Mailing address if different from permanent residence. |
address | string | Required within parent | Mailing address. Maximum length: 100 |
address_line2 | string or null | Optional | Mailing address line 2. Maximum length: 100 |
city | string or null | Optional | Mailing address city. Maximum length: 50 Minimum length: 1 |
country | string | Required within parent | ISO 3166-1 alpha-2 country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
state | string or null | Optional | Mailing address state. Maximum length: 10 |
zip_code | string | Required within parent | Mailing address ZIP/postal code. |
Create a tax form for the authenticated worker — request body — body / data / form_type: W8 BEN tax number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Foreign tax identifying number. At least one of us_tax_number or tax_number is required unless is_ftin_not_legally_required is true. |
type | string | Required within parent | Foreign tax ID type. One of: FTIN |
value | string | Required within parent | Foreign 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Tax treaty benefits details. Applicable when is_tax_treaty_enabled is true. |
article_and_paragraph | string | Optional | Article and paragraph of the applicable tax treaty. Maximum length: 100 |
details | string | Optional | Additional details about the treaty claim. Maximum length: 400 |
owner_resident_country | string | Optional | Country 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_income | string | Optional | Type of income covered by the treaty. Maximum length: 100 |
withholding_rate | number | Optional | Withholding 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | US Taxpayer Identification Number. |
type | string | Required within parent | US tax ID type. One of: SSN, ITIN |
value | string | Required within parent | US 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Foreign tax identifying number. At least one of us_tax_number, tax_number, or giin is required unless is_ftin_not_legally_required is true. |
type | string | Required within parent | Foreign tax ID type. One of: FTIN |
value | string | Required within parent | Foreign 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Tax treaty benefits details. |
article_and_paragraph | string | Optional | Article and paragraph of the applicable tax treaty. Maximum length: 100 |
details | string | Optional | Additional details about the treaty claim. Maximum length: 400 |
is_tax_residency_certified | boolean or null | Optional | Whether tax residency is certified. Default: false |
limitation_type | JSON | Optional | Limitation on benefits (LOB) type. |
limitation_type (oneOf 1) | string | Alternative | Limitation 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) | null | Alternative | |
other_article_and_paragraph | string or null | Optional | Other article and paragraph. Required when limitation_type is 'OTHER'. Maximum length: 50 |
owner_resident_country | string | Optional | Country of residence of the beneficial owner. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
type_of_income | string | Optional | Type of income covered by the treaty. Maximum length: 25 |
withholding_rate | number | Optional | Withholding rate under the treaty (percentage). Format: double Maximum: 100 Minimum: 0 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.workers_createataxformforaworker_v2026_01_01. Catalog operation: workers_createataxformforaworker_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"}