Skip to content

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.

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 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.list_tax_forms_for_aworker(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.cursorstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List tax forms for the authenticated worker — 200 response body

Referenced models: List tax forms for the authenticated worker — 200 response body

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

List tax forms for the authenticated worker — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe worker's tax forms, newest first.
data[]ModelEach itemExpand List tax forms for the authenticated worker — 200 response body — data item
has_morebooleanRequired within parentWhether more tax forms exist beyond this page.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to pass as the cursor query parameter to fetch the next page. Null when has_more is false.
next_cursor (anyOf 2)nullAlternativeCursor to pass as the cursor query parameter to fetch the next page. Null when has_more is false.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of the worker's tax forms across all pages.
total_count (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$objectRootTaxpayer identification number. Returned unmasked.
typestringOptionalTax ID type.
Known values: SSN, ITIN, EIN
valuestringOptionalTax ID value, unmasked.
List tax forms for the authenticated worker — 200 response body — data / item / form_type: W9 COMPANY federal tax classification
FieldTypePresenceDescription and constraints
$objectRootFederal tax classification. Present on W9_COMPANY forms.
llc_classificationstringOptionalLLC sub-classification. Present when type is 'LLC'.
Known values: P, S, C
other_additional_informationstringOptionalAdditional information. Present when type is 'OTHER'.
typestringOptionalFederal 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
FieldTypePresenceDescription and constraints
$objectRootMailing address if different from permanent residence. Present on W8_BEN and W8_BEN_E forms.
addressstringOptionalMailing address.
address_line2JSONOptional
address_line2 (anyOf 1)stringAlternativeMailing address line 2.
address_line2 (anyOf 2)nullAlternativeMailing address line 2.
cityJSONOptional
city (anyOf 1)stringAlternativeMailing address city.
city (anyOf 2)nullAlternativeMailing address city.
countrystringOptionalISO 3166-1 alpha-2 country code.
stateJSONOptional
state (anyOf 1)stringAlternativeMailing address state.
state (anyOf 2)nullAlternativeMailing address state.
zip_codestringOptionalMailing address ZIP/postal code.
List tax forms for the authenticated worker — 200 response body — data / item / form_type: W8 BEN tax number
FieldTypePresenceDescription and constraints
$objectRootForeign taxpayer identification number. Returned unmasked.
typestringOptionalTax ID type.
Known values: FTIN
valuestringOptionalTax 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
FieldTypePresenceDescription and constraints
$objectRootTax treaty benefits details. Present when treaty benefits are claimed.
article_and_paragraphstringOptionalArticle and paragraph of the applicable tax treaty.
detailsstringOptionalAdditional details about the treaty claim.
owner_resident_countrystringOptionalCountry of residence of the beneficial owner.
type_of_incomestringOptionalType of income covered by the treaty.
withholding_rateJSONOptional
withholding_rate (anyOf 1)numberAlternativeWithholding rate under the treaty (percentage).
Format: double
withholding_rate (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$objectRootUS Taxpayer Identification Number. Present on W8_BEN and W8_BEN_E forms. Returned unmasked.
typestringOptionalUS tax ID type.
Known values: SSN, ITIN
valuestringOptionalUS 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
FieldTypePresenceDescription and constraints
$objectRootTax treaty benefits details. Present when treaty benefits are claimed.
article_and_paragraphstringOptionalArticle and paragraph of the applicable tax treaty.
detailsstringOptionalAdditional details about the treaty claim.
is_tax_residency_certifiedJSONOptional
is_tax_residency_certified (anyOf 1)booleanAlternativeWhether tax residency is certified.
is_tax_residency_certified (anyOf 2)nullAlternativeWhether tax residency is certified.
limitation_typeJSONOptionalLimitation on benefits (LOB) type.
limitation_type (anyOf 1)stringAlternativeLimitation 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)nullAlternative
other_article_and_paragraphJSONOptional
other_article_and_paragraph (anyOf 1)stringAlternativeOther article and paragraph. Present when limitation_type is 'OTHER'.
other_article_and_paragraph (anyOf 2)nullAlternativeOther article and paragraph. Present when limitation_type is 'OTHER'.
owner_resident_countrystringOptionalCountry of residence of the beneficial owner.
type_of_incomestringOptionalType of income covered by the treaty.
withholding_rateJSONOptional
withholding_rate (anyOf 1)numberAlternativeWithholding rate under the treaty (percentage).
Format: double
withholding_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

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.