POST

Submit Form W-8BEN-E Tax Documentation

Submits IRS Form W-8BEN-E tax documentation data for a foreign entity enterprise account owner. Pass-through to TaxBit POST /v1/account-owners/{id}/tax-documentation-data/w-8ben-e. Note: This endpoint currently returns hardcoded mock responses for initial client integration.

Path Params

enterpriseId string required

The enterprise ID to get a token for

32 to 32 characters · matches ^[0-9a-zA-Z]{32}$

Body Params

object

Form W-8BEN-E submission payload matching TaxBit POST /v1/account-owners/{id}/tax-documentation-data/w-8ben-e.

irs_version string enum

Set to 2021_OCT when submitting the official IRS Form W-8BEN-E; omit for substitute form

2021_OCT
name string

Name of organization that is the beneficial owner
country string enum

Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name per TaxBit specification).

ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
tax_classification string enum

Chapter 3 Status (entity type)

CORPORATIONPARTNERSHIPSIMPLE_TRUSTCOMPLEX_TRUSTGRANTOR_TRUSTESTATECENTRAL_BANK_OF_ISSUEFOREIGN_GOVERNMENT_CONTROLLED_ENTITYFOREIGN_GOVERNMENT_INTEGRAL_PARTTAX_EXEMPT_ORGANIZATIONPRIVATE_FOUNDATIONINTERNATIONAL_ORGANIZATION
permanent_address object

Shared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
permanent_address object
- first_line string
  
  First line of the address
- second_line string
  
  Second line of the address
- city string
  
  City
- state_or_province string
  
  State or province (US state, Canada province, or other)
- postal_code string
  
  Postal code
- country string enum
  
  Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name per TaxBit specification).
  
  ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
mailing_address object

Shared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
mailing_address object
- first_line string
  
  First line of the address
- second_line string
  
  Second line of the address
- city string
  
  City
- state_or_province string
  
  State or province (US state, Canada province, or other)
- postal_code string
  
  Postal code
- country string enum
  
  Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name per TaxBit specification).
  
  ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
us_tin string

U.S. taxpayer identification number (EIN), if required
ftin string

Foreign tax identifying number
reference_numbers string

Reference number(s)
ftin_not_legally_required boolean

Check if FTIN is not legally required
has_signed_and_certified boolean

Indicates that an authorized representative has signed and certified the W-8BEN-E
signature_timestamp string

ISO 8601 timestamp when the form was signed
completed_for string enum

Whether the form was completed for the ACCOUNT_HOLDER or REGARDED_OWNER

ACCOUNT_HOLDERREGARDED_OWNER
treaty_claim_is_eligible boolean

Indicates whether the entity is claiming tax treaty benefits
treaty_claim_country string enum

Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name per TaxBit specification).

ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
treaty_claim_i_certify_resident boolean

Certifies that the beneficial owner is a resident of the treaty country
treaty_claim_type_of_income string enum

Special rates and conditions: type of income

BUSINESS_PROFITSDIVIDENDSINTERESTOTHER_INCOMEROYALTIES_MOTION_PICTURE_AND_TVROYALTIES_OTHER
treaty_claim_rate_of_withholding string

Special rates and conditions: percentage rate of withholding
treaty_claim_article_paragraph string

Special rates and conditions: treaty article and paragraph
treaty_claim_has_additional_conditions boolean

Indicates whether additional conditions apply to the treaty claim
treaty_claim_i_certify_requirements boolean

Certifies that the entity derives the item of income and meets treaty requirements
treaty_claim_limitation_on_benefits string enum

Limitation on benefits (LOB) provision met by the entity

GOVERNMENTTAX_EXEMPT_PENSIONOTHER_TAX_EXEMPT_ORGANIZATIONPUBLICLY_TRADED_CORPORATIONSUBSIDIARYCOMPANY_MEETS_EROSION_TESTCOMPANY_MEETS_DERIVATIVE_TESTCOMPANY_MEETS_BUSINESS_TESTFAVORABLE_DETERMINATIONNO_LOB_ARTICLEOTHER_ARTICLE_PARAGRAPH
treaty_claim_limitation_on_benefits_other_article_paragraph string

Article and paragraph when OTHER_ARTICLE_PARAGRAPH is selected for LOB
fatca_classification string enum

Chapter 4 Status (FATCA classification)

ACCOUNT_NOT_FINANCIALACTIVE_NFFECERTIFIED_DEEMED_COMPLIANT_LIMITED_LIFE_DEBT_ENTITYCERTIFIED_DEEMED_COMPLIANT_LOW_VALUE_ACCOUNTS_FFICERTIFIED_DEEMED_COMPLIANT_NONREGISTERING_LOCAL_BANKCERTIFIED_DEEMED_COMPLIANT_SPONSORED_CLOSELY_HELD_VEHICLEDIRECT_REPORTING_NFFEENTITY_WHOLLY_OWNED_BY_EXEMPT_BENEFICIAL_OWNERSEXCEPTED_INTER_AFFILIATE_FFIEXCEPTED_NONFINANCIAL_ENTITY_IN_LIQUIDATION_OR_BANKRUPTCYEXCEPTED_NONFINANCIAL_GROUP_ENTITYEXCEPTED_NONFINANCIAL_START_UP_COMPANYEXCEPTED_TERRITORY_NFFEEXEMPT_RETIREMENT_PLANSFOREIGN_GOVERNMENTINTERNATIONAL_ORGANIZATIONINVESTMENT_ENTITY_NOT_MAINTAINING_FINANCIAL_ACCOUNTSNONPARTICIPATING_FFINONPROFIT_ORGANIZATIONNONREPORTING_IGA_FFIOWNER_DOCUMENTED_FFIPARTICIPATING_FFIPASSIVE_NFFEPUBLICLY_TRADED_NFFE_OR_AFFILIATEREGISTERED_DEEMED_COMPLIANT_FFIREPORTING_MODEL_1_FFIREPORTING_MODEL_2_FFIRESTRICTED_DISTRIBUTORSECTION_501C_ORGANIZATIONSPONSORED_DIRECT_REPORTING_NFFESPONSORED_FFITERRITORY_FINANCIAL_INSTITUTION
giin string

