Skip to content

Deel: Workers schemas

48 Deel schemas with complete fields and constraints.

← Workers operations · All schemas

Complete individual contractor profile setup — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Complete individual contractor profile setup — 200 response body — data

Referenced models: Complete individual contractor profile setup — 200 response body — data

Complete individual contractor profile setup — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
abnstringOptionalAustralian Business Number (11 digits).
address_confirmed_by_userbooleanOptionalWhether the user has confirmed the address is correct.
address_validbooleanOptionalWhether the provided address has been validated.
citizenstringOptionalCitizenship country as an ISO 3166-1 alpha-2 code.
citystringOptionalCity of residence.
company_typestringRequired within parentType of company set up for the contractor.
countrystringOptionalCountry of residence as an ISO 3166-1 alpha-2 code.
entity_tax_residencestringOptionalTax residence country for the entity, if different from the individual.
id_typestringOptionalType of identification document provided.
legal_statusstringOptionalLegal status of the individual contractor.
onboarding_stepJSONOptional
onboarding_step (anyOf 1)stringAlternativeCurrent onboarding step after setup completes.
onboarding_step (anyOf 2)nullAlternativeCurrent onboarding step after setup completes.
personal_idstringOptionalPassport or national ID number.
phonestringOptionalPhone number in E.164 format.
profile_idJSONRequired within parent
profile_id (anyOf 1)integerAlternativeInternal profile identifier for the contractor.
profile_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
provincestringOptionalProvince or state code within the country.
ssnstringOptionalSocial Security Number (9 digits).
streetstringOptionalStreet address of the contractor.
tax_residencestringOptionalTax residence country as an ISO 3166-1 alpha-2 code.
timezonestringOptionalIANA timezone identifier.
zipstringOptionalPostal or ZIP code.

Complete individual contractor profile setup — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
abnstringOptionalAustralian Business Number (11 digits). Required when tax_residence is AU.
address_confirmed_by_userbooleanOptionalWhether the user has confirmed the address is correct.
address_validbooleanOptionalWhether the provided address has been validated.
citizenstringRequired within parentCitizenship country as an ISO 3166-1 alpha-2 code.
citystringRequired within parentCity of residence.
countrystringRequired within parentCountry of residence as an ISO 3166-1 alpha-2 code.
entity_tax_residencestringOptionalTax residence country for the entity, if different from the individual.
id_typestringOptionalType of identification document provided.
legal_statusstringRequired within parentLegal status of the individual contractor.
personal_idstringOptionalPassport or national ID number. Required when tax_residence is not US.
phonestringOptionalPhone number in E.164 format.
provincestringOptionalProvince or state code within the country.
ssnstringOptionalSocial Security Number (9 digits, no dashes). Required when tax_residence is US.
streetstringRequired within parentStreet address of the contractor.
tax_residencestringOptionalTax residence country as an ISO 3166-1 alpha-2 code. Defaults to the country field if omitted.
timezonestringOptionalIANA timezone identifier.
zipstringRequired within parentPostal or ZIP code.

Create a new worker — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a new worker — 201 response body — data

Referenced models: Create a new worker — 201 response body — data

Create a new worker — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringRequired within parentAssociated contract ID
Minimum length: 1
profile_idstringRequired within parentCreated profile ID
Minimum length: 1
user_idstringRequired within parentCreated user ID
Minimum length: 1

Create a new worker — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
companyModelRequired within parentExpand Create a new worker — request body — body data company
contract_idstringRequired within parentAssociated contract ID
Minimum length: 1
emailstringRequired within parentWorker's email address
Format: email
Minimum length: 5
first_namestringRequired within parentWorker's first name
Minimum length: 1
last_namestringRequired within parentWorker's last name
Minimum length: 1
middle_namestring or nullOptionalWorker's middle name
preferred_firstnamestring or nullOptionalWorker's preferred first name
preferred_lastNamestring or nullOptionalWorker's preferred last name
preferred_namestring or nullOptionalWorker's preferred name
profile_typestringRequired within parentType of worker profile
One of: CONTRACTOR, EOR
timezonestringRequired within parentWorker's timezone

Referenced models: Create a new worker — request body — body data company

Create a new worker — request body — body data company

FieldTypePresenceDescription and constraints
$objectRoot
personalModelRequired within parentExpand Create a new worker — request body — body data company personal
typestringRequired within parentType of company registration
One of: COMPANY, INDIVIDUAL

Referenced models: Create a new worker — request body — body data company personal

Create a new worker — request body — body data company personal

FieldTypePresenceDescription and constraints
$objectRoot
citizenstringRequired within parentCitizenship country code
citystringRequired within parentCity
countrystringOptionalCountry code
entity_tax_residencestringOptionalEntity tax residence (only applicable for company type)
id_typestringOptionalType of identification
legal_statusstringOptionalLegal status (required only when type is INDIVIDUAL)
personal_idnumberRequired within parentPersonal identification number
Format: double
phonenumberRequired within parentPhone number
Format: double
provincestring or nullOptionalProvince/State
streetstringRequired within parentStreet address
tax_residencestringOptionalTax residence country code
timezonestringOptionalPersonal timezone
zipnumberRequired within parentZip/Postal code
Format: double

