Deel: Create a tax form for the authenticated worker — request body — body data
Create a tax form for the authenticated worker: request body, field body / data. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Create a tax form for the authenticated worker — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {“propertyName”: “form_type”} |
$ (oneOf 1) | object | Alternative | W9_INDIVIDUAL variant |
$ (oneOf 1).address | string | Required within parent | Street address. Maximum 40 characters for 1099 reporting compliance. Maximum length: 40 |
$ (oneOf 1).business_name | string or null | Optional | Business name. Only applicable when is_disregarded_entity is true. Maximum length: 40 |
$ (oneOf 1).city | string | Required within parent | City name. Maximum length: 40 Minimum length: 1 |
$ (oneOf 1).client_legal_entity_id | string | Required within parent | Public ID of the client’s legal entity. Format: uuid |
$ (oneOf 1).contractor_signature | string | Required within parent | Contractor’s digital signature. Maximum length: 100 Minimum length: 1 |
$ (oneOf 1).country | string | Required within parent | ISO 3166-1 alpha-2 country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
$ (oneOf 1).first_name | string | Required within parent | Legal first name. Maximum length: 40 |
$ (oneOf 1).form_type | string | Required within parent | Discriminator value: W9_INDIVIDUAL One of: W9_INDIVIDUAL |
$ (oneOf 1).is_disregarded_entity | boolean | Optional | Whether this is a disregarded entity. Default: false |
$ (oneOf 1).is_subject_backup_withholding | boolean | Optional | Whether the contractor is subject to backup withholding. Default: false |
$ (oneOf 1).last_name | string | Required within parent | Legal last name. Maximum length: 40 |
$ (oneOf 1).middle_name | string | Optional | Legal middle name. Maximum length: 100 |
$ (oneOf 1).state | string or null | Optional | US state code. Maximum length: 10 |
$ (oneOf 1).tax_number | Model | Required within parent | Expand Create a tax form for the authenticated worker — request body — body / data / form_type: W9 INDIVIDUAL tax number Taxpayer identification number. |
$ (oneOf 1).zip_code | string | Required within parent | ZIP/postal code. Must be a valid US ZIP code for US addresses. |
$ (oneOf 2) | object | Alternative | W9_COMPANY variant |
$ (oneOf 2).address | string | Required within parent | Street address. Maximum length: 40 |
$ (oneOf 2).business_name | string | Required within parent | Business name. Maximum length: 40 Minimum length: 1 |
$ (oneOf 2).city | string | Required within parent | City name. Maximum length: 40 Minimum length: 1 |
$ (oneOf 2).client_legal_entity_id | string | Required within parent | Public ID of the client’s legal entity. Format: uuid |
$ (oneOf 2).contractor_signature | string | Required within parent | Authorized signer’s digital signature. Maximum length: 100 Minimum length: 1 |
$ (oneOf 2).country | string | Required within parent | ISO 3166-1 alpha-2 country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
$ (oneOf 2).doing_business_as | string or null | Optional | DBA name. Maximum length: 50 |
$ (oneOf 2).federal_tax_classification | Model | Required within parent | Expand Create a tax form for the authenticated worker — request body — body / data / form_type: W9 COMPANY federal tax classification Federal tax classification. |
$ (oneOf 2).form_type | string | Required within parent | Discriminator value: W9_COMPANY One of: W9_COMPANY |
$ (oneOf 2).is_subject_backup_withholding | boolean | Optional | Whether the contractor is subject to backup withholding. Default: false |
$ (oneOf 2).state | string or null | Optional | US state code. Maximum length: 10 |
$ (oneOf 2).tax_number | Model | Required within parent | Expand Create a tax form for the authenticated worker — request body — body / data / form_type: W9 COMPANY tax number Taxpayer identification number. |
$ (oneOf 2).zip_code | string | Required within parent | ZIP/postal code. |
$ (oneOf 3) | object | Alternative | W8_BEN variant |
$ (oneOf 3).address | string | Required within parent | Street address. Maximum length: 100 |
$ (oneOf 3).address_line2 | string or null | Optional | Street address line 2. Maximum length: 100 |
$ (oneOf 3).city | string or null | Optional | City name. Maximum length: 50 Minimum length: 1 |
$ (oneOf 3).client_legal_entity_id | string | Required within parent | Public ID of the client’s legal entity. Format: uuid |
$ (oneOf 3).contractor_signature | string | Required within parent | Contractor’s digital signature. Maximum length: 100 Minimum length: 1 |
$ (oneOf 3).country | string | Required within parent | ISO 3166-1 alpha-2 country code of permanent residence. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
$ (oneOf 3).country_of_citizenship | string | Required within parent | ISO 3166-1 alpha-2 country code of citizenship. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
$ (oneOf 3).date_of_birth | string or null | Optional | Date of birth. Must be at least 18 years ago and no more than 100 years ago. Format: date-time |
$ (oneOf 3).first_name | string | Required within parent | Legal first name. Maximum length: 100 |
$ (oneOf 3).form_type | string | Required within parent | Discriminator value: W8_BEN One of: W8_BEN |
$ (oneOf 3).is_certified_and_agreed | boolean or null | Optional | Certification that the signer has read and agrees with the certification information. Default: false |
$ (oneOf 3).is_disregarded_entity | boolean | Optional | Whether this is a disregarded entity. Default: false |
$ (oneOf 3).is_ftin_not_legally_required | boolean | Optional | Check if FTIN is not legally required in your country of residence. Default: false |
$ (oneOf 3).is_tax_treaty_enabled | boolean or null | Optional | Whether the contractor claims tax treaty benefits. Default: false |
$ (oneOf 3).last_name | string | Required within parent | Legal last name. Maximum length: 100 |
$ (oneOf 3).mailing_address | JSON | Optional | Mailing address if different from permanent residence. |
$ (oneOf 3).mailing_address (oneOf 1) | Model | Alternative | Expand 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 |
$ (oneOf 3).mailing_address (oneOf 2) | null | Alternative | |
$ (oneOf 3).middle_name | string or null | Optional | Legal middle name. Maximum length: 100 |
$ (oneOf 3).print_name_of_signer | string or null | Optional | Printed name of the signer. Maximum length: 100 |
$ (oneOf 3).referencing_information | string or null | Optional | Reference number for the form. Maximum length: 100 |
$ (oneOf 3).state | string or null | Optional | State or province code. Maximum length: 10 |
$ (oneOf 3).tax_number | Model | Optional | Expand Create a tax form for the authenticated worker — request body — body / data / form_type: W8 BEN tax number Foreign tax identifying number. At least one of us_tax_number or tax_number is required unless is_ftin_not_legally_required is true. |
$ (oneOf 3).tax_treaty_benefits_form | JSON | Optional | Tax treaty benefits details. Applicable when is_tax_treaty_enabled is true. |
$ (oneOf 3).tax_treaty_benefits_form (oneOf 1) | Model | Alternative | Expand 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 |
$ (oneOf 3).tax_treaty_benefits_form (oneOf 2) | null | Alternative | |
$ (oneOf 3).us_tax_number | Model | Optional | Expand Create a tax form for the authenticated worker — request body — body / data / form_type: W8 BEN us tax number US Taxpayer Identification Number. |
$ (oneOf 3).zip_code | string | Required within parent | ZIP/postal code. |
$ (oneOf 4) | object | Alternative | W8_BEN_E variant |
$ (oneOf 4).address | string | Required within parent | Street address. Maximum length: 100 |
$ (oneOf 4).address_line2 | string or null | Optional | Street address line 2. Maximum length: 100 |
$ (oneOf 4).city | string | Required within parent | City of residence. Maximum length: 50 Minimum length: 1 |
$ (oneOf 4).client_legal_entity_id | string | Required within parent | Public ID of the client’s legal entity. Format: uuid |
$ (oneOf 4).contractor_signature | string | Required within parent | Authorized signer’s digital signature. Maximum length: 100 Minimum length: 1 |
$ (oneOf 4).country | string | Required within parent | ISO 3166-1 alpha-2 country code of permanent residence. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
$ (oneOf 4).country_of_citizenship | string | Required within parent | ISO 3166-1 alpha-2 country code of incorporation/organization. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
$ (oneOf 4).date_of_birth | string or null | Optional | Date of birth of the beneficial owner. Format: date-time |
$ (oneOf 4).entity_country | string or null | Required within parent | ISO 3166-1 alpha-2 country code of the entity. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
$ (oneOf 4).entity_type | string | Required within parent | Chapter 3 entity type. One of: CORPORATION, DISREGARDED_ENTITY, PARTNERSHIP, SIMPLE_TRUST, GRANTOR_TRUST, COMPLEX_TRUST, ESTATE, GOVERNMENT, CENTRAL_BANK_OF_ISSUE, TAX_EXEMPT, PRIVATE_FOUNDATION, INTERNATIONAL, FOREIGN_GOVERNMENT_CONTROLLED, FOREIGN_GOVERNMENT_INTEGRAL |
$ (oneOf 4).fatca_status | string | Required within parent | FATCA (Foreign Account Tax Compliance Act) status. One of: ACTIVE_NFFE, PASSIVE_NFFE |
$ (oneOf 4).form_type | string | Required within parent | Discriminator value: W8_BEN_E One of: W8_BEN_E |
$ (oneOf 4).giin | string or null | Optional | Global Intermediary Identification Number (19 characters). Maximum length: 19 Minimum length: 19 |
$ (oneOf 4).has_substantial_us_owner | boolean | Optional | Whether the entity has a substantial US owner. Required when fatca_status is ‘PASSIVE_NFFE’. Default: false |
$ (oneOf 4).is_entity_certification_confirmed | boolean or null | Optional | Certification that the entity is the beneficial owner of all income. Default: false |
$ (oneOf 4).is_ftin_not_legally_required | boolean | Optional | Check if FTIN is not legally required in your country. Default: false |
$ (oneOf 4).is_tax_treaty_enabled | boolean or null | Optional | Whether the entity claims tax treaty benefits. Default: false |
$ (oneOf 4).mailing_address | JSON | Optional | Mailing address if different from permanent residence. |
$ (oneOf 4).mailing_address (oneOf 1) | Model | Alternative | Expand 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 |
$ (oneOf 4).mailing_address (oneOf 2) | null | Alternative | |
$ (oneOf 4).name_of_disregarded_entity | string or null | Optional | Name of the disregarded entity, if applicable. Maximum length: 100 |
$ (oneOf 4).name_of_organization | string | Required within parent | Name of the organization. Maximum length: 100 |
$ (oneOf 4).print_name_of_signer | string or null | Optional | Printed name of the authorized signer. Maximum length: 100 |
$ (oneOf 4).referencing_information | string or null | Optional | Reference number for the form. Maximum length: 100 |
$ (oneOf 4).state | string or null | Optional | State or province code. Maximum length: 10 |
$ (oneOf 4).tax_number | Model | Optional | Expand 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 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. |
$ (oneOf 4).tax_treaty_benefits_form | JSON | Optional | Tax treaty benefits details. |
$ (oneOf 4).tax_treaty_benefits_form (oneOf 1) | Model | Alternative | Expand 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 |
$ (oneOf 4).tax_treaty_benefits_form (oneOf 2) | null | Alternative | |
$ (oneOf 4).us_tax_number | Model | Optional | Expand Create a tax form for the authenticated worker — request body — body / data / form_type: W8 BEN us tax number US Taxpayer Identification Number. |
$ (oneOf 4).zip_code | string | Required within parent | ZIP/postal code. |
Referenced models: Create a tax form for the authenticated worker — request body — body / data / form_type: W9 INDIVIDUAL tax number, Create a tax form for the authenticated worker — request body — body / data / form_type: W9 COMPANY federal tax classification, Create a tax form for the authenticated worker — request body — body / data / form_type: W9 COMPANY tax number, 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, Create a tax form for the authenticated worker — request body — body / data / form_type: W8 BEN tax number, 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, Create a tax form for the authenticated worker — request body — body / data / form_type: W8 BEN us tax number, 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, 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