Global Intermediary Identification Number (GIIN)
giin_applied_for boolean

Indicates if the entity has applied for a GIIN
sponsoring_entity_or_trustee_name string

Name of sponsoring entity or trustee
nonreporting_iga_country string enum

Country for the nonreporting IGA FFI.

AEAGAIAMAOARATAUAZBBBEBGBHBMBRBSBYCACHCLCNCOCRCVCWCYCZDEDKDMDODZEEESFIFRGBGDGEGGGIGLGRGYHKHNHRHTHUIDIEILIMINIQISITJEJMJPKHKNKRKWKYKZLCLILTLULVMDMEMOMSMTMUMXMYNINLNONZPAPEPHPLPTPYQARORSSASCSESGSISKSMTCTHTMTNTRTTTWUAUZVAVCVGVNZA
nonreporting_iga_country_model string enum

Applicable IGA model (MODEL_1 or MODEL_2)

MODEL_1MODEL_2
nonreporting_iga_category string enum

Category of nonreporting IGA FFI.

ARTICLE_XXI_ENTITIESAUSTRIAN_EXPORT_FUNDAUSTRIAN_REGULATED_FINANCIAL_INSTITUTIONBANCOMEXTBANKS_ISSUING_COVERED_BONDSBANOBRASBELGIAN_SAVINGS_FUNDSBERMUDA_PENSION_FUNDBROAD_PARTICIPATION_RETIREMENT_FUNDBUILDING_SOCIETIESCENTRAL_BANKCENTRAL_COOPERATIVE_CREDIT_SOCIETYCHARITABLE_ORGANIZATIONCHILEAN_UNEMPLOYMENT_FUNDCOLLECTIVE_INVESTMENT_VEHICLECOMMUNITY_INTEREST_COMPANIESCORPORATION_TAX_ACT_EXEMPT_FUNDCREDIT_UNIONDEVELOPMENT_BANK_OF_AUSTRIAFIDEICOMISO_ESCROWFIDEICOMISO_REAL_PROPERTYFIDEICOMISO_REPORTING_MEXICAN_FIFINANCIAL_INSTITUTION_WITH_LOCAL_CLIENT_BASEFINANCIAL_INSTITUTION_WITH_ONLY_LOW_VALUE_ACCOUNTSFINANCIERA_NACIONAL_DE_DESARROLLOFRIENDLY_SOCIETIESGOVERNMENTAL_ENTITYHOME_SAVINGS_BANKSHOUSING_CONSTRUCTION_BANKSHOUSING_COOPERATIVEINDUSTRIAL_AND_PROVIDENT_SOCIETIESINSURANCE_INSTITUTION_FOR_PENSION_AND_SURVIVALINTERNATIONAL_ORGANIZATIONINVESTMENT_ADVISORS_AND_MANAGERSINVESTMENT_ENTITY_WHOLLY_OWNED_BY_EXEMPT_BENEFICIAL_OWNERSINVESTMENT_FUNDINVESTMENT_TRUST_COMPANIESLABOUR_SPONSORED_VENTURE_CAPITAL_CORPORATIONLOCAL_BANKMANDATORY_PENSION_FUNDSMAORI_AUTHORITIESMEXICO_EXEMPT_ORGANIZATIONMUTUAL_SOCIETIESNAFINNARROW_PARTICIPATION_RETIREMENT_FUNDNATIONAL_ASSET_MANAGEMENT_AGENCYNATIONAL_PENSIONS_RESERVE_FUNDNATIONAL_TREASURY_MANAGEMENT_AGENCYNON_PROFIT_ORGANIZATIONOTHER_ENTITIESPENSION_FUNDPENSION_FUND_OF_EXEMPT_BENEFICIAL_OWNERPFANDBRIEFSTELLEPRIVATE_PENSION_FUNDPUBLIC_INSTITUTIONQATAR_DEPOSITORY_INSTITUTIONQATAR_FOUNDATIONQUALIFIED_CREDIT_CARD_ISSUERQUALIFYING_INSTITUTIONSRESTRICTED_FUNDRETIREMENT_FUNDSCHOOLS_PROVIDENT_FUNDSHFSPONSORED_CLOSELY_HELD_INVESTMENT_VEHICLESPONSORED_INVESTMENT_ENTITY_AND_CFCSPONSORED_INVESTMENT_ENTITY_AND_CFC_REG_1471STAFF_PROVISION_FUNDSTATE_FUNDED_PENSION_SCHEMESWEDISH_PENSION_FUNDSWISS_CONDOMINIUM_ASSOCIATIONTREATY_QUALIFIED_RETIREMENT_FUNDTRUSTEE_DOCUMENTED_TRUSTVENTURE_CAPITAL_TRUSTSVOLUNTARY_PENSION_FUNDS
nonreporting_iga_trustee_type string enum

Whether the trustee is FOREIGN or US

FOREIGNUS
securities_market string

Name of established securities market on which stock is regularly traded
affiliate_entity_name string

Name of the entity with which the corporation is affiliated
substantial_us_owners array of objects

Substantial U.S. owners of a Passive NFFE
substantial_us_owners object
- name string
  
  Name of the substantial U.S. owner
- address object
  
  Shared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
  address object
  - first_line string
    
    First line of the address
  - second_line string
    
    Second line of the address
  - city string
    
    City
  - state_or_province string
    
    State or province (US state, Canada province, or other)
  - postal_code string
    
    Postal code
  - country string enum
    
    Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name per TaxBit specification).
    
    ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
- us_tin string
  
  U.S. TIN of the substantial U.S. owner