Create a tax form for the authenticated worker — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

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 created tax form.
Format: uuid

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

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 / 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: 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

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"propertyName": "form_type"}
$ (oneOf 1)objectAlternativeW9_INDIVIDUAL variant
$ (oneOf 1).addressstringRequired within parentStreet address. Maximum 40 characters for 1099 reporting compliance.
Maximum length: 40
$ (oneOf 1).business_namestring or nullOptionalBusiness name. Only applicable when is_disregarded_entity is true.
Maximum length: 40
$ (oneOf 1).citystringRequired within parentCity name.
Maximum length: 40
Minimum length: 1
$ (oneOf 1).client_legal_entity_idstringRequired within parentPublic ID of the client's legal entity.
Format: uuid
$ (oneOf 1).contractor_signaturestringRequired within parentContractor's digital signature.
Maximum length: 100
Minimum length: 1
$ (oneOf 1).countrystringRequired within parentISO 3166-1 alpha-2 country code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 1).first_namestringRequired within parentLegal first name.
Maximum length: 40
$ (oneOf 1).form_typestringRequired within parentDiscriminator value: W9_INDIVIDUAL
One of: W9_INDIVIDUAL
$ (oneOf 1).is_disregarded_entitybooleanOptionalWhether this is a disregarded entity.
Default: false
$ (oneOf 1).is_subject_backup_withholdingbooleanOptionalWhether the contractor is subject to backup withholding.
Default: false
$ (oneOf 1).last_namestringRequired within parentLegal last name.
Maximum length: 40
$ (oneOf 1).middle_namestringOptionalLegal middle name.
Maximum length: 100
$ (oneOf 1).statestring or nullOptionalUS state code.
Maximum length: 10
$ (oneOf 1).tax_numberModelRequired within parentExpand Create a tax form for the authenticated worker — request body — body / data / form_type: W9 INDIVIDUAL tax number
Taxpayer identification number.
$ (oneOf 1).zip_codestringRequired within parentZIP/postal code. Must be a valid US ZIP code for US addresses.
$ (oneOf 2)objectAlternativeW9_COMPANY variant
$ (oneOf 2).addressstringRequired within parentStreet address.
Maximum length: 40
$ (oneOf 2).business_namestringRequired within parentBusiness name.
Maximum length: 40
Minimum length: 1
$ (oneOf 2).citystringRequired within parentCity name.
Maximum length: 40
Minimum length: 1
$ (oneOf 2).client_legal_entity_idstringRequired within parentPublic ID of the client's legal entity.
Format: uuid
$ (oneOf 2).contractor_signaturestringRequired within parentAuthorized signer's digital signature.
Maximum length: 100
Minimum length: 1
$ (oneOf 2).countrystringRequired within parentISO 3166-1 alpha-2 country code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 2).doing_business_asstring or nullOptionalDBA name.
Maximum length: 50
$ (oneOf 2).federal_tax_classificationModelRequired within parentExpand 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_typestringRequired within parentDiscriminator value: W9_COMPANY
One of: W9_COMPANY
$ (oneOf 2).is_subject_backup_withholdingbooleanOptionalWhether the contractor is subject to backup withholding.
Default: false
$ (oneOf 2).statestring or nullOptionalUS state code.
Maximum length: 10
$ (oneOf 2).tax_numberModelRequired within parentExpand Create a tax form for the authenticated worker — request body — body / data / form_type: W9 COMPANY tax number
Taxpayer identification number.
$ (oneOf 2).zip_codestringRequired within parentZIP/postal code.
$ (oneOf 3)objectAlternativeW8_BEN variant
$ (oneOf 3).addressstringRequired within parentStreet address.
Maximum length: 100
$ (oneOf 3).address_line2string or nullOptionalStreet address line 2.
Maximum length: 100
$ (oneOf 3).citystring or nullOptionalCity name.
Maximum length: 50
Minimum length: 1
$ (oneOf 3).client_legal_entity_idstringRequired within parentPublic ID of the client's legal entity.
Format: uuid
$ (oneOf 3).contractor_signaturestringRequired within parentContractor's digital signature.
Maximum length: 100
Minimum length: 1
$ (oneOf 3).countrystringRequired within parentISO 3166-1 alpha-2 country code of permanent residence.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 3).country_of_citizenshipstringRequired within parentISO 3166-1 alpha-2 country code of citizenship.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 3).date_of_birthstring or nullOptionalDate of birth. Must be at least 18 years ago and no more than 100 years ago.
Format: date-time
$ (oneOf 3).first_namestringRequired within parentLegal first name.
Maximum length: 100
$ (oneOf 3).form_typestringRequired within parentDiscriminator value: W8_BEN
One of: W8_BEN
$ (oneOf 3).is_certified_and_agreedboolean or nullOptionalCertification that the signer has read and agrees with the certification information.
Default: false
$ (oneOf 3).is_disregarded_entitybooleanOptionalWhether this is a disregarded entity.
Default: false
$ (oneOf 3).is_ftin_not_legally_requiredbooleanOptionalCheck if FTIN is not legally required in your country of residence.
Default: false
$ (oneOf 3).is_tax_treaty_enabledboolean or nullOptionalWhether the contractor claims tax treaty benefits.
Default: false
$ (oneOf 3).last_namestringRequired within parentLegal last name.
Maximum length: 100
$ (oneOf 3).mailing_addressJSONOptionalMailing address if different from permanent residence.
$ (oneOf 3).mailing_address (oneOf 1)ModelAlternativeExpand 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)nullAlternative
$ (oneOf 3).middle_namestring or nullOptionalLegal middle name.
Maximum length: 100
$ (oneOf 3).print_name_of_signerstring or nullOptionalPrinted name of the signer.
Maximum length: 100
$ (oneOf 3).referencing_informationstring or nullOptionalReference number for the form.
Maximum length: 100
$ (oneOf 3).statestring or nullOptionalState or province code.
Maximum length: 10
$ (oneOf 3).tax_numberModelOptionalExpand 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_formJSONOptionalTax treaty benefits details. Applicable when is_tax_treaty_enabled is true.
$ (oneOf 3).tax_treaty_benefits_form (oneOf 1)ModelAlternativeExpand 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)nullAlternative
$ (oneOf 3).us_tax_numberModelOptionalExpand 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_codestringRequired within parentZIP/postal code.
$ (oneOf 4)objectAlternativeW8_BEN_E variant
$ (oneOf 4).addressstringRequired within parentStreet address.
Maximum length: 100
$ (oneOf 4).address_line2string or nullOptionalStreet address line 2.
Maximum length: 100
$ (oneOf 4).citystringRequired within parentCity of residence.
Maximum length: 50
Minimum length: 1
$ (oneOf 4).client_legal_entity_idstringRequired within parentPublic ID of the client's legal entity.
Format: uuid
$ (oneOf 4).contractor_signaturestringRequired within parentAuthorized signer's digital signature.
Maximum length: 100
Minimum length: 1
$ (oneOf 4).countrystringRequired within parentISO 3166-1 alpha-2 country code of permanent residence.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 4).country_of_citizenshipstringRequired within parentISO 3166-1 alpha-2 country code of incorporation/organization.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 4).date_of_birthstring or nullOptionalDate of birth of the beneficial owner.
Format: date-time
$ (oneOf 4).entity_countrystring or nullRequired within parentISO 3166-1 alpha-2 country code of the entity.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 4).entity_typestringRequired within parentChapter 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_statusstringRequired within parentFATCA (Foreign Account Tax Compliance Act) status.
One of: ACTIVE_NFFE, PASSIVE_NFFE
$ (oneOf 4).form_typestringRequired within parentDiscriminator value: W8_BEN_E
One of: W8_BEN_E
$ (oneOf 4).giinstring or nullOptionalGlobal Intermediary Identification Number (19 characters).
Maximum length: 19
Minimum length: 19
$ (oneOf 4).has_substantial_us_ownerbooleanOptionalWhether the entity has a substantial US owner. Required when fatca_status is 'PASSIVE_NFFE'.
Default: false
$ (oneOf 4).is_entity_certification_confirmedboolean or nullOptionalCertification that the entity is the beneficial owner of all income.
Default: false
$ (oneOf 4).is_ftin_not_legally_requiredbooleanOptionalCheck if FTIN is not legally required in your country.
Default: false
$ (oneOf 4).is_tax_treaty_enabledboolean or nullOptionalWhether the entity claims tax treaty benefits.
Default: false
$ (oneOf 4).mailing_addressJSONOptionalMailing address if different from permanent residence.
$ (oneOf 4).mailing_address (oneOf 1)ModelAlternativeExpand 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)nullAlternative
$ (oneOf 4).name_of_disregarded_entitystring or nullOptionalName of the disregarded entity, if applicable.
Maximum length: 100
$ (oneOf 4).name_of_organizationstringRequired within parentName of the organization.
Maximum length: 100
$ (oneOf 4).print_name_of_signerstring or nullOptionalPrinted name of the authorized signer.
Maximum length: 100
$ (oneOf 4).referencing_informationstring or nullOptionalReference number for the form.
Maximum length: 100
$ (oneOf 4).statestring or nullOptionalState or province code.
Maximum length: 10
$ (oneOf 4).tax_numberModelOptionalExpand 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_formJSONOptionalTax treaty benefits details.
$ (oneOf 4).tax_treaty_benefits_form (oneOf 1)ModelAlternativeExpand 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)nullAlternative
$ (oneOf 4).us_tax_numberModelOptionalExpand 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_codestringRequired within parentZIP/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

