GET
Get Tax Documentation Data
Retrieves submitted tax documentation data (W-Form, DAC8 Self-Certification, and DPS) for the specified enterprise account owner. Pass-through to TaxBit GET /v1/account-owners/{id}/tax-documentation-data. Note: This endpoint currently returns hardcoded mock responses for initial client integration.
Path Params
-
enterpriseIdstring requiredThe enterprise ID to get a token for
Query Params
-
unmaskstring enumWhether to unmask sensitive TIN information in the response (defaults to false)truefalse
Responses
200
200
Response Body
object
Response returned from GET /v1/account-owners/{id}/tax-documentation-data containing submitted tax forms.
-
dataobject requireddata object
-
wFormobjectCollected W-9, W-8BEN, or W-8BEN-E form dataONE OF
-
namestringLegal name of the individual or entity -
dba_namestringBusiness name / disregarded entity name, if different from above -
tax_classificationstring enumFederal tax classification of the person or entityINDIVIDUALC_CORPORATIONS_CORPORATIONPARTNERSHIPTRUST_ESTATELLC_CLLC_PLLC_SSOLE_PROPRIETOROTHER -
other_tax_classificationstringDescription when tax_classification is OTHER -
addressobjectShared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.address object
-
first_linestringFirst line of the address -
second_linestringSecond line of the address -
citystringCity -
state_or_provincestringState or province (US state, Canada province, or other) -
postal_codestringPostal code -
countrystring enumCountry 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
-
-
tinstringTaxpayer Identification Number (SSN, EIN, ITIN, or ATIN) -
tin_typestring enumType of Taxpayer Identification NumberSSNEINITINATIN -
exempt_payee_codestring enumExempt payee code (if applicable)12345678910111213 -
exempt_fatca_codestring enumExemption from FATCA reporting code (if applicable)ABCDEFGHIJKLM -
is_not_subject_backup_withholdingbooleanCertifies that the taxpayer is not subject to backup withholding -
has_signed_and_certifiedbooleanIndicates that the taxpayer has signed and certified the W-9 under penalties of perjury -
signature_timestampstringISO 8601 timestamp when the form was signed -
completed_forstring enumWhether the form was completed for the ACCOUNT_HOLDER or REGARDED_OWNERACCOUNT_HOLDERREGARDED_OWNER -
signaturestringElectronic signature of the person certifying the form -
idstring uuidTaxBit internal UUID for the collected W-9 documentation -
created_atstringISO 8601 timestamp when the W-9 documentation was recorded -
has_certifiedbooleanIndicates whether the W-9 form has been certified -
document_typestring enumDocument type (W-9)W-9
-
irs_versionstring enumSet to 2021_OCT when submitting the official IRS Form W-8BEN; omit for substitute form2021_OCT -
namestringName of individual who is the beneficial owner -
countrystring enumCountry 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 -
permanent_addressobjectShared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.permanent_address object
- Same shape as
TaxbitAddress.
- Same shape as
-
mailing_addressobjectShared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.mailing_address object
- Same shape as
TaxbitAddress.
- Same shape as
-
us_tinstringU.S. taxpayer identification number (SSN or ITIN), if required -
ftinstringForeign tax identifying number -
date_of_birthstringDate of birth (YYYY-MM-DD) -
reference_numbersstringReference number(s) -
ftin_not_legally_requiredbooleanCheck if FTIN is not legally required -
has_signed_and_certifiedbooleanIndicates that the beneficial owner has signed and certified the W-8BEN -
signature_timestampstringISO 8601 timestamp when the form was signed -
completed_forstring enumWhether the form was completed for the ACCOUNT_HOLDER or REGARDED_OWNERACCOUNT_HOLDERREGARDED_OWNER -
treaty_claim_is_eligiblebooleanIndicates whether the beneficial owner is claiming treaty benefits -
treaty_claim_countrystring enumCountry 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_residentbooleanCertifies residency in the treaty country -
treaty_claim_type_of_incomestring enumSpecial rates and conditions: type of incomeBUSINESS_PROFITSDIVIDENDSINTERESTOTHER_INCOMEROYALTIES_MOTION_PICTURE_AND_TVROYALTIES_OTHER -
treaty_claim_rate_of_withholdingstringSpecial rates and conditions: percentage rate of withholding -
treaty_claim_article_paragraphstringSpecial rates and conditions: treaty article and paragraph -
treaty_claim_has_additional_conditionsbooleanIndicates whether additional conditions apply to the treaty claim -
signaturestringElectronic signature of the beneficial owner -
idstring uuidTaxBit internal UUID for the collected W-8BEN documentation -
created_atstringISO 8601 timestamp when the W-8BEN documentation was recorded -
has_certifiedbooleanIndicates whether the W-8BEN form has been certified -
document_typestring enumDocument type (W-8BEN)W-8BEN -
tinstringTax Identification Number
-
irs_versionstring enumSet to 2021_OCT when submitting the official IRS Form W-8BEN-E; omit for substitute form2021_OCT -
namestringName of organization that is the beneficial owner -
countrystring enumCountry 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_classificationstring enumChapter 3 Status (entity type)CORPORATIONPARTNERSHIPSIMPLE_TRUSTCOMPLEX_TRUSTGRANTOR_TRUSTESTATECENTRAL_BANK_OF_ISSUEFOREIGN_GOVERNMENT_CONTROLLED_ENTITYFOREIGN_GOVERNMENT_INTEGRAL_PARTTAX_EXEMPT_ORGANIZATIONPRIVATE_FOUNDATIONINTERNATIONAL_ORGANIZATION -
permanent_addressobjectShared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.permanent_address object
- Same shape as
TaxbitAddress.
- Same shape as
-
mailing_addressobjectShared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.mailing_address object
- Same shape as
TaxbitAddress.
- Same shape as
-
us_tinstringU.S. taxpayer identification number (EIN), if required -
ftinstringForeign tax identifying number -
reference_numbersstringReference number(s) -
ftin_not_legally_requiredbooleanCheck if FTIN is not legally required -
has_signed_and_certifiedbooleanIndicates that an authorized representative has signed and certified the W-8BEN-E -
signature_timestampstringISO 8601 timestamp when the form was signed -
completed_forstring enumWhether the form was completed for the ACCOUNT_HOLDER or REGARDED_OWNERACCOUNT_HOLDERREGARDED_OWNER -
treaty_claim_is_eligiblebooleanIndicates whether the entity is claiming tax treaty benefits -
treaty_claim_countrystring enumCountry 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_residentbooleanCertifies that the beneficial owner is a resident of the treaty country -
treaty_claim_type_of_incomestring enumSpecial rates and conditions: type of incomeBUSINESS_PROFITSDIVIDENDSINTERESTOTHER_INCOMEROYALTIES_MOTION_PICTURE_AND_TVROYALTIES_OTHER -
treaty_claim_rate_of_withholdingstringSpecial rates and conditions: percentage rate of withholding -
treaty_claim_article_paragraphstringSpecial rates and conditions: treaty article and paragraph -
treaty_claim_has_additional_conditionsbooleanIndicates whether additional conditions apply to the treaty claim -
treaty_claim_i_certify_requirementsbooleanCertifies that the entity derives the item of income and meets treaty requirements -
treaty_claim_limitation_on_benefitsstring enumLimitation on benefits (LOB) provision met by the entityGOVERNMENTTAX_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_paragraphstringArticle and paragraph when OTHER_ARTICLE_PARAGRAPH is selected for LOB -
fatca_classificationstring enumChapter 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 -
giinstringGlobal Intermediary Identification Number (GIIN) -
giin_applied_forbooleanIndicates if the entity has applied for a GIIN -
sponsoring_entity_or_trustee_namestringName of sponsoring entity or trustee -
nonreporting_iga_countrystring enumCountry for the nonreporting IGA FFI.AEAGAIAMAOARATAUAZBBBEBGBHBMBRBSBYCACHCLCNCOCRCVCWCYCZDEDKDMDODZEEESFIFRGBGDGEGGGIGLGRGYHKHNHRHTHUIDIEILIMINIQISITJEJMJPKHKNKRKWKYKZLCLILTLULVMDMEMOMSMTMUMXMYNINLNONZPAPEPHPLPTPYQARORSSASCSESGSISKSMTCTHTMTNTRTTTWUAUZVAVCVGVNZA -
nonreporting_iga_country_modelstring enumApplicable IGA model (MODEL_1 or MODEL_2)MODEL_1MODEL_2 -
nonreporting_iga_categorystring enumCategory 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_typestring enumWhether the trustee is FOREIGN or USFOREIGNUS -
securities_marketstringName of established securities market on which stock is regularly traded -
affiliate_entity_namestringName of the entity with which the corporation is affiliated -
substantial_us_ownersarray of objectsSubstantial U.S. owners of a Passive NFFEsubstantial_us_owners object
-
namestringName of the substantial U.S. owner -
addressobjectShared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.address object
- Same shape as
TaxbitAddress.
- Same shape as
-
us_tinstringU.S. TIN of the substantial U.S. owner
-
-
box_17_1boolean -
box_17_2boolean -
box_18boolean -
box_19boolean -
box_21boolean -
box_22boolean -
box_23boolean -
box_24aboolean -
box_24bboolean -
box_24cboolean -
box_24dboolean -
box_25aboolean -
box_25bboolean -
box_25cboolean -
box_26boolean -
box_27boolean -
box_28aboolean -
box_28bboolean -
box_29aboolean -
box_29bboolean -
box_29cboolean -
box_29dboolean -
box_29eboolean -
box_29fboolean -
box_30boolean -
box_31boolean -
box_32boolean -
box_33boolean -
box_33_date_of_formationstring -
box_34boolean -
box_34_date_of_filingstring -
box_35boolean -
box_35_determination_letter_datestring -
box_36boolean -
box_37aboolean -
box_37bboolean -
box_38boolean -
box_39boolean -
box_40aboolean -
box_40bboolean -
box_40cboolean -
box_41boolean -
box_43boolean -
signaturestringElectronic signature of the authorized representative -
idstring uuidTaxBit internal UUID for the collected W-8BEN-E documentation -
created_atstringISO 8601 timestamp when the W-8BEN-E documentation was recorded -
has_certifiedbooleanIndicates whether the W-8BEN-E form has been certified -
document_typestring enumDocument type (W-8BEN-E)W-8BEN-E -
date_of_birthstring -
tinstringTax Identification Number
-
-
selfCertificationobjectCollected DAC8/CARF Self-Certification dataselfCertification object
-
namestringLegal name of the individual or entity -
permanent_addressobjectShared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.permanent_address object
- Same shape as
TaxbitAddress.
- Same shape as
-
mailing_addressobjectShared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.mailing_address object
- Same shape as
TaxbitAddress.
- Same shape as
-
tax_residencesarray of objectsList of tax residency jurisdictions and TINstax_residences object
-
countrystring enumCountry 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 -
tinstringTax Identification Number (TIN) for the jurisdiction -
tin_not_requiredbooleanIndicates if a TIN is not required or not issued -
tin_not_required_reasonstring enumReason why a TIN was not providedNOT_ISSUEDNOT_REQUIREDOTHER -
tin_not_required_reason_otherstringFree-text explanation when tin_not_required_reason is OTHER -
hashed_tinstringSHA-256 hash of the TIN returned by TaxBit
-
-
classificationstring enumCRS/CARF classification of the account ownerINDIVIDUALFINANCIAL_INSTITUTION_DEPOSITORY_INSTITUTIONFINANCIAL_INSTITUTION_CUSTODIAL_INSTITUTIONFINANCIAL_INSTITUTION_INSURANCE_COMPANYFINANCIAL_INSTITUTION_NON_REPORTINGFINANCIAL_INSTITUTION_INVESTMENT_ENTITY_MANAGEDFINANCIAL_INSTITUTION_INVESTMENT_ENTITY_OTHERACTIVE_NFE_GOVERNMENT_ENTITYACTIVE_NFE_CENTRAL_BANKACTIVE_NFE_INTERNATIONAL_ORGANIZATIONACTIVE_NFE_PUBLIC_CORPORATIONACTIVE_NFE_OTHERPASSIVE_NFE -
signature_datestringDate the self-certification was signed (YYYY-MM-DD or ISO 8601) -
has_signed_and_certifiedbooleanIndicates that the account owner has signed and certified the self-certification -
date_of_birthstringDate of birth for individual account owners (YYYY-MM-DD) -
city_of_birthstringCity of birth for individual account owners -
country_of_birthstring enumCountry 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 -
country_of_citizenshipstring enumCountry 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 -
entity_typestring enumEntity type when classification is PASSIVE_NFETRUSTSIMILAR_TO_TRUSTOTHER -
securities_marketstringEstablished securities market when classification is ACTIVE_NFE_PUBLIC_CORPORATION -
related_corporationstringName of related corporation if affiliated with a publicly traded corporation -
controlling_personsarray of objectsControlling persons for Passive NFE or managed investment entitycontrolling_persons object
-
namestringFull name of the controlling person -
addressobjectShared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.address object
- Same shape as
TaxbitAddress.
- Same shape as
-
mailing_addressobjectShared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.mailing_address object
- Same shape as
TaxbitAddress.
- Same shape as
-
mailing_address_is_differentbooleanIndicates if the mailing address differs from the permanent address -
date_of_birthstringDate of birth of the controlling person (YYYY-MM-DD) -
city_of_birthstringCity of birth of the controlling person -
country_of_citizenshipstring enumCountry 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 -
ownership_percentagenumberPercentage of ownership or control -
residence_by_investment_confirmedbooleanConfirms whether tax residency includes any CBI/RBI program -
rolestring enumRole of the controlling person in controlling the entitySETTLORTRUSTEEPROTECTORBENEFICIARYOTHERSETTLOR_EQUIVALENTTRUSTEE_EQUIVALENTPROTECTOR_EQUIVALENTBENEFICIARY_EQUIVALENTOTHER_EQUIVALENTOWNEROTHER_MEANSSENIOR_MANAGING_OFFICIAL -
role_otherstringDescription when role is OTHER -
role_other_equivalentstringDescription when role is OTHER_EQUIVALENT -
tax_residencesarray of objectsTax residences of the controlling persontax_residences object
- Same shape as
SelfCertificationTaxResidence.
- Same shape as
-
-
signature_capacitystring enumCapacity in which the representative is signingOFFICEREXECUTOROTHER_CAPACITY -
signature_capacity_otherstringDescription when signature_capacity is OTHER_CAPACITY -
giinstringGlobal Intermediary Identification Number (GIIN) -
residence_by_investment_confirmedbooleanConfirms whether tax residency information includes any CBI/RBI program -
signaturestringElectronic signature of the signer -
active_non_financial_entity_typestring enumDerived active NFE subtypeOTHERINTERNATIONAL_ORGANIZATIONGOVERNMENT_ENTITYCENTRAL_BANKPUBLIC_CORPORATION -
financial_institution_typestring enumDerived financial institution subtypeDEPOSITORY_INSTITUTIONCUSTODIAL_INSTITUTIONINVESTMENT_ENTITYINSURANCE_COMPANYNON_REPORTING_FINANCIAL_INSTITUTION -
investment_entity_managedbooleanIndicates whether the investment entity is professionally managed -
is_individualbooleanIndicates whether the account owner is an individual -
self_certification_account_typestring enumDerived entity account categoryFINANCIAL_INSTITUTIONPASSIVE_NON_FINANCIAL_ENTITYACTIVE_NON_FINANCIAL_ENTITY -
idstring uuid requiredTaxBit internal UUID for the collected Self-Certification -
document_typestring enum requiredDocument type (SELF_CERTIFICATION)SELF_CERTIFICATION -
addressobjectShared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.address object
- Same shape as
TaxbitAddress.
- Same shape as
-
has_certifiedbooleanIndicates whether the self-certification has been certified -
mailing_address_is_differentbooleanIndicates if the mailing address is different from the permanent address -
created_atstringISO 8601 timestamp when the Self-Certification documentation was recorded -
submission_idstring uuidTaxBit submission UUID for the Self-Certification -
revisionnumberRevision number of the Self-Certification submission -
is_derived_signaturebooleanIndicates whether the signature was derived -
tax_id_format_validation_resultsobjectTIN format validation results returned by TaxBittax_id_format_validation_results object
-
resultsarray of objectsresults object
-
country_codestring -
masked_valuestring -
typestring -
validation_resultstring
-
-
-
-
dpsobjectCollected Digital Platform Seller (DPS) datadps object
-
idstring uuid requiredTaxBit internal UUID for the collected DPS documentation -
namestring requiredLegal name of the account owner -
document_typestring enum requiredDocument type (DPS)DPS -
is_individualboolean requiredIndicates if the account owner is an individual -
is_confirmed_correct_completeboolean requiredIndicates if the account owner confirmed accuracy of the information -
addressobjectShared TaxBit address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.address object
- Same shape as
TaxbitAddress.
- Same shape as
-
business_registration_countrystring enumCountry 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 -
business_registration_numberstring -
city_of_birthstring -
country_of_birthstring enumCountry 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 -
date_of_birthstring -
financial_account_identifierstring -
financial_account_namestring -
tax_residencesarray of objectstax_residences object
-
countrystring -
tinstring -
tin_not_requiredboolean
-
-
vatinstring -
vatin_countrystring -
vatin_not_requiredboolean
-
-
400
400
Response Body
object
-
errorstring requiredError message describing the validation failure -
messagestring requiredDetails of why the request was rejected -
issuesarray of objectsPer-field validation failures when the request body fails schema validationissues object
-
<key>object
-
401
401
Response Body
object
-
errorstringError name for the rejected request -
messagestring requiredReason the request was rejected
403
403
Response Body
object
-
errorstringError message when the caller lacks permission on the enterprise -
messagestringExplicit deny message
404
404
Response Body
object
-
errorstring requiredError message indicating the resource was not found -
messagestring requiredWhich resource could not be found
429
429
Response Body
object
-
errorstring requiredError code emitted when the caller exceeds the rate limit -
messagestring requiredHow long to wait before retrying
500
500
Response Body
object
-
errorstring required