box_17_1 boolean
box_17_2 boolean
box_18 boolean
box_19 boolean
box_21 boolean
box_22 boolean
box_23 boolean
box_24a boolean
box_24b boolean
box_24c boolean
box_24d boolean
box_25a boolean
box_25b boolean
box_25c boolean
box_26 boolean
box_27 boolean
box_28a boolean
box_28b boolean
box_29a boolean
box_29b boolean
box_29c boolean
box_29d boolean
box_29e boolean
box_29f boolean
box_30 boolean
box_31 boolean
box_32 boolean
box_33 boolean
box_33_date_of_formation string
box_34 boolean
box_34_date_of_filing string
box_35 boolean
box_35_determination_letter_date string
box_36 boolean
box_37a boolean
box_37b boolean
box_38 boolean
box_39 boolean
box_40a boolean
box_40b boolean
box_40c boolean
box_41 boolean
box_43 boolean
signature string

Electronic signature of the authorized representative

Responses

201

Response Body

object

Response returned upon successful Form W-8BEN-E submission.

data object required

Form W-8BEN-E submission payload matching TaxBit POST /v1/account-owners/{id}/tax-documentation-data/w-8ben-e.
data object
- irs_version string enum
  
  Set to 2021_OCT when submitting the official IRS Form W-8BEN-E; omit for substitute form
  
  2021_OCT
- name string
  
  Name of organization that is the beneficial owner
- country string enum
  
  Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name per TaxBit specification).
  
  ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
- tax_classification string enum
  
  Chapter 3 Status (entity type)
  
  CORPORATIONPARTNERSHIPSIMPLE_TRUSTCOMPLEX_TRUSTGRANTOR_TRUSTESTATECENTRAL_BANK_OF_ISSUEFOREIGN_GOVERNMENT_CONTROLLED_ENTITYFOREIGN_GOVERNMENT_INTEGRAL_PARTTAX_EXEMPT_ORGANIZATIONPRIVATE_FOUNDATIONINTERNATIONAL_ORGANIZATION
- permanent_address object
  
  Shared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
  permanent_address object
  - first_line string
    
    First line of the address
  - second_line string
    
    Second line of the address
  - city string
    
    City
  - state_or_province string
    
    State or province (US state, Canada province, or other)
  - postal_code string
    
    Postal code
  - country string enum
    
    Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name per TaxBit specification).
    
    ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
- mailing_address object
  
  Shared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
  mailing_address object
  - Same shape as TaxbitAddress.
- us_tin string
  
  U.S. taxpayer identification number (EIN), if required
- ftin string
  
  Foreign tax identifying number
- reference_numbers string
  
  Reference number(s)
- ftin_not_legally_required boolean
  
  Check if FTIN is not legally required
- has_signed_and_certified boolean
  
  Indicates that an authorized representative has signed and certified the W-8BEN-E
- signature_timestamp string
  
  ISO 8601 timestamp when the form was signed
- completed_for string enum
  
  Whether the form was completed for the ACCOUNT_HOLDER or REGARDED_OWNER
  
  ACCOUNT_HOLDERREGARDED_OWNER
- treaty_claim_is_eligible boolean
  
  Indicates whether the entity is claiming tax treaty benefits
- treaty_claim_country string enum
  
  Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name per TaxBit specification).
  
  ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
- treaty_claim_i_certify_resident boolean
  
  Certifies that the beneficial owner is a resident of the treaty country
- treaty_claim_type_of_income string enum
  
  Special rates and conditions: type of income
  
  BUSINESS_PROFITSDIVIDENDSINTERESTOTHER_INCOMEROYALTIES_MOTION_PICTURE_AND_TVROYALTIES_OTHER
- treaty_claim_rate_of_withholding string
  
  Special rates and conditions: percentage rate of withholding
- treaty_claim_article_paragraph string
  
  Special rates and conditions: treaty article and paragraph
- treaty_claim_has_additional_conditions boolean
  
  Indicates whether additional conditions apply to the treaty claim
- treaty_claim_i_certify_requirements boolean
  
  Certifies that the entity derives the item of income and meets treaty requirements
- treaty_claim_limitation_on_benefits string enum
  
  Limitation on benefits (LOB) provision met by the entity
  
  GOVERNMENTTAX_EXEMPT_PENSIONOTHER_TAX_EXEMPT_ORGANIZATIONPUBLICLY_TRADED_CORPORATIONSUBSIDIARYCOMPANY_MEETS_EROSION_TESTCOMPANY_MEETS_DERIVATIVE_TESTCOMPANY_MEETS_BUSINESS_TESTFAVORABLE_DETERMINATIONNO_LOB_ARTICLEOTHER_ARTICLE_PARAGRAPH
- treaty_claim_limitation_on_benefits_other_article_paragraph string
  
  Article and paragraph when OTHER_ARTICLE_PARAGRAPH is selected for LOB
- fatca_classification string enum
  
  Chapter 4 Status (FATCA classification)
  
  ACCOUNT_NOT_FINANCIALACTIVE_NFFECERTIFIED_DEEMED_COMPLIANT_LIMITED_LIFE_DEBT_ENTITYCERTIFIED_DEEMED_COMPLIANT_LOW_VALUE_ACCOUNTS_FFICERTIFIED_DEEMED_COMPLIANT_NONREGISTERING_LOCAL_BANKCERTIFIED_DEEMED_COMPLIANT_SPONSORED_CLOSELY_HELD_VEHICLEDIRECT_REPORTING_NFFEENTITY_WHOLLY_OWNED_BY_EXEMPT_BENEFICIAL_OWNERSEXCEPTED_INTER_AFFILIATE_FFIEXCEPTED_NONFINANCIAL_ENTITY_IN_LIQUIDATION_OR_BANKRUPTCYEXCEPTED_NONFINANCIAL_GROUP_ENTITYEXCEPTED_NONFINANCIAL_START_UP_COMPANYEXCEPTED_TERRITORY_NFFEEXEMPT_RETIREMENT_PLANSFOREIGN_GOVERNMENTINTERNATIONAL_ORGANIZATIONINVESTMENT_ENTITY_NOT_MAINTAINING_FINANCIAL_ACCOUNTSNONPARTICIPATING_FFINONPROFIT_ORGANIZATIONNONREPORTING_IGA_FFIOWNER_DOCUMENTED_FFIPARTICIPATING_FFIPASSIVE_NFFEPUBLICLY_TRADED_NFFE_OR_AFFILIATEREGISTERED_DEEMED_COMPLIANT_FFIREPORTING_MODEL_1_FFIREPORTING_MODEL_2_FFIRESTRICTED_DISTRIBUTORSECTION_501C_ORGANIZATIONSPONSORED_DIRECT_REPORTING_NFFESPONSORED_FFITERRITORY_FINANCIAL_INSTITUTION