Get a download URL for one compliance document of a worker contract — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a download URL for one compliance document of a worker contract — 200 response body — data

Referenced models: Get a download URL for one compliance document of a worker contract — 200 response body — data

Get a download URL for one compliance document of a worker contract — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
expires_atJSONRequired within parent
expires_at (anyOf 1)stringAlternativeWhen the URL stops working. Null when the URL is not time-limited.
Format: date-time
expires_at (anyOf 2)nullAlternativeWhen the URL stops working. Null when the URL is not time-limited.
Format: date-time
is_external_urlJSONOptional
is_external_url (anyOf 1)booleanAlternativeReserved. Not populated on this endpoint today.
is_external_url (anyOf 2)nullAlternativeReserved. Not populated on this endpoint today.
updated_atJSONOptional
updated_at (anyOf 1)stringAlternativeReserved. Not populated on this endpoint today.
Format: date-time
updated_at (anyOf 2)nullAlternativeReserved. Not populated on this endpoint today.
Format: date-time
urlstringRequired within parentTime-limited download URL, valid for about 15 minutes. Fetch it rather than storing it.

Get invoice details by ID — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get invoice details by ID — 200 response body — data
Invoice summary (snake_case; display card fields, amounts, and payment display).

Referenced models: Get invoice details by ID — 200 response body — data

Get invoice details by ID — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootInvoice summary (snake_case; display card fields, amounts, and payment display).
amountJSONOptional
amount (anyOf 1)stringAlternativeAmount before fees.
amount (anyOf 2)nullAlternativeAmount before fees.
created_atstringRequired within parentWhen the invoice record was created (ISO-8601).
Format: date-time
currencystringRequired within parentThree-letter currency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
idstringRequired within parentPublic invoice id.
issued_atJSONOptional
issued_at (anyOf 1)stringAlternativeWhen the invoice was issued, if applicable.
Format: date-time
issued_at (anyOf 2)nullAlternativeWhen the invoice was issued, if applicable.
Format: date-time
payment_display_statusModelOptionalExpand Get invoice details by ID — 200 response body — data payment display status
Derived payment display state for the invoice.
statusstringRequired within parentInvoice workflow status.
titlestringOptionalDisplay title.
totalJSONOptional
total (anyOf 1)stringAlternativeTotal including fees.
total (anyOf 2)nullAlternativeTotal including fees.

Referenced models: Get invoice details by ID — 200 response body — data payment display status

Get invoice details by ID — 200 response body — data payment display status

FieldTypePresenceDescription and constraints
$objectRootDerived payment display state for the invoice.
keystringRequired within parentStable machine key.
labelstringRequired within parentHuman-readable label.

List compliance documents of a worker contract — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentDocuments on this page.
data[]ModelEach itemExpand Retrieve one compliance document of a worker contract — 200 response body — data
has_morebooleanRequired within parentWhether another page follows this one.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeOpaque token to pass as `cursor` to fetch the next page. Null on the last page. Never construct or parse one.
next_cursor (anyOf 2)nullAlternativeOpaque token to pass as `cursor` to fetch the next page. Null on the last page. Never construct or parse one.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of documents for the contract, across every page.
Minimum: 0
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve one compliance document of a worker contract — 200 response body — data

List of worker compliance documents — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand List of worker compliance documents — 200 response body — data

Referenced models: List of worker compliance documents — 200 response body — data

List of worker compliance documents — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
documentsarrayRequired within parentList of compliance documents required for the worker.
documents[]ModelEach itemExpand List of worker compliance documents — 200 response body — data documents item

Referenced models: List of worker compliance documents — 200 response body — data documents item

List of worker compliance documents — 200 response body — data documents item

