Deel: List tax forms for the authenticated worker
Deel workers.listTaxFormsForAworker: arguments, response, policy and SDK examples.
← Workers operations · Get started
Operation deel.workers_listtaxformsforaworker_v2026_01_01
Provider route: GET /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"]["listTaxFormsForAworker"]>[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.listTaxFormsForAworker(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.list_tax_forms_for_aworker(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
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 List tax forms for the authenticated worker — 200 response body |
Referenced models: List tax forms for the authenticated worker — 200 response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
List tax forms for the authenticated worker — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The worker's tax forms, newest first. |
data[] | Model | Each item | Expand List tax forms for the authenticated worker — 200 response body — data item |
has_more | boolean | Required within parent | Whether more tax forms exist beyond this page. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to pass as the cursor query parameter to fetch the next page. Null when has_more is false. |
next_cursor (anyOf 2) | null | Alternative | Cursor to pass as the cursor query parameter to fetch the next page. Null when has_more is false. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of the worker's tax forms across all pages. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List tax forms for the authenticated worker — 200 response body — data item
List tax forms for the authenticated worker — 200 response body — data / item / form_type: W9 COMPANY tax number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Taxpayer identification number. Returned unmasked. |
type | string | Optional | Tax ID type. Known values: SSN, ITIN, EIN |
value | string | Optional | Tax ID value, unmasked. |
List tax forms for the authenticated worker — 200 response body — data / item / form_type: W9 COMPANY federal tax classification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Federal tax classification. Present on W9_COMPANY forms. |
llc_classification | string | Optional | LLC sub-classification. Present when type is 'LLC'. Known values: P, S, C |
other_additional_information | string | Optional | Additional information. Present when type is 'OTHER'. |
type | string | Optional | Federal tax classification type. Known values: C_CORPORATION, S_CORPORATION, OTHER, PARTNERSHIP, LLC, TRUST_ESTATE |
List tax forms for the authenticated worker — 200 response body — data / item / 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. Present on W8_BEN and W8_BEN_E forms. |
address | string | Optional | Mailing address. |
address_line2 | JSON | Optional | |
address_line2 (anyOf 1) | string | Alternative | Mailing address line 2. |
address_line2 (anyOf 2) | null | Alternative | Mailing address line 2. |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | Mailing address city. |
city (anyOf 2) | null | Alternative | Mailing address city. |
country | string | Optional | ISO 3166-1 alpha-2 country code. |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | Mailing address state. |
state (anyOf 2) | null | Alternative | Mailing address state. |
zip_code | string | Optional | Mailing address ZIP/postal code. |
List tax forms for the authenticated worker — 200 response body — data / item / form_type: W8 BEN tax number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Foreign taxpayer identification number. Returned unmasked. |
type | string | Optional | Tax ID type. Known values: FTIN |
value | string | Optional | Tax ID value, unmasked. |
List tax forms for the authenticated worker — 200 response body — data / item / 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. Present when treaty benefits are claimed. |
article_and_paragraph | string | Optional | Article and paragraph of the applicable tax treaty. |
details | string | Optional | Additional details about the treaty claim. |
owner_resident_country | string | Optional | Country of residence of the beneficial owner. |
type_of_income | string | Optional | Type of income covered by the treaty. |
withholding_rate | JSON | Optional | |
withholding_rate (anyOf 1) | number | Alternative | Withholding rate under the treaty (percentage). Format: double |
withholding_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List tax forms for the authenticated worker — 200 response body — data / item / form_type: W8 BEN us tax number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | US Taxpayer Identification Number. Present on W8_BEN and W8_BEN_E forms. Returned unmasked. |
type | string | Optional | US tax ID type. Known values: SSN, ITIN |
value | string | Optional | US tax ID value, unmasked. |
List tax forms for the authenticated worker — 200 response body — data / item / fatca_status: ACTIVE NFFE, PASSIVE NFFE, form type: W8 BEN E tax treaty benefits form article and paragraph, details, is tax residency certified, limitation type, other article and paragraph, owner resident country, type of income, withholding rate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Tax treaty benefits details. Present when treaty benefits are claimed. |
article_and_paragraph | string | Optional | Article and paragraph of the applicable tax treaty. |
details | string | Optional | Additional details about the treaty claim. |
is_tax_residency_certified | JSON | Optional | |
is_tax_residency_certified (anyOf 1) | boolean | Alternative | Whether tax residency is certified. |
is_tax_residency_certified (anyOf 2) | null | Alternative | Whether tax residency is certified. |
limitation_type | JSON | Optional | Limitation on benefits (LOB) type. |
limitation_type (anyOf 1) | string | Alternative | Limitation on benefits (LOB) type. Known values: GOVERNMENT, PENSION_TRUST, TAX_EXEMPT, PUBLICLY_TRADED_CORPORATION, SUBSIDIARY, OWNERSHIP_TEST, DERIVATIVE_TEST, ACTIVE_TRADE_TEST, FAVORABLE, NO_ARTICLE, OTHER |
limitation_type (anyOf 2) | null | Alternative | |
other_article_and_paragraph | JSON | Optional | |
other_article_and_paragraph (anyOf 1) | string | Alternative | Other article and paragraph. Present when limitation_type is 'OTHER'. |
other_article_and_paragraph (anyOf 2) | null | Alternative | Other article and paragraph. Present when limitation_type is 'OTHER'. |
owner_resident_country | string | Optional | Country of residence of the beneficial owner. |
type_of_income | string | Optional | Type of income covered by the treaty. |
withholding_rate | JSON | Optional | |
withholding_rate (anyOf 1) | number | Alternative | Withholding rate under the treaty (percentage). Format: double |
withholding_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.workers_listtaxformsforaworker_v2026_01_01. Catalog operation: workers_listtaxformsforaworker_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:read"]
Pinned headers: {"X-Version": "2026-01-01"}