- giin string
  
  Global Intermediary Identification Number (GIIN)
- giin_applied_for boolean
  
  Indicates if the entity has applied for a GIIN
- sponsoring_entity_or_trustee_name string
  
  Name of sponsoring entity or trustee
- nonreporting_iga_country string enum
  
  Country for the nonreporting IGA FFI.
  
  AEAGAIAMAOARATAUAZBBBEBGBHBMBRBSBYCACHCLCNCOCRCVCWCYCZDEDKDMDODZEEESFIFRGBGDGEGGGIGLGRGYHKHNHRHTHUIDIEILIMINIQISITJEJMJPKHKNKRKWKYKZLCLILTLULVMDMEMOMSMTMUMXMYNINLNONZPAPEPHPLPTPYQARORSSASCSESGSISKSMTCTHTMTNTRTTTWUAUZVAVCVGVNZA
- nonreporting_iga_country_model string enum
  
  Applicable IGA model (MODEL_1 or MODEL_2)
  
  MODEL_1MODEL_2
- nonreporting_iga_category string enum
  
  Category of nonreporting IGA FFI.
  
  ARTICLE_XXI_ENTITIESAUSTRIAN_EXPORT_FUNDAUSTRIAN_REGULATED_FINANCIAL_INSTITUTIONBANCOMEXTBANKS_ISSUING_COVERED_BONDSBANOBRASBELGIAN_SAVINGS_FUNDSBERMUDA_PENSION_FUNDBROAD_PARTICIPATION_RETIREMENT_FUNDBUILDING_SOCIETIESCENTRAL_BANKCENTRAL_COOPERATIVE_CREDIT_SOCIETYCHARITABLE_ORGANIZATIONCHILEAN_UNEMPLOYMENT_FUNDCOLLECTIVE_INVESTMENT_VEHICLECOMMUNITY_INTEREST_COMPANIESCORPORATION_TAX_ACT_EXEMPT_FUNDCREDIT_UNIONDEVELOPMENT_BANK_OF_AUSTRIAFIDEICOMISO_ESCROWFIDEICOMISO_REAL_PROPERTYFIDEICOMISO_REPORTING_MEXICAN_FIFINANCIAL_INSTITUTION_WITH_LOCAL_CLIENT_BASEFINANCIAL_INSTITUTION_WITH_ONLY_LOW_VALUE_ACCOUNTSFINANCIERA_NACIONAL_DE_DESARROLLOFRIENDLY_SOCIETIESGOVERNMENTAL_ENTITYHOME_SAVINGS_BANKSHOUSING_CONSTRUCTION_BANKSHOUSING_COOPERATIVEINDUSTRIAL_AND_PROVIDENT_SOCIETIESINSURANCE_INSTITUTION_FOR_PENSION_AND_SURVIVALINTERNATIONAL_ORGANIZATIONINVESTMENT_ADVISORS_AND_MANAGERSINVESTMENT_ENTITY_WHOLLY_OWNED_BY_EXEMPT_BENEFICIAL_OWNERSINVESTMENT_FUNDINVESTMENT_TRUST_COMPANIESLABOUR_SPONSORED_VENTURE_CAPITAL_CORPORATIONLOCAL_BANKMANDATORY_PENSION_FUNDSMAORI_AUTHORITIESMEXICO_EXEMPT_ORGANIZATIONMUTUAL_SOCIETIESNAFINNARROW_PARTICIPATION_RETIREMENT_FUNDNATIONAL_ASSET_MANAGEMENT_AGENCYNATIONAL_PENSIONS_RESERVE_FUNDNATIONAL_TREASURY_MANAGEMENT_AGENCYNON_PROFIT_ORGANIZATIONOTHER_ENTITIESPENSION_FUNDPENSION_FUND_OF_EXEMPT_BENEFICIAL_OWNERPFANDBRIEFSTELLEPRIVATE_PENSION_FUNDPUBLIC_INSTITUTIONQATAR_DEPOSITORY_INSTITUTIONQATAR_FOUNDATIONQUALIFIED_CREDIT_CARD_ISSUERQUALIFYING_INSTITUTIONSRESTRICTED_FUNDRETIREMENT_FUNDSCHOOLS_PROVIDENT_FUNDSHFSPONSORED_CLOSELY_HELD_INVESTMENT_VEHICLESPONSORED_INVESTMENT_ENTITY_AND_CFCSPONSORED_INVESTMENT_ENTITY_AND_CFC_REG_1471STAFF_PROVISION_FUNDSTATE_FUNDED_PENSION_SCHEMESWEDISH_PENSION_FUNDSWISS_CONDOMINIUM_ASSOCIATIONTREATY_QUALIFIED_RETIREMENT_FUNDTRUSTEE_DOCUMENTED_TRUSTVENTURE_CAPITAL_TRUSTSVOLUNTARY_PENSION_FUNDS
- nonreporting_iga_trustee_type string enum
  
  Whether the trustee is FOREIGN or US
  
  FOREIGNUS
- securities_market string
  
  Name of established securities market on which stock is regularly traded
- affiliate_entity_name string
  
  Name of the entity with which the corporation is affiliated
- substantial_us_owners array of objects
  
  Substantial U.S. owners of a Passive NFFE
  substantial_us_owners object
  - name string
    
    Name of the substantial U.S. owner
  - address object
    
    Shared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
    
    address object
    
    Same shape as TaxbitAddress.
  - us_tin string
    
    U.S. TIN of the substantial U.S. owner