FieldTypePresenceDescription and constraints
$objectRoot
countryJSONRequired within parent
country (anyOf 1)stringAlternativeISO 3166-1 alpha-2 country code where the document is required.
country (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country code where the document is required.
descriptionstringRequired within parentDescription of the document requirement. Empty string when no description exists.
filenamesarrayRequired within parentList of uploaded file names. Empty array when no files have been uploaded.
filenames[]stringEach item
fillablebooleanRequired within parentWhether the document can be filled through the Deel platform.
has_templatebooleanRequired within parentWhether a template is available for this document.
idstringRequired within parentUnique identifier for the compliance document requirement.
Format: uuid
is_acknowledgement_only_documentbooleanRequired within parentWhether this document only requires acknowledgement without file upload.
is_consent_requiredbooleanOptionalWhether consent is required for acknowledgement-only documents. Only present when is_acknowledgement_only_document is true.
is_optionalbooleanRequired within parentWhether the document is optional for the worker. Also true when the document is required within 30 days.
namestringRequired within parentDisplay name of the compliance document.
rejection_messagestringRequired within parentPlain text message explaining why the document was rejected. Empty string when no rejection message exists.
required_in_30_daysbooleanRequired within parentWhether the document is required within 30 days of employment start.
statusJSONRequired within parentReview status of the uploaded document, null if no document has been uploaded yet.
status (anyOf 1)stringAlternativeReview status of the uploaded document, null if no document has been uploaded yet.
Known values: AWAITING_EX_REVIEW, AWAITING_EXTERNAL_REVIEW, REJECTED, APPROVED, ON_HOLD
status (anyOf 2)nullAlternative
uploaded_atJSONRequired within parent
uploaded_at (anyOf 1)stringAlternativeISO 8601 timestamp when the document was uploaded, null if no document has been uploaded.
Format: date-time
uploaded_at (anyOf 2)nullAlternativeISO 8601 timestamp when the document was uploaded, null if no document has been uploaded.
Format: date-time

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 / 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]+)?$

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 / 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: 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

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"propertyName": "form_type"}
$ (anyOf 1)objectAlternativeW9_INDIVIDUAL variant
$ (anyOf 1).addressstringOptionalStreet address of permanent residence.
$ (anyOf 1).business_nameJSONOptional
$ (anyOf 1).business_name (anyOf 1)stringAlternativeBusiness name. Present on W9_COMPANY forms and disregarded-entity W9_INDIVIDUAL forms.
$ (anyOf 1).business_name (anyOf 2)nullAlternativeBusiness name. Present on W9_COMPANY forms and disregarded-entity W9_INDIVIDUAL forms.
$ (anyOf 1).cityJSONOptional
$ (anyOf 1).city (anyOf 1)stringAlternativeCity name.
$ (anyOf 1).city (anyOf 2)nullAlternativeCity name.
$ (anyOf 1).client_legal_entity_idstringRequired within parentPublic ID of the client's legal entity the form was submitted against.
Format: uuid
$ (anyOf 1).contractor_signaturestringOptionalThe signer's digital signature.
$ (anyOf 1).countrystringOptionalISO 3166-1 alpha-2 country code of permanent residence.
$ (anyOf 1).created_atstringRequired within parentTimestamp of when the tax form was created.
Format: date-time
$ (anyOf 1).first_namestringOptionalLegal first name. Present on W9_INDIVIDUAL and W8_BEN forms.
$ (anyOf 1).form_typestringRequired within parentDiscriminator value: W9_INDIVIDUAL
Known values: W9_INDIVIDUAL
$ (anyOf 1).idstringRequired within parentThe public ID (UUID) of the tax form.
Format: uuid
$ (anyOf 1).is_disregarded_entitybooleanOptionalWhether this is a disregarded entity. Present on W9_INDIVIDUAL and W8_BEN forms.
$ (anyOf 1).is_subject_backup_withholdingbooleanOptionalWhether the contractor is subject to backup withholding. Present on W-9 forms.
$ (anyOf 1).last_namestringOptionalLegal last name. Present on W9_INDIVIDUAL and W8_BEN forms.
$ (anyOf 1).middle_namestringOptionalLegal middle name. Present on W9_INDIVIDUAL and W8_BEN forms.
$ (anyOf 1).pdf_urlJSONOptional
$ (anyOf 1).pdf_url (anyOf 1)stringAlternativePre-signed download URL for the generated form PDF. The link expires about 15 minutes after the response is issued — download promptly or request the list again. Null while the PDF has not been generated yet.
$ (anyOf 1).pdf_url (anyOf 2)nullAlternativePre-signed download URL for the generated form PDF. The link expires about 15 minutes after the response is issued — download promptly or request the list again. Null while the PDF has not been generated yet.
$ (anyOf 1).stateJSONOptional
$ (anyOf 1).state (anyOf 1)stringAlternativeState or province code.
$ (anyOf 1).state (anyOf 2)nullAlternativeState or province code.
$ (anyOf 1).tax_numberModelOptionalExpand List tax forms for the authenticated worker — 200 response body — data / item / form_type: W9 COMPANY tax number
Taxpayer identification number. Returned unmasked.
$ (anyOf 1).updated_atstringRequired within parentTimestamp of when the tax form was last updated.
Format: date-time
$ (anyOf 1).zip_codestringOptionalZIP/postal code.
$ (anyOf 2)objectAlternativeW9_COMPANY variant
$ (anyOf 2).addressstringOptionalStreet address of permanent residence.
$ (anyOf 2).business_nameJSONOptional
$ (anyOf 2).business_name (anyOf 1)stringAlternativeBusiness name. Present on W9_COMPANY forms and disregarded-entity W9_INDIVIDUAL forms.
$ (anyOf 2).business_name (anyOf 2)nullAlternativeBusiness name. Present on W9_COMPANY forms and disregarded-entity W9_INDIVIDUAL forms.
$ (anyOf 2).cityJSONOptional
$ (anyOf 2).city (anyOf 1)stringAlternativeCity name.
$ (anyOf 2).city (anyOf 2)nullAlternativeCity name.
$ (anyOf 2).client_legal_entity_idstringRequired within parentPublic ID of the client's legal entity the form was submitted against.
Format: uuid
$ (anyOf 2).contractor_signaturestringOptionalThe signer's digital signature.
$ (anyOf 2).countrystringOptionalISO 3166-1 alpha-2 country code of permanent residence.
$ (anyOf 2).created_atstringRequired within parentTimestamp of when the tax form was created.
Format: date-time
$ (anyOf 2).doing_business_asJSONOptional
$ (anyOf 2).doing_business_as (anyOf 1)stringAlternativeDBA name. Present on W9_COMPANY forms.
$ (anyOf 2).doing_business_as (anyOf 2)nullAlternativeDBA name. Present on W9_COMPANY forms.
$ (anyOf 2).federal_tax_classificationModelOptionalExpand List tax forms for the authenticated worker — 200 response body — data / item / form_type: W9 COMPANY federal tax classification
Federal tax classification. Present on W9_COMPANY forms.
$ (anyOf 2).form_typestringRequired within parentDiscriminator value: W9_COMPANY
Known values: W9_COMPANY
$ (anyOf 2).idstringRequired within parentThe public ID (UUID) of the tax form.
Format: uuid
$ (anyOf 2).is_subject_backup_withholdingbooleanOptionalWhether the contractor is subject to backup withholding. Present on W-9 forms.
$ (anyOf 2).pdf_urlJSONOptional
$ (anyOf 2).pdf_url (anyOf 1)stringAlternativePre-signed download URL for the generated form PDF. The link expires about 15 minutes after the response is issued — download promptly or request the list again. Null while the PDF has not been generated yet.
$ (anyOf 2).pdf_url (anyOf 2)nullAlternativePre-signed download URL for the generated form PDF. The link expires about 15 minutes after the response is issued — download promptly or request the list again. Null while the PDF has not been generated yet.
$ (anyOf 2).stateJSONOptional
$ (anyOf 2).state (anyOf 1)stringAlternativeState or province code.
$ (anyOf 2).state (anyOf 2)nullAlternativeState or province code.
$ (anyOf 2).tax_numberModelOptionalExpand List tax forms for the authenticated worker — 200 response body — data / item / form_type: W9 COMPANY tax number
Taxpayer identification number. Returned unmasked.
$ (anyOf 2).updated_atstringRequired within parentTimestamp of when the tax form was last updated.
Format: date-time
$ (anyOf 2).zip_codestringOptionalZIP/postal code.
$ (anyOf 3)objectAlternativeW8_BEN variant
$ (anyOf 3).addressstringOptionalStreet address of permanent residence.
$ (anyOf 3).address_line2JSONOptional
$ (anyOf 3).address_line2 (anyOf 1)stringAlternativeStreet address line 2. Present on W8_BEN and W8_BEN_E forms.
$ (anyOf 3).address_line2 (anyOf 2)nullAlternativeStreet address line 2. Present on W8_BEN and W8_BEN_E forms.
$ (anyOf 3).cityJSONOptional
$ (anyOf 3).city (anyOf 1)stringAlternativeCity name.
$ (anyOf 3).city (anyOf 2)nullAlternativeCity name.
$ (anyOf 3).client_legal_entity_idstringRequired within parentPublic ID of the client's legal entity the form was submitted against.
Format: uuid
$ (anyOf 3).contractor_signaturestringOptionalThe signer's digital signature.
$ (anyOf 3).countrystringOptionalISO 3166-1 alpha-2 country code of permanent residence.
$ (anyOf 3).country_of_citizenshipstringOptionalISO 3166-1 alpha-2 country code of citizenship (W8_BEN) or incorporation (W8_BEN_E).
$ (anyOf 3).created_atstringRequired within parentTimestamp of when the tax form was created.
Format: date-time
$ (anyOf 3).date_of_birthJSONOptional
$ (anyOf 3).date_of_birth (anyOf 1)stringAlternativeDate of birth. Present on W8_BEN and W8_BEN_E forms.
Format: date-time
$ (anyOf 3).date_of_birth (anyOf 2)nullAlternativeDate of birth. Present on W8_BEN and W8_BEN_E forms.
Format: date-time
$ (anyOf 3).first_namestringOptionalLegal first name. Present on W9_INDIVIDUAL and W8_BEN forms.
$ (anyOf 3).form_typestringRequired within parentDiscriminator value: W8_BEN
Known values: W8_BEN
$ (anyOf 3).idstringRequired within parentThe public ID (UUID) of the tax form.
Format: uuid
$ (anyOf 3).is_certified_and_agreedJSONOptional
$ (anyOf 3).is_certified_and_agreed (anyOf 1)booleanAlternativeCertification that the signer has read and agrees with the certification information. Present on W8_BEN forms.
$ (anyOf 3).is_certified_and_agreed (anyOf 2)nullAlternativeCertification that the signer has read and agrees with the certification information. Present on W8_BEN forms.
$ (anyOf 3).is_disregarded_entitybooleanOptionalWhether this is a disregarded entity. Present on W9_INDIVIDUAL and W8_BEN forms.
$ (anyOf 3).is_ftin_not_legally_requiredbooleanOptionalWhether an FTIN is not legally required in the country of residence. Present on W-8 forms.
$ (anyOf 3).is_tax_treaty_enabledJSONOptional
$ (anyOf 3).is_tax_treaty_enabled (anyOf 1)booleanAlternativeWhether tax treaty benefits are claimed. Present on W-8 forms.
$ (anyOf 3).is_tax_treaty_enabled (anyOf 2)nullAlternativeWhether tax treaty benefits are claimed. Present on W-8 forms.
$ (anyOf 3).last_namestringOptionalLegal last name. Present on W9_INDIVIDUAL and W8_BEN forms.
$ (anyOf 3).mailing_addressJSONOptionalMailing address if different from permanent residence. Present on W8_BEN and W8_BEN_E forms.
$ (anyOf 3).mailing_address (anyOf 1)ModelAlternativeExpand 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
$ (anyOf 3).mailing_address (anyOf 2)nullAlternative
$ (anyOf 3).middle_namestringOptionalLegal middle name. Present on W9_INDIVIDUAL and W8_BEN forms.
$ (anyOf 3).pdf_urlJSONOptional
$ (anyOf 3).pdf_url (anyOf 1)stringAlternativePre-signed download URL for the generated form PDF. The link expires about 15 minutes after the response is issued — download promptly or request the list again. Null while the PDF has not been generated yet.
$ (anyOf 3).pdf_url (anyOf 2)nullAlternativePre-signed download URL for the generated form PDF. The link expires about 15 minutes after the response is issued — download promptly or request the list again. Null while the PDF has not been generated yet.
$ (anyOf 3).print_name_of_signerJSONOptional
$ (anyOf 3).print_name_of_signer (anyOf 1)stringAlternativePrinted name of the signer. Present on W-8 forms.
$ (anyOf 3).print_name_of_signer (anyOf 2)nullAlternativePrinted name of the signer. Present on W-8 forms.
$ (anyOf 3).referencing_informationJSONOptional
$ (anyOf 3).referencing_information (anyOf 1)stringAlternativeReference number for the form. Present on W-8 forms.
$ (anyOf 3).referencing_information (anyOf 2)nullAlternativeReference number for the form. Present on W-8 forms.
$ (anyOf 3).stateJSONOptional
$ (anyOf 3).state (anyOf 1)stringAlternativeState or province code.
$ (anyOf 3).state (anyOf 2)nullAlternativeState or province code.
$ (anyOf 3).tax_numberModelOptionalExpand List tax forms for the authenticated worker — 200 response body — data / item / form_type: W8 BEN tax number
Foreign taxpayer identification number. Returned unmasked.
$ (anyOf 3).tax_treaty_benefits_formJSONOptionalTax treaty benefits details. Present when treaty benefits are claimed.
$ (anyOf 3).tax_treaty_benefits_form (anyOf 1)ModelAlternativeExpand 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
$ (anyOf 3).tax_treaty_benefits_form (anyOf 2)nullAlternative
$ (anyOf 3).updated_atstringRequired within parentTimestamp of when the tax form was last updated.
Format: date-time
$ (anyOf 3).us_tax_numberModelOptionalExpand List tax forms for the authenticated worker — 200 response body — data / item / form_type: W8 BEN us tax number
US Taxpayer Identification Number. Present on W8_BEN and W8_BEN_E forms. Returned unmasked.
$ (anyOf 3).zip_codestringOptionalZIP/postal code.
$ (anyOf 4)objectAlternativeW8_BEN_E variant
$ (anyOf 4).addressstringOptionalStreet address of permanent residence.
$ (anyOf 4).address_line2JSONOptional
$ (anyOf 4).address_line2 (anyOf 1)stringAlternativeStreet address line 2. Present on W8_BEN and W8_BEN_E forms.
$ (anyOf 4).address_line2 (anyOf 2)nullAlternativeStreet address line 2. Present on W8_BEN and W8_BEN_E forms.
$ (anyOf 4).cityJSONOptional
$ (anyOf 4).city (anyOf 1)stringAlternativeCity name.
$ (anyOf 4).city (anyOf 2)nullAlternativeCity name.
$ (anyOf 4).client_legal_entity_idstringRequired within parentPublic ID of the client's legal entity the form was submitted against.
Format: uuid
$ (anyOf 4).contractor_signaturestringOptionalThe signer's digital signature.
$ (anyOf 4).countrystringOptionalISO 3166-1 alpha-2 country code of permanent residence.
$ (anyOf 4).country_of_citizenshipstringOptionalISO 3166-1 alpha-2 country code of citizenship (W8_BEN) or incorporation (W8_BEN_E).
$ (anyOf 4).created_atstringRequired within parentTimestamp of when the tax form was created.
Format: date-time
$ (anyOf 4).date_of_birthJSONOptional
$ (anyOf 4).date_of_birth (anyOf 1)stringAlternativeDate of birth. Present on W8_BEN and W8_BEN_E forms.
Format: date-time
$ (anyOf 4).date_of_birth (anyOf 2)nullAlternativeDate of birth. Present on W8_BEN and W8_BEN_E forms.
Format: date-time
$ (anyOf 4).entity_countryJSONOptional
$ (anyOf 4).entity_country (anyOf 1)stringAlternativeISO 3166-1 alpha-2 country code of the entity. Present on W8_BEN_E forms.
$ (anyOf 4).entity_country (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country code of the entity. Present on W8_BEN_E forms.
$ (anyOf 4).entity_typestringOptionalChapter 3 entity type. Present on W8_BEN_E forms.
Known values: 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
$ (anyOf 4).fatca_statusstringOptionalFATCA (Foreign Account Tax Compliance Act) status. Present on W8_BEN_E forms.
Known values: ACTIVE_NFFE, PASSIVE_NFFE
$ (anyOf 4).form_typestringRequired within parentDiscriminator value: W8_BEN_E
Known values: W8_BEN_E
$ (anyOf 4).giinJSONOptional
$ (anyOf 4).giin (anyOf 1)stringAlternativeGlobal Intermediary Identification Number. Present on W8_BEN_E forms.
$ (anyOf 4).giin (anyOf 2)nullAlternativeGlobal Intermediary Identification Number. Present on W8_BEN_E forms.
$ (anyOf 4).has_substantial_us_ownerbooleanOptionalWhether the entity has a substantial US owner. Present on W8_BEN_E forms.
$ (anyOf 4).idstringRequired within parentThe public ID (UUID) of the tax form.
Format: uuid
$ (anyOf 4).is_entity_certification_confirmedJSONOptional
$ (anyOf 4).is_entity_certification_confirmed (anyOf 1)booleanAlternativeCertification that the entity is the beneficial owner of all income. Present on W8_BEN_E forms.
$ (anyOf 4).is_entity_certification_confirmed (anyOf 2)nullAlternativeCertification that the entity is the beneficial owner of all income. Present on W8_BEN_E forms.
$ (anyOf 4).is_ftin_not_legally_requiredbooleanOptionalWhether an FTIN is not legally required in the country of residence. Present on W-8 forms.
$ (anyOf 4).is_tax_treaty_enabledJSONOptional
$ (anyOf 4).is_tax_treaty_enabled (anyOf 1)booleanAlternativeWhether tax treaty benefits are claimed. Present on W-8 forms.
$ (anyOf 4).is_tax_treaty_enabled (anyOf 2)nullAlternativeWhether tax treaty benefits are claimed. Present on W-8 forms.
$ (anyOf 4).mailing_addressJSONOptionalMailing address if different from permanent residence. Present on W8_BEN and W8_BEN_E forms.
$ (anyOf 4).mailing_address (anyOf 1)ModelAlternativeExpand 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
$ (anyOf 4).mailing_address (anyOf 2)nullAlternative
$ (anyOf 4).name_of_disregarded_entityJSONOptional
$ (anyOf 4).name_of_disregarded_entity (anyOf 1)stringAlternativeName of the disregarded entity, if applicable. Present on W8_BEN_E forms.
$ (anyOf 4).name_of_disregarded_entity (anyOf 2)nullAlternativeName of the disregarded entity, if applicable. Present on W8_BEN_E forms.
$ (anyOf 4).name_of_organizationstringOptionalName of the organization. Present on W8_BEN_E forms.
$ (anyOf 4).pdf_urlJSONOptional
$ (anyOf 4).pdf_url (anyOf 1)stringAlternativePre-signed download URL for the generated form PDF. The link expires about 15 minutes after the response is issued — download promptly or request the list again. Null while the PDF has not been generated yet.
$ (anyOf 4).pdf_url (anyOf 2)nullAlternativePre-signed download URL for the generated form PDF. The link expires about 15 minutes after the response is issued — download promptly or request the list again. Null while the PDF has not been generated yet.
$ (anyOf 4).print_name_of_signerJSONOptional
$ (anyOf 4).print_name_of_signer (anyOf 1)stringAlternativePrinted name of the signer. Present on W-8 forms.
$ (anyOf 4).print_name_of_signer (anyOf 2)nullAlternativePrinted name of the signer. Present on W-8 forms.
$ (anyOf 4).referencing_informationJSONOptional
$ (anyOf 4).referencing_information (anyOf 1)stringAlternativeReference number for the form. Present on W-8 forms.
$ (anyOf 4).referencing_information (anyOf 2)nullAlternativeReference number for the form. Present on W-8 forms.
$ (anyOf 4).stateJSONOptional
$ (anyOf 4).state (anyOf 1)stringAlternativeState or province code.
$ (anyOf 4).state (anyOf 2)nullAlternativeState or province code.
$ (anyOf 4).tax_numberModelOptionalExpand List tax forms for the authenticated worker — 200 response body — data / item / form_type: W8 BEN tax number
Foreign taxpayer identification number. Returned unmasked.
$ (anyOf 4).tax_treaty_benefits_formJSONOptionalTax treaty benefits details. Present when treaty benefits are claimed.
$ (anyOf 4).tax_treaty_benefits_form (anyOf 1)ModelAlternativeExpand 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
$ (anyOf 4).tax_treaty_benefits_form (anyOf 2)nullAlternative
$ (anyOf 4).updated_atstringRequired within parentTimestamp of when the tax form was last updated.
Format: date-time
$ (anyOf 4).us_tax_numberModelOptionalExpand List tax forms for the authenticated worker — 200 response body — data / item / form_type: W8 BEN us tax number
US Taxpayer Identification Number. Present on W8_BEN and W8_BEN_E forms. Returned unmasked.
$ (anyOf 4).zip_codestringOptionalZIP/postal code.

Referenced models: List tax forms for the authenticated worker — 200 response body — data / item / form_type: W9 COMPANY tax number, List tax forms for the authenticated worker — 200 response body — data / item / form_type: W9 COMPANY federal tax classification, 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, List tax forms for the authenticated worker — 200 response body — data / item / form_type: W8 BEN tax number, 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, List tax forms for the authenticated worker — 200 response body — data / item / form_type: W8 BEN us tax number, 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

Retrieve IC worker invoice PDF download link — 200 response body

FieldTypePresenceDescription and constraints
$objectRootEnvelope containing a time-limited signed URL to the invoice PDF.
dataModelRequired within parentExpand Retrieve IC worker invoice PDF download link — 200 response body — data
Payload with the signed download URL.

Referenced models: Retrieve IC worker invoice PDF download link — 200 response body — data

Retrieve IC worker invoice PDF download link — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootPayload with the signed download URL.
urlstringRequired within parentHTTPS URL to download the invoice PDF.
Format: uri

Retrieve one compliance document of a worker contract — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve one compliance document of a worker contract — 200 response body — data

Referenced models: Retrieve one compliance document of a worker contract — 200 response body — data

Retrieve one compliance document of a worker contract — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
countryJSONRequired within parent
country (anyOf 1)stringAlternativeISO 3166-1 alpha-2 country code the requirement applies to. Null for a requirement that applies everywhere.
country (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country code the requirement applies to. Null for a requirement that applies everywhere.
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeWhen the submission was created. Carries the same value as `uploaded_at`.
Format: date-time
created_at (anyOf 2)nullAlternativeWhen the submission was created. Carries the same value as `uploaded_at`.
Format: date-time
descriptionstringRequired within parentWhat the document asks for, in the worker language. Empty string when the requirement has no description.
filenamesarrayRequired within parentNames of the files submitted against this requirement. Empty array when nothing has been submitted.
filenames[]stringEach item
has_templatebooleanRequired within parentWhether a template is provided for this document.
idstringRequired within parentPublic UUID of the compliance document requirement. Use it as `document_id` on the other endpoints.
Format: uuid
is_acknowledgement_only_documentbooleanRequired within parentWhether the document only has to be acknowledged, with no file to submit.
is_consent_requiredbooleanOptionalWhether the worker has to consent. Present only for acknowledgement-only documents that declare the flag.
is_requiredbooleanRequired within parentWhether the worker has to submit this document. A requirement with a 30-day grace period after the employment start reads `true`: it is required, only not immediately.
namestringRequired within parentDisplay name of the document, in the worker language.
reviewJSONOptionalOutcome of the Deel review of the submission. Present only for worker types whose submissions are reviewed, and only once a review exists. Absent for Global Payroll documents and for contractor documents that are not reviewed.
review (anyOf 1)ModelAlternativeExpand Retrieve one compliance document of a worker contract — 200 response body — data review rejection message, status
review (anyOf 2)nullAlternative
submission_statusJSONRequired within parent
submission_status (anyOf 1)stringAlternativeReads `REVIEWING` while a submission is not final yet. Null at every other time.
submission_status (anyOf 2)nullAlternativeReads `REVIEWING` while a submission is not final yet. Null at every other time.
updated_atJSONRequired within parent
updated_at (anyOf 1)stringAlternativeWhen the submission was last changed. Null when nothing has been submitted.
Format: date-time
updated_at (anyOf 2)nullAlternativeWhen the submission was last changed. Null when nothing has been submitted.
Format: date-time
uploaded_atJSONRequired within parent
uploaded_at (anyOf 1)stringAlternativeWhen the submission was created. Null when nothing has been submitted.
Format: date-time
uploaded_at (anyOf 2)nullAlternativeWhen the submission was created. Null when nothing has been submitted.
Format: date-time

Referenced models: Retrieve one compliance document of a worker contract — 200 response body — data review rejection message, status

Retrieve one compliance document of a worker contract — 200 response body — data review rejection message, status

FieldTypePresenceDescription and constraints
$objectRootOutcome of the Deel review of the submission. Present only for worker types whose submissions are reviewed, and only once a review exists. Absent for Global Payroll documents and for contractor documents that are not reviewed.
rejection_messageJSONRequired within parent
rejection_message (anyOf 1)stringAlternativeWhy the submission was rejected, in the worker language. Null unless the status is `REJECTED`.
rejection_message (anyOf 2)nullAlternativeWhy the submission was rejected, in the worker language. Null unless the status is `REJECTED`.
statusstringRequired within parentWhere the submission sits in the review.
Known values: AWAITING_EX_REVIEW, AWAITING_EXTERNAL_REVIEW, REJECTED, APPROVED, ON_HOLD

Submit files for one compliance document of a worker contract — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
filesarrayRequired within parentFiles to submit against the requirement. Allowed types: pdf, png, jpg, jpeg, heic.
files[]ModelEach itemExpand Submit files for one compliance document of a worker contract — request body — body data files item

Referenced models: Submit files for one compliance document of a worker contract — request body — body data files item

Submit files for one compliance document of a worker contract — request body — body data files item

FieldTypePresenceDescription and constraints
$objectRoot
content_typestringRequired within parentMIME type of the file.
Maximum length: 255
file_idstringRequired within parentFile Service file id.
Format: uuid
one_time_secretstringRequired within parentFile Service one-time secret for that file.
Maximum length: 1024
Minimum length: 1
original_filenamestringRequired within parentOriginal filename, extension included.
Maximum length: 500
Minimum length: 1

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

Update a US tax form for the authenticated worker — request body — body data

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"propertyName": "form_type"}
$ (oneOf 1)objectAlternativeW9_INDIVIDUAL variant
$ (oneOf 1).addressstringRequired within parentStreet address. Maximum 40 characters for 1099 reporting compliance.
Maximum length: 40
$ (oneOf 1).business_namestring or nullOptionalBusiness name. Only applicable when is_disregarded_entity is true.
Maximum length: 40
$ (oneOf 1).citystringRequired within parentCity name.
Maximum length: 40
Minimum length: 1
$ (oneOf 1).contractor_signaturestringOptionalContractor's digital signature.
Maximum length: 100
Minimum length: 1
$ (oneOf 1).countrystringRequired within parentISO 3166-1 alpha-2 country code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 1).first_namestringRequired within parentLegal first name.
Maximum length: 40
$ (oneOf 1).form_typestringRequired within parentDiscriminator value: W9_INDIVIDUAL
One of: W9_INDIVIDUAL
$ (oneOf 1).is_disregarded_entitybooleanOptionalWhether this is a disregarded entity.
Default: false
$ (oneOf 1).is_subject_backup_withholdingbooleanOptionalWhether the contractor is subject to backup withholding.
Default: false
$ (oneOf 1).last_namestringRequired within parentLegal last name.
Maximum length: 40
$ (oneOf 1).middle_namestringOptionalLegal middle name.
Maximum length: 100
$ (oneOf 1).statestring or nullOptionalUS state code.
Maximum length: 10
$ (oneOf 1).tax_numberModelRequired within parentExpand Create a tax form for the authenticated worker — request body — body / data / form_type: W9 INDIVIDUAL tax number
Taxpayer identification number.
$ (oneOf 1).zip_codestringRequired within parentZIP/postal code. Must be a valid US ZIP code for US addresses.
$ (oneOf 2)objectAlternativeW9_COMPANY variant
$ (oneOf 2).addressstringRequired within parentStreet address.
Maximum length: 40
$ (oneOf 2).business_namestringRequired within parentBusiness name.
Maximum length: 40
Minimum length: 1
$ (oneOf 2).citystringRequired within parentCity name.
Maximum length: 40
Minimum length: 1
$ (oneOf 2).contractor_signaturestringOptionalAuthorized signer's digital signature.
Maximum length: 100
Minimum length: 1
$ (oneOf 2).countrystringRequired within parentISO 3166-1 alpha-2 country code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 2).doing_business_asstring or nullOptionalDBA name.
Maximum length: 50
$ (oneOf 2).federal_tax_classificationModelRequired within parentExpand 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_typestringRequired within parentDiscriminator value: W9_COMPANY
One of: W9_COMPANY
$ (oneOf 2).is_subject_backup_withholdingbooleanOptionalWhether the contractor is subject to backup withholding.
Default: false
$ (oneOf 2).statestring or nullOptionalUS state code.
Maximum length: 10
$ (oneOf 2).tax_numberModelRequired within parentExpand Create a tax form for the authenticated worker — request body — body / data / form_type: W9 COMPANY tax number
Taxpayer identification number.
$ (oneOf 2).zip_codestringRequired within parentZIP/postal code.
$ (oneOf 3)objectAlternativeW8_BEN variant
$ (oneOf 3).addressstringRequired within parentStreet address.
Maximum length: 100
$ (oneOf 3).address_line2string or nullOptionalStreet address line 2.
Maximum length: 100
$ (oneOf 3).citystring or nullOptionalCity name.
Maximum length: 50
Minimum length: 1
$ (oneOf 3).contractor_signaturestringOptionalContractor's digital signature.
Maximum length: 100
Minimum length: 1
$ (oneOf 3).countrystringRequired within parentISO 3166-1 alpha-2 country code of permanent residence.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 3).country_of_citizenshipstringRequired within parentISO 3166-1 alpha-2 country code of citizenship.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 3).date_of_birthstring or nullOptionalDate of birth. Must be at least 18 years ago and no more than 100 years ago.
Format: date-time
$ (oneOf 3).first_namestringRequired within parentLegal first name.
Maximum length: 100
$ (oneOf 3).form_typestringRequired within parentDiscriminator value: W8_BEN
One of: W8_BEN
$ (oneOf 3).is_certified_and_agreedboolean or nullOptionalCertification that the signer has read and agrees with the certification information.
Default: false
$ (oneOf 3).is_disregarded_entitybooleanOptionalWhether this is a disregarded entity.
Default: false
$ (oneOf 3).is_ftin_not_legally_requiredbooleanOptionalCheck if FTIN is not legally required in your country of residence.
Default: false
$ (oneOf 3).is_tax_treaty_enabledboolean or nullOptionalWhether the contractor claims tax treaty benefits.
Default: false
$ (oneOf 3).last_namestringRequired within parentLegal last name.
Maximum length: 100
$ (oneOf 3).mailing_addressJSONOptionalMailing address if different from permanent residence.
$ (oneOf 3).mailing_address (oneOf 1)ModelAlternativeExpand 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)nullAlternative
$ (oneOf 3).middle_namestring or nullOptionalLegal middle name.
Maximum length: 100
$ (oneOf 3).print_name_of_signerstring or nullOptionalPrinted name of the signer.
Maximum length: 100
$ (oneOf 3).referencing_informationstring or nullOptionalReference number for the form.
Maximum length: 100
$ (oneOf 3).statestring or nullOptionalState or province code.
Maximum length: 10
$ (oneOf 3).tax_numberModelOptionalExpand 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_formJSONOptionalTax treaty benefits details. Applicable when is_tax_treaty_enabled is true.
$ (oneOf 3).tax_treaty_benefits_form (oneOf 1)ModelAlternativeExpand 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)nullAlternative
$ (oneOf 3).us_tax_numberModelOptionalExpand 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_codestringRequired within parentZIP/postal code.
$ (oneOf 4)objectAlternativeW8_BEN_E variant
$ (oneOf 4).addressstringRequired within parentStreet address.
Maximum length: 100
$ (oneOf 4).address_line2string or nullOptionalStreet address line 2.
Maximum length: 100
$ (oneOf 4).citystringRequired within parentCity of residence.
Maximum length: 50
Minimum length: 1
$ (oneOf 4).contractor_signaturestringOptionalAuthorized signer's digital signature.
Maximum length: 100
Minimum length: 1
$ (oneOf 4).countrystringRequired within parentISO 3166-1 alpha-2 country code of permanent residence.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 4).country_of_citizenshipstringRequired within parentISO 3166-1 alpha-2 country code of incorporation/organization.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 4).date_of_birthstring or nullOptionalDate of birth of the beneficial owner.
Format: date-time
$ (oneOf 4).entity_countrystring or nullRequired within parentISO 3166-1 alpha-2 country code of the entity.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
$ (oneOf 4).entity_typestringRequired within parentChapter 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_statusstringRequired within parentFATCA (Foreign Account Tax Compliance Act) status.
One of: ACTIVE_NFFE, PASSIVE_NFFE
$ (oneOf 4).form_typestringRequired within parentDiscriminator value: W8_BEN_E
One of: W8_BEN_E
$ (oneOf 4).giinstring or nullOptionalGlobal Intermediary Identification Number (19 characters).
Maximum length: 19
Minimum length: 19
$ (oneOf 4).has_substantial_us_ownerbooleanOptionalWhether the entity has a substantial US owner. Required when fatca_status is 'PASSIVE_NFFE'.
Default: false
$ (oneOf 4).is_entity_certification_confirmedboolean or nullOptionalCertification that the entity is the beneficial owner of all income.
Default: false
$ (oneOf 4).is_ftin_not_legally_requiredbooleanOptionalCheck if FTIN is not legally required in your country.
Default: false
$ (oneOf 4).is_tax_treaty_enabledboolean or nullOptionalWhether the entity claims tax treaty benefits.
Default: false
$ (oneOf 4).mailing_addressJSONOptionalMailing address if different from permanent residence.
$ (oneOf 4).mailing_address (oneOf 1)ModelAlternativeExpand 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)nullAlternative
$ (oneOf 4).name_of_disregarded_entitystring or nullOptionalName of the disregarded entity, if applicable.
Maximum length: 100
$ (oneOf 4).name_of_organizationstringRequired within parentName of the organization.
Maximum length: 100
$ (oneOf 4).print_name_of_signerstring or nullOptionalPrinted name of the authorized signer.
Maximum length: 100
$ (oneOf 4).referencing_informationstring or nullOptionalReference number for the form.
Maximum length: 100
$ (oneOf 4).statestring or nullOptionalState or province code.
Maximum length: 10
$ (oneOf 4).tax_numberModelOptionalExpand 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_formJSONOptionalTax treaty benefits details.
$ (oneOf 4).tax_treaty_benefits_form (oneOf 1)ModelAlternativeExpand 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)nullAlternative
$ (oneOf 4).us_tax_numberModelOptionalExpand 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_codestringRequired within parentZIP/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

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.