- box_17_1 boolean
- box_17_2 boolean
- box_18 boolean
- box_19 boolean
- box_21 boolean
- box_22 boolean
- box_23 boolean
- box_24a boolean
- box_24b boolean
- box_24c boolean
- box_24d boolean
- box_25a boolean
- box_25b boolean
- box_25c boolean
- box_26 boolean
- box_27 boolean
- box_28a boolean
- box_28b boolean
- box_29a boolean
- box_29b boolean
- box_29c boolean
- box_29d boolean
- box_29e boolean
- box_29f boolean
- box_30 boolean
- box_31 boolean
- box_32 boolean
- box_33 boolean
- box_33_date_of_formation string
- box_34 boolean
- box_34_date_of_filing string
- box_35 boolean
- box_35_determination_letter_date string
- box_36 boolean
- box_37a boolean
- box_37b boolean
- box_38 boolean
- box_39 boolean
- box_40a boolean
- box_40b boolean
- box_40c boolean
- box_41 boolean
- box_43 boolean
- signature string
  
  Electronic signature of the authorized representative

400

Response Body

object

error string required

Error message describing the validation failure
message string required

Details of why the request was rejected
issues array of objects

Per-field validation failures when the request body fails schema validation
issues object
- <key> object

401

Response Body

object

error string

Error name for the rejected request
message string required

Reason the request was rejected

403

Response Body

object

error string

Error message when the caller lacks permission on the enterprise
message string

Explicit deny message

404

Response Body

object

error string required

Error message indicating the resource was not found
message string required

Which resource could not be found

409

Response Body

object

error string required

Error message indicating a tax form was already submitted for the current tax year
message string required

Details of the existing submission conflict

429

Response Body

object

error string required

Error code emitted when the caller exceeds the rate limit
message string required

How long to wait before retrying

500

Response Body

object

error string required

Language

Credentials

Bearer

Request

curl -X POST \
     --url 'https://app.bitgo-test.com/api/identity-service/v1/taxbit/account/enterpriseId/tax-documentation-data/w-8ben-e' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
     --header 'content-type: application/json' \
     --data '{,
       "irs_version": "2021_OCT",
       "name": "Global Digital Assets Ltd",
       "country": "US",
       "tax_classification": "CORPORATION",
       "permanent_address": {,
         "first_line": "123 Pine St",
         "second_line": "Apt 456",
         "city": "Seattle",
         "state_or_province": "WA",
         "postal_code": "98000",
         "country": "US"
       },
       "mailing_address": {,
         "first_line": "123 Pine St",
         "second_line": "Apt 456",
         "city": "Seattle",
         "state_or_province": "WA",
         "postal_code": "98000",
         "country": "US"
       },
       "us_tin": "string",
       "ftin": "string",
       "reference_numbers": "string",
       "ftin_not_legally_required": true,
       "has_signed_and_certified": true,
       "signature_timestamp": "string",
       "completed_for": "ACCOUNT_HOLDER",
       "treaty_claim_is_eligible": true,
       "treaty_claim_country": "US",
       "treaty_claim_i_certify_resident": true,
       "treaty_claim_type_of_income": "BUSINESS_PROFITS",
       "treaty_claim_rate_of_withholding": "string",
       "treaty_claim_article_paragraph": "string",
       "treaty_claim_has_additional_conditions": true,
       "treaty_claim_i_certify_requirements": true,
       "treaty_claim_limitation_on_benefits": "GOVERNMENT",
       "treaty_claim_limitation_on_benefits_other_article_paragraph": "string",
       "fatca_classification": "ACCOUNT_NOT_FINANCIAL",
       "giin": "string",
       "giin_applied_for": true,
       "sponsoring_entity_or_trustee_name": "string",
       "nonreporting_iga_country": "AE",
       "nonreporting_iga_country_model": "MODEL_1",
       "nonreporting_iga_category": "ARTICLE_XXI_ENTITIES",
       "nonreporting_iga_trustee_type": "FOREIGN",
       "securities_market": "string",
       "affiliate_entity_name": "string",
       "substantial_us_owners": [
         {,
           "name": "John Doe",
           "address": {,
             "first_line": "123 Pine St",
             "second_line": "Apt 456",
             "city": "Seattle",
             "state_or_province": "WA",
             "postal_code": "98000",
             "country": "US"
           },
           "us_tin": "123456789"
         }
       ],
       "box_17_1": true,
       "box_17_2": true,
       "box_18": true,
       "box_19": true,
       "box_21": true,
       "box_22": true,
       "box_23": true,
       "box_24a": true,
       "box_24b": true,
       "box_24c": true,
       "box_24d": true,
       "box_25a": true,
       "box_25b": true,
       "box_25c": true,
       "box_26": true,
       "box_27": true,
       "box_28a": true,
       "box_28b": true,
       "box_29a": true,
       "box_29b": true,
       "box_29c": true,
       "box_29d": true,
       "box_29e": true,
       "box_29f": true,
       "box_30": true,
       "box_31": true,
       "box_32": true,
       "box_33": true,
       "box_33_date_of_formation": "string",
       "box_34": true,
       "box_34_date_of_filing": "string",
       "box_35": true,
       "box_35_determination_letter_date": "string",
       "box_36": true,
       "box_37a": true,
       "box_37b": true,
       "box_38": true,
       "box_39": true,
       "box_40a": true,
       "box_40b": true,
       "box_40c": true,
       "box_41": true,
       "box_43": true,
       "signature": "Alex Smith"
     }'

Request

const url = 'https://app.bitgo-test.com/api/identity-service/v1/taxbit/account/enterpriseId/tax-documentation-data/w-8ben-e';
const options = {
  method: 'POST',
  headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'},
  body: JSON.stringify({,
    "irs_version": "2021_OCT",
    "name": "Global Digital Assets Ltd",
    "country": "US",
    "tax_classification": "CORPORATION",
    "permanent_address": {,
      "first_line": "123 Pine St",
      "second_line": "Apt 456",
      "city": "Seattle",
      "state_or_province": "WA",
      "postal_code": "98000",
      "country": "US"
    },
    "mailing_address": {,
      "first_line": "123 Pine St",
      "second_line": "Apt 456",
      "city": "Seattle",
      "state_or_province": "WA",
      "postal_code": "98000",
      "country": "US"
    },
    "us_tin": "string",
    "ftin": "string",
    "reference_numbers": "string",
    "ftin_not_legally_required": true,
    "has_signed_and_certified": true,
    "signature_timestamp": "string",
    "completed_for": "ACCOUNT_HOLDER",
    "treaty_claim_is_eligible": true,
    "treaty_claim_country": "US",
    "treaty_claim_i_certify_resident": true,
    "treaty_claim_type_of_income": "BUSINESS_PROFITS",
    "treaty_claim_rate_of_withholding": "string",
    "treaty_claim_article_paragraph": "string",
    "treaty_claim_has_additional_conditions": true,
    "treaty_claim_i_certify_requirements": true,
    "treaty_claim_limitation_on_benefits": "GOVERNMENT",
    "treaty_claim_limitation_on_benefits_other_article_paragraph": "string",
    "fatca_classification": "ACCOUNT_NOT_FINANCIAL",
    "giin": "string",
    "giin_applied_for": true,
    "sponsoring_entity_or_trustee_name": "string",
    "nonreporting_iga_country": "AE",
    "nonreporting_iga_country_model": "MODEL_1",
    "nonreporting_iga_category": "ARTICLE_XXI_ENTITIES",
    "nonreporting_iga_trustee_type": "FOREIGN",
    "securities_market": "string",
    "affiliate_entity_name": "string",
    "substantial_us_owners": [
      {,
        "name": "John Doe",
        "address": {,
          "first_line": "123 Pine St",
          "second_line": "Apt 456",
          "city": "Seattle",
          "state_or_province": "WA",
          "postal_code": "98000",
          "country": "US"
        },
        "us_tin": "123456789"
      }
    ],
    "box_17_1": true,
    "box_17_2": true,
    "box_18": true,
    "box_19": true,
    "box_21": true,
    "box_22": true,
    "box_23": true,
    "box_24a": true,
    "box_24b": true,
    "box_24c": true,
    "box_24d": true,
    "box_25a": true,
    "box_25b": true,
    "box_25c": true,
    "box_26": true,
    "box_27": true,
    "box_28a": true,
    "box_28b": true,
    "box_29a": true,
    "box_29b": true,
    "box_29c": true,
    "box_29d": true,
    "box_29e": true,
    "box_29f": true,
    "box_30": true,
    "box_31": true,
    "box_32": true,
    "box_33": true,
    "box_33_date_of_formation": "string",
    "box_34": true,
    "box_34_date_of_filing": "string",
    "box_35": true,
    "box_35_determination_letter_date": "string",
    "box_36": true,
    "box_37a": true,
    "box_37b": true,
    "box_38": true,
    "box_39": true,
    "box_40a": true,
    "box_40b": true,
    "box_40c": true,
    "box_41": true,
    "box_43": true,
    "signature": "Alex Smith"
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Request

require 'uri'
require 'net/http'

url = URI("https://app.bitgo-test.com/api/identity-service/v1/taxbit/account/enterpriseId/tax-documentation-data/w-8ben-e")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'
request["content-type"] = 'application/json'
request.body = '{,
  "irs_version": "2021_OCT",
  "name": "Global Digital Assets Ltd",
  "country": "US",
  "tax_classification": "CORPORATION",
  "permanent_address": {,
    "first_line": "123 Pine St",
    "second_line": "Apt 456",
    "city": "Seattle",
    "state_or_province": "WA",
    "postal_code": "98000",
    "country": "US"
  },
  "mailing_address": {,
    "first_line": "123 Pine St",
    "second_line": "Apt 456",
    "city": "Seattle",
    "state_or_province": "WA",
    "postal_code": "98000",
    "country": "US"
  },
  "us_tin": "string",
  "ftin": "string",
  "reference_numbers": "string",
  "ftin_not_legally_required": true,
  "has_signed_and_certified": true,
  "signature_timestamp": "string",
  "completed_for": "ACCOUNT_HOLDER",
  "treaty_claim_is_eligible": true,
  "treaty_claim_country": "US",
  "treaty_claim_i_certify_resident": true,
  "treaty_claim_type_of_income": "BUSINESS_PROFITS",
  "treaty_claim_rate_of_withholding": "string",
  "treaty_claim_article_paragraph": "string",
  "treaty_claim_has_additional_conditions": true,
  "treaty_claim_i_certify_requirements": true,
  "treaty_claim_limitation_on_benefits": "GOVERNMENT",
  "treaty_claim_limitation_on_benefits_other_article_paragraph": "string",
  "fatca_classification": "ACCOUNT_NOT_FINANCIAL",
  "giin": "string",
  "giin_applied_for": true,
  "sponsoring_entity_or_trustee_name": "string",
  "nonreporting_iga_country": "AE",
  "nonreporting_iga_country_model": "MODEL_1",
  "nonreporting_iga_category": "ARTICLE_XXI_ENTITIES",
  "nonreporting_iga_trustee_type": "FOREIGN",
  "securities_market": "string",
  "affiliate_entity_name": "string",
  "substantial_us_owners": [
    {,
      "name": "John Doe",
      "address": {,
        "first_line": "123 Pine St",
        "second_line": "Apt 456",
        "city": "Seattle",
        "state_or_province": "WA",
        "postal_code": "98000",
        "country": "US"
      },
      "us_tin": "123456789"
    }
  ],
  "box_17_1": true,
  "box_17_2": true,
  "box_18": true,
  "box_19": true,
  "box_21": true,
  "box_22": true,
  "box_23": true,
  "box_24a": true,
  "box_24b": true,
  "box_24c": true,
  "box_24d": true,
  "box_25a": true,
  "box_25b": true,
  "box_25c": true,
  "box_26": true,
  "box_27": true,
  "box_28a": true,
  "box_28b": true,
  "box_29a": true,
  "box_29b": true,
  "box_29c": true,
  "box_29d": true,
  "box_29e": true,
  "box_29f": true,
  "box_30": true,
  "box_31": true,
  "box_32": true,
  "box_33": true,
  "box_33_date_of_formation": "string",
  "box_34": true,
  "box_34_date_of_filing": "string",
  "box_35": true,
  "box_35_determination_letter_date": "string",
  "box_36": true,
  "box_37a": true,
  "box_37b": true,
  "box_38": true,
  "box_39": true,
  "box_40a": true,
  "box_40b": true,
  "box_40c": true,
  "box_41": true,
  "box_43": true,
  "signature": "Alex Smith"
}'

response = http.request(request)
puts response.read_body

Request

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.bitgo-test.com/api/identity-service/v1/taxbit/account/enterpriseId/tax-documentation-data/w-8ben-e', [
  'headers' => [
    'accept' => 'application/json',
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
    'content-type' => 'application/json',
  ],
  'body' => '{,
    "irs_version": "2021_OCT",
    "name": "Global Digital Assets Ltd",
    "country": "US",
    "tax_classification": "CORPORATION",
    "permanent_address": {,
      "first_line": "123 Pine St",
      "second_line": "Apt 456",
      "city": "Seattle",
      "state_or_province": "WA",
      "postal_code": "98000",
      "country": "US"
    },
    "mailing_address": {,
      "first_line": "123 Pine St",
      "second_line": "Apt 456",
      "city": "Seattle",
      "state_or_province": "WA",
      "postal_code": "98000",
      "country": "US"
    },
    "us_tin": "string",
    "ftin": "string",
    "reference_numbers": "string",
    "ftin_not_legally_required": true,
    "has_signed_and_certified": true,
    "signature_timestamp": "string",
    "completed_for": "ACCOUNT_HOLDER",
    "treaty_claim_is_eligible": true,
    "treaty_claim_country": "US",
    "treaty_claim_i_certify_resident": true,
    "treaty_claim_type_of_income": "BUSINESS_PROFITS",
    "treaty_claim_rate_of_withholding": "string",
    "treaty_claim_article_paragraph": "string",
    "treaty_claim_has_additional_conditions": true,
    "treaty_claim_i_certify_requirements": true,
    "treaty_claim_limitation_on_benefits": "GOVERNMENT",
    "treaty_claim_limitation_on_benefits_other_article_paragraph": "string",
    "fatca_classification": "ACCOUNT_NOT_FINANCIAL",
    "giin": "string",
    "giin_applied_for": true,
    "sponsoring_entity_or_trustee_name": "string",
    "nonreporting_iga_country": "AE",
    "nonreporting_iga_country_model": "MODEL_1",
    "nonreporting_iga_category": "ARTICLE_XXI_ENTITIES",
    "nonreporting_iga_trustee_type": "FOREIGN",
    "securities_market": "string",
    "affiliate_entity_name": "string",
    "substantial_us_owners": [
      {,
        "name": "John Doe",
        "address": {,
          "first_line": "123 Pine St",
          "second_line": "Apt 456",
          "city": "Seattle",
          "state_or_province": "WA",
          "postal_code": "98000",
          "country": "US"
        },
        "us_tin": "123456789"
      }
    ],
    "box_17_1": true,
    "box_17_2": true,
    "box_18": true,
    "box_19": true,
    "box_21": true,
    "box_22": true,
    "box_23": true,
    "box_24a": true,
    "box_24b": true,
    "box_24c": true,
    "box_24d": true,
    "box_25a": true,
    "box_25b": true,
    "box_25c": true,
    "box_26": true,
    "box_27": true,
    "box_28a": true,
    "box_28b": true,
    "box_29a": true,
    "box_29b": true,
    "box_29c": true,
    "box_29d": true,
    "box_29e": true,
    "box_29f": true,
    "box_30": true,
    "box_31": true,
    "box_32": true,
    "box_33": true,
    "box_33_date_of_formation": "string",
    "box_34": true,
    "box_34_date_of_filing": "string",
    "box_35": true,
    "box_35_determination_letter_date": "string",
    "box_36": true,
    "box_37a": true,
    "box_37b": true,
    "box_38": true,
    "box_39": true,
    "box_40a": true,
    "box_40b": true,
    "box_40c": true,
    "box_41": true,
    "box_43": true,
    "signature": "Alex Smith"
  }',
]);

echo $response->getBody();

Request

import requests

url = "https://app.bitgo-test.com/api/identity-service/v1/taxbit/account/enterpriseId/tax-documentation-data/w-8ben-e"

payload = {,
  "irs_version": "2021_OCT",
  "name": "Global Digital Assets Ltd",
  "country": "US",
  "tax_classification": "CORPORATION",
  "permanent_address": {,
    "first_line": "123 Pine St",
    "second_line": "Apt 456",
    "city": "Seattle",
    "state_or_province": "WA",
    "postal_code": "98000",
    "country": "US"
  },
  "mailing_address": {,
    "first_line": "123 Pine St",
    "second_line": "Apt 456",
    "city": "Seattle",
    "state_or_province": "WA",
    "postal_code": "98000",
    "country": "US"
  },
  "us_tin": "string",
  "ftin": "string",
  "reference_numbers": "string",
  "ftin_not_legally_required": true,
  "has_signed_and_certified": true,
  "signature_timestamp": "string",
  "completed_for": "ACCOUNT_HOLDER",
  "treaty_claim_is_eligible": true,
  "treaty_claim_country": "US",
  "treaty_claim_i_certify_resident": true,
  "treaty_claim_type_of_income": "BUSINESS_PROFITS",
  "treaty_claim_rate_of_withholding": "string",
  "treaty_claim_article_paragraph": "string",
  "treaty_claim_has_additional_conditions": true,
  "treaty_claim_i_certify_requirements": true,
  "treaty_claim_limitation_on_benefits": "GOVERNMENT",
  "treaty_claim_limitation_on_benefits_other_article_paragraph": "string",
  "fatca_classification": "ACCOUNT_NOT_FINANCIAL",
  "giin": "string",
  "giin_applied_for": true,
  "sponsoring_entity_or_trustee_name": "string",
  "nonreporting_iga_country": "AE",
  "nonreporting_iga_country_model": "MODEL_1",
  "nonreporting_iga_category": "ARTICLE_XXI_ENTITIES",
  "nonreporting_iga_trustee_type": "FOREIGN",
  "securities_market": "string",
  "affiliate_entity_name": "string",
  "substantial_us_owners": [
    {,
      "name": "John Doe",
      "address": {,
        "first_line": "123 Pine St",
        "second_line": "Apt 456",
        "city": "Seattle",
        "state_or_province": "WA",
        "postal_code": "98000",
        "country": "US"
      },
      "us_tin": "123456789"
    }
  ],
  "box_17_1": true,
  "box_17_2": true,
  "box_18": true,
  "box_19": true,
  "box_21": true,
  "box_22": true,
  "box_23": true,
  "box_24a": true,
  "box_24b": true,
  "box_24c": true,
  "box_24d": true,
  "box_25a": true,
  "box_25b": true,
  "box_25c": true,
  "box_26": true,
  "box_27": true,
  "box_28a": true,
  "box_28b": true,
  "box_29a": true,
  "box_29b": true,
  "box_29c": true,
  "box_29d": true,
  "box_29e": true,
  "box_29f": true,
  "box_30": true,
  "box_31": true,
  "box_32": true,
  "box_33": true,
  "box_33_date_of_formation": "string",
  "box_34": true,
  "box_34_date_of_filing": "string",
  "box_35": true,
  "box_35_determination_letter_date": "string",
  "box_36": true,
  "box_37a": true,
  "box_37b": true,
  "box_38": true,
  "box_39": true,
  "box_40a": true,
  "box_40b": true,
  "box_40c": true,
  "box_41": true,
  "box_43": true,
  "signature": "Alex Smith"
}
headers = {
    "accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response

{
  "data": {
    "irs_version": "2021_OCT",
    "name": "Global Digital Assets Ltd",
    "country": "US",
    "tax_classification": "CORPORATION",
    "permanent_address": {
      "first_line": "123 Pine St",
      "second_line": "Apt 456",
      "city": "Seattle",
      "state_or_province": "WA",
      "postal_code": "98000",
      "country": "US"
    },
    "mailing_address": {
      "first_line": "123 Pine St",
      "second_line": "Apt 456",
      "city": "Seattle",
      "state_or_province": "WA",
      "postal_code": "98000",
      "country": "US"
    },
    "us_tin": "string",
    "ftin": "string",
    "reference_numbers": "string",
    "ftin_not_legally_required": true,
    "has_signed_and_certified": true,
    "signature_timestamp": "2026-01-15T12:00:00Z",
    "completed_for": "ACCOUNT_HOLDER",
    "treaty_claim_is_eligible": true,
    "treaty_claim_country": "US",
    "treaty_claim_i_certify_resident": true,
    "treaty_claim_type_of_income": "BUSINESS_PROFITS",
    "treaty_claim_rate_of_withholding": "string",
    "treaty_claim_article_paragraph": "string",
    "treaty_claim_has_additional_conditions": true,
    "treaty_claim_i_certify_requirements": true,
    "treaty_claim_limitation_on_benefits": "GOVERNMENT",
    "treaty_claim_limitation_on_benefits_other_article_paragraph": "string",
    "fatca_classification": "ACCOUNT_NOT_FINANCIAL",
    "giin": "string",
    "giin_applied_for": true,
    "sponsoring_entity_or_trustee_name": "string",
    "nonreporting_iga_country": "AE",
    "nonreporting_iga_country_model": "MODEL_1",
    "nonreporting_iga_category": "ARTICLE_XXI_ENTITIES",
    "nonreporting_iga_trustee_type": "FOREIGN",
    "securities_market": "string",
    "affiliate_entity_name": "string",
    "substantial_us_owners": [
      {
        "name": "John Doe",
        "address": {
          "first_line": "123 Pine St",
          "second_line": "Apt 456",
          "city": "Seattle",
          "state_or_province": "WA",
          "postal_code": "98000",
          "country": "US"
        },
        "us_tin": "123456789"
      }
    ],
    "box_17_1": true,
    "box_17_2": true,
    "box_18": true,
    "box_19": true,
    "box_21": true,
    "box_22": true,
    "box_23": true,
    "box_24a": true,
    "box_24b": true,
    "box_24c": true,
    "box_24d": true,
    "box_25a": true,
    "box_25b": true,
    "box_25c": true,
    "box_26": true,
    "box_27": true,
    "box_28a": true,
    "box_28b": true,
    "box_29a": true,
    "box_29b": true,
    "box_29c": true,
    "box_29d": true,
    "box_29e": true,
    "box_29f": true,
    "box_30": true,
    "box_31": true,
    "box_32": true,
    "box_33": true,
    "box_33_date_of_formation": "string",
    "box_34": true,
    "box_34_date_of_filing": "string",
    "box_35": true,
    "box_35_determination_letter_date": "string",
    "box_36": true,
    "box_37a": true,
    "box_37b": true,
    "box_38": true,
    "box_39": true,
    "box_40a": true,
    "box_40b": true,
    "box_40c": true,
    "box_41": true,
    "box_43": true,
    "signature": "Alex Smith"
  }
}

{
  "error": "Bad Request",
  "message": "Invalid request",
  "issues": [
    {
      "key": "string"
    }
  ]
}

{
  "error": "Unauthorized",
  "message": "Unauthorized Error"
}

{
  "error": "Forbidden",
  "message": "User does not have admin permission on enterprise"
}

{
  "error": "Not Found",
  "message": "Object with id Account1234 cannot be found"
}

{
  "error": "Conflict",
  "message": "Tax documentation for this form category has already been submitted for the current tax year"
}

{
  "error": "rate_limit_exceeded",
  "message": "Rate limit exceeded. Please retry after 30 seconds."
}

{
  "error": "string"
}