Beneficiary Tax Profiles
A beneficiary tax profile holds the US tax information collected from a recipient via an underlying W-9 or W-8 form. It is created per recipient (identified by external_id) and is used as the source of recipient information when generating 1099 forms. Recipients can submit amendments to an existing profile when their information changes or the profile fails validation.
Create a Beneficiary Tax Profile
POST /api/v1/beneficiary_tax_profiles/create
Create a beneficiary tax profile for a recipient. A beneficiary tax profile collects the recipient information (via an underlying W-9 or W-8 form) that is used as the source of recipient information when generating 1099 forms.
One beneficiary tax profile is created per recipient, identified by external_id.
x-on-behalf-of headerUnique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API. Beneficiaries that share the same external identifier are treated as the same recipient for tax purposes.
Recipient details used to file taxes.
Address of recipient.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Name of the individual or organization that is the beneficial owner / intermediary.
Taxpayer Identification Number.
The Tax Identification number.
Type of Tax Identification.
SSNSocial Security Number.
EINEmployer Identification Number.
ITINIndividual Taxpayer Identification Number.
QI_EINQualified Intermediary Employer Identification Number.
WP_EINWithholding Foreign Partnership Employer Identification Number.
WT_EINWithholding Foreign Trust Employer Identification Number.
Business address in the US. Applicable when type is W_8_ECI.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Business name, trade name, DBA name, or disregarded entity name that is different from the name on the tax return. Applicable when type is W_9.
Country of citizenship, incorporation, or organization (2-letter ISO 3166-1 alpha-2 country code). Applicable when type is W_8_BEN, W_8_BEN_E, W_8_ECI, W_8_EXP, W_8_IMY, or 8233.
Current nonimmigrant status in the US. Applicable when type is 8233.
Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.
Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.
Name of the disregarded entity receiving the payment, if applicable. Applicable when type is W_8_BEN_E, W_8_ECI, or W_8_IMY.
Whether the recipient consents to electronic delivery of Form 1099. Applicable when type is W_9.
Chapter 3 status of the entity (Forms W-8BEN-E, W-8ECI, W-8EXP), or the role in which the entity is acting as an intermediary or flow-through entity (Form W-8IMY). Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
PARTNERSHIPPartnership. Applicable to Form W-8BEN-E or W-8ECI
CORPORATIONCorporation. Applicable to Form W-8BEN-E or W-8ECI
SIMPLE_TRUSTSimple trust. Applicable to Form W-8BEN-E or W-8ECI
TAX_EXEMPT_ORGANIZATIONTax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI
COMPLEX_TRUSTComplex trust. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_CONTROLLED_ENTITYEntity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI
CENTRAL_BANK_OF_ISSUECentral bank of issue. Applicable to Form W-8BEN-E or W-8ECI
PRIVATE_FOUNDATIONPrivate foundation. Applicable to Form W-8BEN-E or W-8ECI
ESTATEEstate. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_INTEGRAL_PARTIntegral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI
GRANTOR_TRUSTGrantor trust. Applicable to Form W-8BEN-E or W-8ECI
DISREGARDED_ENTITYDisregarded entity. Applicable to Form W-8BEN-E or W-8ECI
INTERNATIONAL_ORGANIZATIONInternational organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP
FOREIGN_GOVERNMENTForeign government. Applicable to Form W-8EXP
FOREIGN_CENTRAL_BANK_OF_ISSUEForeign central bank of issue. Applicable to Form W-8EXP
FOREIGN_TAX_EXEMPT_ORGANIZATIONForeign tax-exempt organization under section 501(c). Applicable to Form W-8EXP
FOREIGN_PRIVATE_FOUNDATIONForeign private foundation. Applicable to Form W-8EXP
GOVERNMENT_OF_A_US_TERRITORYGovernment of a US territory or political subdivision. Applicable to Form W-8EXP
QIQualified Intermediary. Applicable to Form W-8IMY
NONQUALIFIED_INTERMEDIARYNonqualified intermediary. Applicable to Form W-8IMY
TERRITORY_FINANCIAL_INSTITUTIONTerritory financial institution. Applicable to Form W-8IMY
US_BRANCHUS branch. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_PARTNERSHIPWithholding foreign partnership. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_TRUSTWithholding foreign trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_PARTNERSHIPNonwithholding foreign partnership. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_SIMPLE_TRUSTNonwithholding foreign simple trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_GRANTOR_TRUSTNonwithholding foreign grantor trust. Applicable to Form W-8IMY
Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.
Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.
Sufficient facts to justify the exemption from withholding claimed, to allow the IRS to determine the tax treaty benefits being claimed. Applicable when type is 8233.
Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.
Foreign Tax Identifying Number. Empty if not legally required. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, W_8_IMY, or 8233.
Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.
Description of the personal services being provided. Applicable when type is 8233.
Mailing address, if different from address or if the form is not delivered electronically. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, or W_8_IMY.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Passport number. Applicable when type is 8233.
Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
Treaty article on which the exemption is based (e.g. "Article 14, paragraph 2"). Applicable when type is 8233 and exempt_from_withholding is true.
Federal tax classification. Applicable when type is W_9.
Tax classification.
INDIVIDUAL_OR_SOLE_PROPRIETORIndividual/sole proprietor or single-member LLC.
C_CORPORATIONC corporation.
S_CORPORATIONS corporation.
PARTNERSHIPPartnership.
TRUST_OR_ESTATETrust or estate.
LLCLimited liability company. Requires llc_type.
OTHEROther entity. Specify the tax classification on the applicable form.
true if the entity has any foreign partners, owners, or beneficiaries. Applicable when type is TRUST_OR_ESTATE or PARTNERSHIP, or when llc_type is P.
Tax classification of the LLC. Applicable when type is LLC.
CC corporation
SS corporation
PPartnership
Name of the tax treaty on which the exemption is based (e.g. "US-Germany tax treaty"). Applicable when type is 8233 and exempt_from_withholding is true.
Items of income to be received from payers that are effectively connected with the conduct of a trade or business in the US. Applicable when type is W_8_ECI.
Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.
Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.
Address in the United States. Applicable when type is 8233.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.
Chapter 3 status specific certifications. Applicable when type is W_8_EXP.
Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies: (1) the entity is a foreign central bank of issue, (2) it does not hold obligations for commercial banking activity, and (3) payments are within the §895 exemption scope. (line 12) Applicable when entity_type is FOREIGN_CENTRAL_BANK_OF_ISSUE.
Certifies that the entity is a foreign government within the meaning of §892 and payments are within the scope of the exemption granted by §892. (line 10a) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity has an IRS determination letter currently in effect concluding it is exempt under §501(c). (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies an opinion from U.S. counsel is attached concluding the entity is described in §501(c). (line 13b) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an international organization within §7701(a)(18) and payments are within the §892 exemption scope. (line 11) Applicable when entity_type is INTERNATIONAL_ORGANIZATION.
Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
A controlled entity of a foreign sovereign (other than a foreign central bank wholly owned) certifies the beneficial owner is not engaged in commercial activities within or outside the US. (line 10d) Applicable when entity_type is FOREIGN_GOVERNMENT.
For a foreign central bank of issue controlled by a foreign sovereign, certifies the beneficial owner is not engaged in commercial activities within the US. (line 10e) Applicable when entity_type is FOREIGN_GOVERNMENT.
For §501(c)(3) organizations only. Certifies the organization is not a private foundation under §509. Requires an affidavit attachment. (line 13c) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
For §501(c)(3) organizations only. Certifies the organization is a private foundation under §509. (line 13d) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies the entity is a US territory government or political subdivision claiming a §115(2) exemption. (line 14) Applicable when entity_type is GOVERNMENT_OF_A_US_TERRITORY.
Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.
Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.
Certifies the entity is acting as a qualified securities lender (other than a QI) assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 17d).
Certifies the entity is using this form to transmit withholding certificates and/or other documentation and has provided or will provide a withholding statement (Line 17b).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a withholding rate pool of US payees (Line 17c).
Certifies the entity is not acting as a QI with respect to accounts for which this form is provided and is not acting for its own account (Line 17a).
Certifies that, where an alternative withholding statement described in Regulations section 1.1441-1(e)(3)(iv)(C)(3) is provided, the information on all associated withholding statements has been (or will be) verified for inconsistency with other account information for determining the rate of withholding for each payee (Line 17e).
Certifications for a Nonwithholding Foreign Partnership, Simple Trust, or Grantor Trust. Applicable when entity_type is NONWITHHOLDING_FOREIGN_PARTNERSHIP, NONWITHHOLDING_FOREIGN_SIMPLE_TRUST, or NONWITHHOLDING_FOREIGN_GRANTOR_TRUST.
Certifies the entity is a foreign grantor trust providing the form on behalf of each grantor or other owner, transmitting withholding certificates and providing a withholding statement to allocate the amount realized (Line 21e).
Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).
Certifies the entity is a foreign partnership receiving an amount realized on the transfer of an interest in a partnership for section 1446(f) purposes (Line 21c).
Certifies the entity is providing this form for payments not effectively connected with a US trade or business, and is using this form to transmit withholding certificates and/or documentation with a withholding statement (Line 21a).
Certifies the entity is a foreign partnership or foreign grantor trust that is a partner in a lower-tier partnership providing this form for section 1446(a) purposes (Line 21b).
Certifies the entity represents that the information on the withholding certificates may be relied upon when providing an alternative withholding statement under Regulations section 1.1441-1(e)(3)(iv)(C)(3) (Line 21f).
Certifications for a Qualified Intermediary. Applicable when entity_type is QI.
Certifies the entity assumes primary Form 1099 reporting and backup withholding responsibility, or reporting responsibility as a participating FFI or registered deemed-compliant FFI, for accounts held by specified US persons (Line 15f).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 for each account identified on a withholding statement (or all accounts if no statement attached) (Line 15a).
Certifies the entity assumes primary withholding as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 15c).
Certifies the entity is a QI acting as a qualified securities lender assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 15d).
Certifies the entity assumes primary withholding and reporting responsibility for payments of amounts realized from sales of interests in publicly traded partnerships under section 1446(f) (Line 15b).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 and primary Form 1099 reporting and backup withholding responsibility for US source interest and substitute interest (Line 15e).
Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).
Certifies the entity has obtained or will obtain documentation for intermediaries or flow-through entities in a chapter 4 withholding rate pool of US payees (Line 15i).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a chapter 4 withholding rate pool of US payees (Line 15h).
Certifies each QDD identified meets the requirements to act as a QDD and assumes primary withholding and reporting responsibilities under chapters 3, 4, and 61 and section 3406 (Line 16a).
Certifies the entity is a QI with respect to identified accounts, has provided or will provide a withholding statement, and will provide required payee documentation if acting as a disclosing QI for section 1446(a) or (f) (Line 14).
Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.
Certifies the entity agrees to be treated as a US person and as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 18e).
Certifies the entity is using this form as evidence of agreement to be treated as a US person for chapters 3 and 4 purposes (Line 18b).
Certifies the entity agrees to be treated as a US person under Regulations section 1.1446(f)-4(a)(2)(i)(B) for amounts realized on sales of interests in publicly traded partnerships (Line 18d).
Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).
Certifies the entity is a financial institution (other than an investment entity that is not also a depository, custodial, or specified insurance institution) incorporated or organized under the laws of a US territory (Line 18a).
Certifications for a US Branch. Applicable when entity_type is US_BRANCH.
Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).
Certifies the entity is a US branch acting as a US person for amounts realized on sales of interests in publicly traded partnerships (Line 19d).
Certifies the entity is a US branch of a foreign bank or insurance company using this form as evidence of agreement to be treated as a US person (Line 19b).
Certifies the entity is using this form to transmit withholding certificates and/or documentation, will provide a withholding statement, and applies rules under Regulations section 1.1471-4(d)(2)(iii)(C) for withholdable payments (Line 19c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).
Certifies the entity is a US branch receiving reportable amounts or withholdable payments that are not ECI, distributions from publicly traded partnerships, or amounts realized on sales of interests in publicly traded partnerships (Line 19a).
Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.
Certifies the entity is a withholding foreign partnership or withholding foreign trust that is compliant with the terms of its WP or WT agreement (Line 20).
Full legal name of the individual providing the electronic signature for the tax form.
The type of underlying tax form of the profile.
W_9Form W-9, for a US person.
W_8_BENForm W-8BEN, for a foreign individual.
W_8_BEN_EForm W-8BEN-E, for a foreign entity.
W_8_ECIForm W-8ECI, for income effectively connected with a US trade or business.
W_8_EXPForm W-8EXP, for a foreign government or other exempt organization.
W_8_IMYForm W-8IMY, for a foreign intermediary or flow-through entity.
8233Form 8233, for exemption from withholding on compensation of a nonresident alien individual.
Additional files for different supporting purposes.
The file ID returned when the document was uploaded to the file service.
Purpose of the supporting document. The applicable values depend on the tax form type.
RESIDENCY_PROOFSupporting document if the address is not in the US. Applicable when the form type is W_9
NON_US_TAX_PROOFSupporting document if the mailing address is in the US. Applicable when the form type is W_8_BEN or W_8_BEN_E
INCOME_ITEM_STATEMENTStatement of taxable income items. Applicable when the form type is W_8_ECI
WITHHOLDING_CERTIFICATIONCertification specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
WITHHOLDING_STATEMENTStatement specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
TAX_EXEMPTION_INCOME_STATEMENTStatement identifying amounts includible under section 512 in computing the entity's unrelated business taxable income. Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
US_COUNSEL_CONCLUSIONOpinion from U.S. counsel concluding the entity is described in section 501(c). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
AFFIDAVITAffidavit for the IRS to determine the organization is not a private foundation because it meets one of the exceptions described in section 509(a)(1), (2), (3), or (4). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
FOREIGN_SCHOLAR_ATTACHMENTStatement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true
Additional description of the file.
Time when the tax profile was created, in ISO 8601 format.
Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.
Additional message if verification failed.
Unique ID of the tax profile.
Recipient details used to file taxes.
Address of recipient.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Name of the individual or organization that is the beneficial owner / intermediary.
Taxpayer Identification Number.
The Tax Identification number.
Type of Tax Identification.
SSNSocial Security Number.
EINEmployer Identification Number.
ITINIndividual Taxpayer Identification Number.
QI_EINQualified Intermediary Employer Identification Number.
WP_EINWithholding Foreign Partnership Employer Identification Number.
WT_EINWithholding Foreign Trust Employer Identification Number.
Business address in the US. Applicable when type is W_8_ECI.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Business name, trade name, DBA name, or disregarded entity name that is different from the name on the tax return. Applicable when type is W_9.
Country of citizenship, incorporation, or organization (2-letter ISO 3166-1 alpha-2 country code). Applicable when type is W_8_BEN, W_8_BEN_E, W_8_ECI, W_8_EXP, W_8_IMY, or 8233.
Current nonimmigrant status in the US. Applicable when type is 8233.
Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.
Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.
Name of the disregarded entity receiving the payment, if applicable. Applicable when type is W_8_BEN_E, W_8_ECI, or W_8_IMY.
Whether the recipient consents to electronic delivery of Form 1099. Applicable when type is W_9.
Chapter 3 status of the entity (Forms W-8BEN-E, W-8ECI, W-8EXP), or the role in which the entity is acting as an intermediary or flow-through entity (Form W-8IMY). Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
PARTNERSHIPPartnership. Applicable to Form W-8BEN-E or W-8ECI
CORPORATIONCorporation. Applicable to Form W-8BEN-E or W-8ECI
SIMPLE_TRUSTSimple trust. Applicable to Form W-8BEN-E or W-8ECI
TAX_EXEMPT_ORGANIZATIONTax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI
COMPLEX_TRUSTComplex trust. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_CONTROLLED_ENTITYEntity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI
CENTRAL_BANK_OF_ISSUECentral bank of issue. Applicable to Form W-8BEN-E or W-8ECI
PRIVATE_FOUNDATIONPrivate foundation. Applicable to Form W-8BEN-E or W-8ECI
ESTATEEstate. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_INTEGRAL_PARTIntegral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI
GRANTOR_TRUSTGrantor trust. Applicable to Form W-8BEN-E or W-8ECI
DISREGARDED_ENTITYDisregarded entity. Applicable to Form W-8BEN-E or W-8ECI
INTERNATIONAL_ORGANIZATIONInternational organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP
FOREIGN_GOVERNMENTForeign government. Applicable to Form W-8EXP
FOREIGN_CENTRAL_BANK_OF_ISSUEForeign central bank of issue. Applicable to Form W-8EXP
FOREIGN_TAX_EXEMPT_ORGANIZATIONForeign tax-exempt organization under section 501(c). Applicable to Form W-8EXP
FOREIGN_PRIVATE_FOUNDATIONForeign private foundation. Applicable to Form W-8EXP
GOVERNMENT_OF_A_US_TERRITORYGovernment of a US territory or political subdivision. Applicable to Form W-8EXP
QIQualified Intermediary. Applicable to Form W-8IMY
NONQUALIFIED_INTERMEDIARYNonqualified intermediary. Applicable to Form W-8IMY
TERRITORY_FINANCIAL_INSTITUTIONTerritory financial institution. Applicable to Form W-8IMY
US_BRANCHUS branch. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_PARTNERSHIPWithholding foreign partnership. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_TRUSTWithholding foreign trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_PARTNERSHIPNonwithholding foreign partnership. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_SIMPLE_TRUSTNonwithholding foreign simple trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_GRANTOR_TRUSTNonwithholding foreign grantor trust. Applicable to Form W-8IMY
Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.
Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.
Sufficient facts to justify the exemption from withholding claimed, to allow the IRS to determine the tax treaty benefits being claimed. Applicable when type is 8233.
Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.
Foreign Tax Identifying Number. Empty if not legally required. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, W_8_IMY, or 8233.
Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.
Description of the personal services being provided. Applicable when type is 8233.
Mailing address, if different from address or if the form is not delivered electronically. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, or W_8_IMY.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Passport number. Applicable when type is 8233.
Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
Treaty article on which the exemption is based (e.g. "Article 14, paragraph 2"). Applicable when type is 8233 and exempt_from_withholding is true.
Federal tax classification. Applicable when type is W_9.
Tax classification.
INDIVIDUAL_OR_SOLE_PROPRIETORIndividual/sole proprietor or single-member LLC.
C_CORPORATIONC corporation.
S_CORPORATIONS corporation.
PARTNERSHIPPartnership.
TRUST_OR_ESTATETrust or estate.
LLCLimited liability company. Requires llc_type.
OTHEROther entity. Specify the tax classification on the applicable form.
true if the entity has any foreign partners, owners, or beneficiaries. Applicable when type is TRUST_OR_ESTATE or PARTNERSHIP, or when llc_type is P.
Tax classification of the LLC. Applicable when type is LLC.
CC corporation
SS corporation
PPartnership
Name of the tax treaty on which the exemption is based (e.g. "US-Germany tax treaty"). Applicable when type is 8233 and exempt_from_withholding is true.
Items of income to be received from payers that are effectively connected with the conduct of a trade or business in the US. Applicable when type is W_8_ECI.
Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.
Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.
Address in the United States. Applicable when type is 8233.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.
Chapter 3 status specific certifications. Applicable when type is W_8_EXP.
Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies: (1) the entity is a foreign central bank of issue, (2) it does not hold obligations for commercial banking activity, and (3) payments are within the §895 exemption scope. (line 12) Applicable when entity_type is FOREIGN_CENTRAL_BANK_OF_ISSUE.
Certifies that the entity is a foreign government within the meaning of §892 and payments are within the scope of the exemption granted by §892. (line 10a) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity has an IRS determination letter currently in effect concluding it is exempt under §501(c). (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies an opinion from U.S. counsel is attached concluding the entity is described in §501(c). (line 13b) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an international organization within §7701(a)(18) and payments are within the §892 exemption scope. (line 11) Applicable when entity_type is INTERNATIONAL_ORGANIZATION.
Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
A controlled entity of a foreign sovereign (other than a foreign central bank wholly owned) certifies the beneficial owner is not engaged in commercial activities within or outside the US. (line 10d) Applicable when entity_type is FOREIGN_GOVERNMENT.
For a foreign central bank of issue controlled by a foreign sovereign, certifies the beneficial owner is not engaged in commercial activities within the US. (line 10e) Applicable when entity_type is FOREIGN_GOVERNMENT.
For §501(c)(3) organizations only. Certifies the organization is not a private foundation under §509. Requires an affidavit attachment. (line 13c) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
For §501(c)(3) organizations only. Certifies the organization is a private foundation under §509. (line 13d) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies the entity is a US territory government or political subdivision claiming a §115(2) exemption. (line 14) Applicable when entity_type is GOVERNMENT_OF_A_US_TERRITORY.
Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.
Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.
Certifies the entity is acting as a qualified securities lender (other than a QI) assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 17d).
Certifies the entity is using this form to transmit withholding certificates and/or other documentation and has provided or will provide a withholding statement (Line 17b).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a withholding rate pool of US payees (Line 17c).
Certifies the entity is not acting as a QI with respect to accounts for which this form is provided and is not acting for its own account (Line 17a).
Certifies that, where an alternative withholding statement described in Regulations section 1.1441-1(e)(3)(iv)(C)(3) is provided, the information on all associated withholding statements has been (or will be) verified for inconsistency with other account information for determining the rate of withholding for each payee (Line 17e).
Certifications for a Nonwithholding Foreign Partnership, Simple Trust, or Grantor Trust. Applicable when entity_type is NONWITHHOLDING_FOREIGN_PARTNERSHIP, NONWITHHOLDING_FOREIGN_SIMPLE_TRUST, or NONWITHHOLDING_FOREIGN_GRANTOR_TRUST.
Certifies the entity is a foreign grantor trust providing the form on behalf of each grantor or other owner, transmitting withholding certificates and providing a withholding statement to allocate the amount realized (Line 21e).
Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).
Certifies the entity is a foreign partnership receiving an amount realized on the transfer of an interest in a partnership for section 1446(f) purposes (Line 21c).
Certifies the entity is providing this form for payments not effectively connected with a US trade or business, and is using this form to transmit withholding certificates and/or documentation with a withholding statement (Line 21a).
Certifies the entity is a foreign partnership or foreign grantor trust that is a partner in a lower-tier partnership providing this form for section 1446(a) purposes (Line 21b).
Certifies the entity represents that the information on the withholding certificates may be relied upon when providing an alternative withholding statement under Regulations section 1.1441-1(e)(3)(iv)(C)(3) (Line 21f).
Certifications for a Qualified Intermediary. Applicable when entity_type is QI.
Certifies the entity assumes primary Form 1099 reporting and backup withholding responsibility, or reporting responsibility as a participating FFI or registered deemed-compliant FFI, for accounts held by specified US persons (Line 15f).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 for each account identified on a withholding statement (or all accounts if no statement attached) (Line 15a).
Certifies the entity assumes primary withholding as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 15c).
Certifies the entity is a QI acting as a qualified securities lender assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 15d).
Certifies the entity assumes primary withholding and reporting responsibility for payments of amounts realized from sales of interests in publicly traded partnerships under section 1446(f) (Line 15b).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 and primary Form 1099 reporting and backup withholding responsibility for US source interest and substitute interest (Line 15e).
Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).
Certifies the entity has obtained or will obtain documentation for intermediaries or flow-through entities in a chapter 4 withholding rate pool of US payees (Line 15i).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a chapter 4 withholding rate pool of US payees (Line 15h).
Certifies each QDD identified meets the requirements to act as a QDD and assumes primary withholding and reporting responsibilities under chapters 3, 4, and 61 and section 3406 (Line 16a).
Certifies the entity is a QI with respect to identified accounts, has provided or will provide a withholding statement, and will provide required payee documentation if acting as a disclosing QI for section 1446(a) or (f) (Line 14).
Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.
Certifies the entity agrees to be treated as a US person and as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 18e).
Certifies the entity is using this form as evidence of agreement to be treated as a US person for chapters 3 and 4 purposes (Line 18b).
Certifies the entity agrees to be treated as a US person under Regulations section 1.1446(f)-4(a)(2)(i)(B) for amounts realized on sales of interests in publicly traded partnerships (Line 18d).
Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).
Certifies the entity is a financial institution (other than an investment entity that is not also a depository, custodial, or specified insurance institution) incorporated or organized under the laws of a US territory (Line 18a).
Certifications for a US Branch. Applicable when entity_type is US_BRANCH.
Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).
Certifies the entity is a US branch acting as a US person for amounts realized on sales of interests in publicly traded partnerships (Line 19d).
Certifies the entity is a US branch of a foreign bank or insurance company using this form as evidence of agreement to be treated as a US person (Line 19b).
Certifies the entity is using this form to transmit withholding certificates and/or documentation, will provide a withholding statement, and applies rules under Regulations section 1.1471-4(d)(2)(iii)(C) for withholdable payments (Line 19c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).
Certifies the entity is a US branch receiving reportable amounts or withholdable payments that are not ECI, distributions from publicly traded partnerships, or amounts realized on sales of interests in publicly traded partnerships (Line 19a).
Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.
Certifies the entity is a withholding foreign partnership or withholding foreign trust that is compliant with the terms of its WP or WT agreement (Line 20).
Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.
Details about what payer information is incomplete.
A detailed message describing the missing information.
Type of information that is missing or incorrect.
TAX_IDENTIFIERThe payer's tax identifier is missing or incorrect
STATEThe payer's state is missing or incorrect
CITYThe payer's city is missing or incorrect
COUNTRY_CODEThe payer's country code is missing or incorrect
BUSINESS_NAMEThe payer's business name is missing or incorrect
PHONE_NUMBERThe payer's phone number is missing or incorrect
Full legal name of the individual who provided the electronic signature.
Status of the tax profile.
SUBMITTEDThe tax profile has been submitted and is pending review
REJECTEDThe tax profile has been rejected. The reason can be found in failure_reason
ACTION_REQUIREDAdditional information or action is required to continue. Details can be found in requirements
SUPERSEDEDThe tax profile version has been replaced by a newer version created through an approved amendment
READYProfile review passed and the profile is ready to be used for filing
Additional files uploaded for different supporting purposes.
The file ID returned when the document was uploaded to the file service.
Purpose of the supporting document. The applicable values depend on the tax form type.
RESIDENCY_PROOFSupporting document if the address is not in the US. Applicable when the form type is W_9
NON_US_TAX_PROOFSupporting document if the mailing address is in the US. Applicable when the form type is W_8_BEN or W_8_BEN_E
INCOME_ITEM_STATEMENTStatement of taxable income items. Applicable when the form type is W_8_ECI
WITHHOLDING_CERTIFICATIONCertification specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
WITHHOLDING_STATEMENTStatement specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
TAX_EXEMPTION_INCOME_STATEMENTStatement identifying amounts includible under section 512 in computing the entity's unrelated business taxable income. Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
US_COUNSEL_CONCLUSIONOpinion from U.S. counsel concluding the entity is described in section 501(c). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
AFFIDAVITAffidavit for the IRS to determine the organization is not a private foundation because it meets one of the exceptions described in section 509(a)(1), (2), (3), or (4). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
FOREIGN_SCHOLAR_ATTACHMENTStatement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true
Additional description of the file.
The type of underlying tax form of the profile.
W_9Form W-9, for a US person.
W_8_BENForm W-8BEN, for a foreign individual.
W_8_BEN_EForm W-8BEN-E, for a foreign entity.
W_8_ECIForm W-8ECI, for income effectively connected with a US trade or business.
W_8_EXPForm W-8EXP, for a foreign government or other exempt organization.
W_8_IMYForm W-8IMY, for a foreign intermediary or flow-through entity.
8233Form 8233, for exemption from withholding on compensation of a nonresident alien individual.
Time when the tax profile was last updated, in ISO 8601 format.
The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/beneficiary_tax_profiles/create' \> --header 'Authorization: Bearer <token>' \> --header 'Content-Type: application/json' \> --data '{> "type": "W_9",> "external_id": "recipient-7f3a9c12",> "signature_name": "Jane A. Smith",> "supporting_documents": [> {> "tag": "RESIDENCY_PROOF",> "file_id": "file-4b2e1d09c3",> "description": "Utility bill confirming non-US address."> }> ],> "profile_details": {> "name": "Jane A. Smith",> "business_name": "Smith Consulting LLC",> "tax_classification": {> "type": "LLC",> "llc_type": "S"> },> "tax_identifier": {> "type": "EIN",> "number": "12-3456789"> },> "address": {> "country_code": "US",> "country_name": "United States",> "address_line1": "456 Oak Avenue",> "address_line2": "Suite 100",> "postcode": "94105",> "state": "California",> "state_code": "CA",> "suburb": "San Francisco"> },> "electronic_delivery_consent": true> }>}'
1{2 "id": "txf-9a1b2c3d4e5f",3 "version": 1,4 "status": "SUBMITTED",5 "type": "W_9",6 "external_id": "recipient-7f3a9c12",7 "signature_name": "Jane A. Smith",8 "supporting_documents": [9 {10 "tag": "RESIDENCY_PROOF",11 "file_id": "file-4b2e1d09c3",12 "description": "Utility bill confirming non-US address."13 }14 ],15 "profile_details": {16 "name": "Jane A. Smith",17 "business_name": "Smith Consulting LLC",18 "tax_classification": {19 "type": "LLC",20 "llc_type": "S"21 },22 "tax_identifier": {23 "type": "EIN",24 "number": "12-3456789"25 },26 "address": {27 "country_code": "US",28 "country_name": "United States",29 "address_line1": "456 Oak Avenue",30 "address_line2": "Suite 100",31 "postcode": "94105",32 "state": "California",33 "state_code": "CA",34 "suburb": "San Francisco"35 },36 "electronic_delivery_consent": true37 },38 "created_at": "2026-06-10T08:30:00+0000",39 "updated_at": "2026-06-10T08:30:00+0000"40}
Retrieve a Beneficiary Tax Profile
GET /api/v1/beneficiary_tax_profiles/{id}
Retrieve the latest version of a beneficiary tax profile by its unique ID.
To retrieve a specific historical version, use GET /api/v1/beneficiary_tax_profiles/{id}/versions/{version}.
x-on-behalf-of headerUnique ID of the tax profile.
Time when the tax profile was created, in ISO 8601 format.
Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.
Additional message if verification failed.
Unique ID of the tax profile.
Recipient details used to file taxes.
Address of recipient.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Name of the individual or organization that is the beneficial owner / intermediary.
Taxpayer Identification Number.
The Tax Identification number.
Type of Tax Identification.
SSNSocial Security Number.
EINEmployer Identification Number.
ITINIndividual Taxpayer Identification Number.
QI_EINQualified Intermediary Employer Identification Number.
WP_EINWithholding Foreign Partnership Employer Identification Number.
WT_EINWithholding Foreign Trust Employer Identification Number.
Business address in the US. Applicable when type is W_8_ECI.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Business name, trade name, DBA name, or disregarded entity name that is different from the name on the tax return. Applicable when type is W_9.
Country of citizenship, incorporation, or organization (2-letter ISO 3166-1 alpha-2 country code). Applicable when type is W_8_BEN, W_8_BEN_E, W_8_ECI, W_8_EXP, W_8_IMY, or 8233.
Current nonimmigrant status in the US. Applicable when type is 8233.
Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.
Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.
Name of the disregarded entity receiving the payment, if applicable. Applicable when type is W_8_BEN_E, W_8_ECI, or W_8_IMY.
Whether the recipient consents to electronic delivery of Form 1099. Applicable when type is W_9.
Chapter 3 status of the entity (Forms W-8BEN-E, W-8ECI, W-8EXP), or the role in which the entity is acting as an intermediary or flow-through entity (Form W-8IMY). Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
PARTNERSHIPPartnership. Applicable to Form W-8BEN-E or W-8ECI
CORPORATIONCorporation. Applicable to Form W-8BEN-E or W-8ECI
SIMPLE_TRUSTSimple trust. Applicable to Form W-8BEN-E or W-8ECI
TAX_EXEMPT_ORGANIZATIONTax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI
COMPLEX_TRUSTComplex trust. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_CONTROLLED_ENTITYEntity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI
CENTRAL_BANK_OF_ISSUECentral bank of issue. Applicable to Form W-8BEN-E or W-8ECI
PRIVATE_FOUNDATIONPrivate foundation. Applicable to Form W-8BEN-E or W-8ECI
ESTATEEstate. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_INTEGRAL_PARTIntegral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI
GRANTOR_TRUSTGrantor trust. Applicable to Form W-8BEN-E or W-8ECI
DISREGARDED_ENTITYDisregarded entity. Applicable to Form W-8BEN-E or W-8ECI
INTERNATIONAL_ORGANIZATIONInternational organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP
FOREIGN_GOVERNMENTForeign government. Applicable to Form W-8EXP
FOREIGN_CENTRAL_BANK_OF_ISSUEForeign central bank of issue. Applicable to Form W-8EXP
FOREIGN_TAX_EXEMPT_ORGANIZATIONForeign tax-exempt organization under section 501(c). Applicable to Form W-8EXP
FOREIGN_PRIVATE_FOUNDATIONForeign private foundation. Applicable to Form W-8EXP
GOVERNMENT_OF_A_US_TERRITORYGovernment of a US territory or political subdivision. Applicable to Form W-8EXP
QIQualified Intermediary. Applicable to Form W-8IMY
NONQUALIFIED_INTERMEDIARYNonqualified intermediary. Applicable to Form W-8IMY
TERRITORY_FINANCIAL_INSTITUTIONTerritory financial institution. Applicable to Form W-8IMY
US_BRANCHUS branch. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_PARTNERSHIPWithholding foreign partnership. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_TRUSTWithholding foreign trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_PARTNERSHIPNonwithholding foreign partnership. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_SIMPLE_TRUSTNonwithholding foreign simple trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_GRANTOR_TRUSTNonwithholding foreign grantor trust. Applicable to Form W-8IMY
Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.
Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.
Sufficient facts to justify the exemption from withholding claimed, to allow the IRS to determine the tax treaty benefits being claimed. Applicable when type is 8233.
Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.
Foreign Tax Identifying Number. Empty if not legally required. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, W_8_IMY, or 8233.
Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.
Description of the personal services being provided. Applicable when type is 8233.
Mailing address, if different from address or if the form is not delivered electronically. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, or W_8_IMY.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Passport number. Applicable when type is 8233.
Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
Treaty article on which the exemption is based (e.g. "Article 14, paragraph 2"). Applicable when type is 8233 and exempt_from_withholding is true.
Federal tax classification. Applicable when type is W_9.
Tax classification.
INDIVIDUAL_OR_SOLE_PROPRIETORIndividual/sole proprietor or single-member LLC.
C_CORPORATIONC corporation.
S_CORPORATIONS corporation.
PARTNERSHIPPartnership.
TRUST_OR_ESTATETrust or estate.
LLCLimited liability company. Requires llc_type.
OTHEROther entity. Specify the tax classification on the applicable form.
true if the entity has any foreign partners, owners, or beneficiaries. Applicable when type is TRUST_OR_ESTATE or PARTNERSHIP, or when llc_type is P.
Tax classification of the LLC. Applicable when type is LLC.
CC corporation
SS corporation
PPartnership
Name of the tax treaty on which the exemption is based (e.g. "US-Germany tax treaty"). Applicable when type is 8233 and exempt_from_withholding is true.
Items of income to be received from payers that are effectively connected with the conduct of a trade or business in the US. Applicable when type is W_8_ECI.
Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.
Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.
Address in the United States. Applicable when type is 8233.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.
Chapter 3 status specific certifications. Applicable when type is W_8_EXP.
Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies: (1) the entity is a foreign central bank of issue, (2) it does not hold obligations for commercial banking activity, and (3) payments are within the §895 exemption scope. (line 12) Applicable when entity_type is FOREIGN_CENTRAL_BANK_OF_ISSUE.
Certifies that the entity is a foreign government within the meaning of §892 and payments are within the scope of the exemption granted by §892. (line 10a) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity has an IRS determination letter currently in effect concluding it is exempt under §501(c). (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies an opinion from U.S. counsel is attached concluding the entity is described in §501(c). (line 13b) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an international organization within §7701(a)(18) and payments are within the §892 exemption scope. (line 11) Applicable when entity_type is INTERNATIONAL_ORGANIZATION.
Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
A controlled entity of a foreign sovereign (other than a foreign central bank wholly owned) certifies the beneficial owner is not engaged in commercial activities within or outside the US. (line 10d) Applicable when entity_type is FOREIGN_GOVERNMENT.
For a foreign central bank of issue controlled by a foreign sovereign, certifies the beneficial owner is not engaged in commercial activities within the US. (line 10e) Applicable when entity_type is FOREIGN_GOVERNMENT.
For §501(c)(3) organizations only. Certifies the organization is not a private foundation under §509. Requires an affidavit attachment. (line 13c) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
For §501(c)(3) organizations only. Certifies the organization is a private foundation under §509. (line 13d) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies the entity is a US territory government or political subdivision claiming a §115(2) exemption. (line 14) Applicable when entity_type is GOVERNMENT_OF_A_US_TERRITORY.
Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.
Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.
Certifies the entity is acting as a qualified securities lender (other than a QI) assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 17d).
Certifies the entity is using this form to transmit withholding certificates and/or other documentation and has provided or will provide a withholding statement (Line 17b).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a withholding rate pool of US payees (Line 17c).
Certifies the entity is not acting as a QI with respect to accounts for which this form is provided and is not acting for its own account (Line 17a).
Certifies that, where an alternative withholding statement described in Regulations section 1.1441-1(e)(3)(iv)(C)(3) is provided, the information on all associated withholding statements has been (or will be) verified for inconsistency with other account information for determining the rate of withholding for each payee (Line 17e).
Certifications for a Nonwithholding Foreign Partnership, Simple Trust, or Grantor Trust. Applicable when entity_type is NONWITHHOLDING_FOREIGN_PARTNERSHIP, NONWITHHOLDING_FOREIGN_SIMPLE_TRUST, or NONWITHHOLDING_FOREIGN_GRANTOR_TRUST.
Certifies the entity is a foreign grantor trust providing the form on behalf of each grantor or other owner, transmitting withholding certificates and providing a withholding statement to allocate the amount realized (Line 21e).
Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).
Certifies the entity is a foreign partnership receiving an amount realized on the transfer of an interest in a partnership for section 1446(f) purposes (Line 21c).
Certifies the entity is providing this form for payments not effectively connected with a US trade or business, and is using this form to transmit withholding certificates and/or documentation with a withholding statement (Line 21a).
Certifies the entity is a foreign partnership or foreign grantor trust that is a partner in a lower-tier partnership providing this form for section 1446(a) purposes (Line 21b).
Certifies the entity represents that the information on the withholding certificates may be relied upon when providing an alternative withholding statement under Regulations section 1.1441-1(e)(3)(iv)(C)(3) (Line 21f).
Certifications for a Qualified Intermediary. Applicable when entity_type is QI.
Certifies the entity assumes primary Form 1099 reporting and backup withholding responsibility, or reporting responsibility as a participating FFI or registered deemed-compliant FFI, for accounts held by specified US persons (Line 15f).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 for each account identified on a withholding statement (or all accounts if no statement attached) (Line 15a).
Certifies the entity assumes primary withholding as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 15c).
Certifies the entity is a QI acting as a qualified securities lender assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 15d).
Certifies the entity assumes primary withholding and reporting responsibility for payments of amounts realized from sales of interests in publicly traded partnerships under section 1446(f) (Line 15b).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 and primary Form 1099 reporting and backup withholding responsibility for US source interest and substitute interest (Line 15e).
Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).
Certifies the entity has obtained or will obtain documentation for intermediaries or flow-through entities in a chapter 4 withholding rate pool of US payees (Line 15i).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a chapter 4 withholding rate pool of US payees (Line 15h).
Certifies each QDD identified meets the requirements to act as a QDD and assumes primary withholding and reporting responsibilities under chapters 3, 4, and 61 and section 3406 (Line 16a).
Certifies the entity is a QI with respect to identified accounts, has provided or will provide a withholding statement, and will provide required payee documentation if acting as a disclosing QI for section 1446(a) or (f) (Line 14).
Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.
Certifies the entity agrees to be treated as a US person and as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 18e).
Certifies the entity is using this form as evidence of agreement to be treated as a US person for chapters 3 and 4 purposes (Line 18b).
Certifies the entity agrees to be treated as a US person under Regulations section 1.1446(f)-4(a)(2)(i)(B) for amounts realized on sales of interests in publicly traded partnerships (Line 18d).
Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).
Certifies the entity is a financial institution (other than an investment entity that is not also a depository, custodial, or specified insurance institution) incorporated or organized under the laws of a US territory (Line 18a).
Certifications for a US Branch. Applicable when entity_type is US_BRANCH.
Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).
Certifies the entity is a US branch acting as a US person for amounts realized on sales of interests in publicly traded partnerships (Line 19d).
Certifies the entity is a US branch of a foreign bank or insurance company using this form as evidence of agreement to be treated as a US person (Line 19b).
Certifies the entity is using this form to transmit withholding certificates and/or documentation, will provide a withholding statement, and applies rules under Regulations section 1.1471-4(d)(2)(iii)(C) for withholdable payments (Line 19c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).
Certifies the entity is a US branch receiving reportable amounts or withholdable payments that are not ECI, distributions from publicly traded partnerships, or amounts realized on sales of interests in publicly traded partnerships (Line 19a).
Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.
Certifies the entity is a withholding foreign partnership or withholding foreign trust that is compliant with the terms of its WP or WT agreement (Line 20).
Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.
Details about what payer information is incomplete.
A detailed message describing the missing information.
Type of information that is missing or incorrect.
TAX_IDENTIFIERThe payer's tax identifier is missing or incorrect
STATEThe payer's state is missing or incorrect
CITYThe payer's city is missing or incorrect
COUNTRY_CODEThe payer's country code is missing or incorrect
BUSINESS_NAMEThe payer's business name is missing or incorrect
PHONE_NUMBERThe payer's phone number is missing or incorrect
Full legal name of the individual who provided the electronic signature.
Status of the tax profile.
SUBMITTEDThe tax profile has been submitted and is pending review
REJECTEDThe tax profile has been rejected. The reason can be found in failure_reason
ACTION_REQUIREDAdditional information or action is required to continue. Details can be found in requirements
SUPERSEDEDThe tax profile version has been replaced by a newer version created through an approved amendment
READYProfile review passed and the profile is ready to be used for filing
Additional files uploaded for different supporting purposes.
The file ID returned when the document was uploaded to the file service.
Purpose of the supporting document. The applicable values depend on the tax form type.
RESIDENCY_PROOFSupporting document if the address is not in the US. Applicable when the form type is W_9
NON_US_TAX_PROOFSupporting document if the mailing address is in the US. Applicable when the form type is W_8_BEN or W_8_BEN_E
INCOME_ITEM_STATEMENTStatement of taxable income items. Applicable when the form type is W_8_ECI
WITHHOLDING_CERTIFICATIONCertification specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
WITHHOLDING_STATEMENTStatement specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
TAX_EXEMPTION_INCOME_STATEMENTStatement identifying amounts includible under section 512 in computing the entity's unrelated business taxable income. Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
US_COUNSEL_CONCLUSIONOpinion from U.S. counsel concluding the entity is described in section 501(c). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
AFFIDAVITAffidavit for the IRS to determine the organization is not a private foundation because it meets one of the exceptions described in section 509(a)(1), (2), (3), or (4). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
FOREIGN_SCHOLAR_ATTACHMENTStatement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true
Additional description of the file.
The type of underlying tax form of the profile.
W_9Form W-9, for a US person.
W_8_BENForm W-8BEN, for a foreign individual.
W_8_BEN_EForm W-8BEN-E, for a foreign entity.
W_8_ECIForm W-8ECI, for income effectively connected with a US trade or business.
W_8_EXPForm W-8EXP, for a foreign government or other exempt organization.
W_8_IMYForm W-8IMY, for a foreign intermediary or flow-through entity.
8233Form 8233, for exemption from withholding on compensation of a nonresident alien individual.
Time when the tax profile was last updated, in ISO 8601 format.
The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 404 | Possible errors: |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/beneficiary_tax_profiles/txf-9a1b2c3d4e5f' \> --header 'Authorization: Bearer <token>' \> --header 'Content-Type: application/json'
1{2 "id": "txf-9a1b2c3d4e5f",3 "version": 1,4 "status": "READY",5 "type": "W_9",6 "external_id": "recipient-7f3a9c12",7 "signature_name": "Jane A. Smith",8 "supporting_documents": [9 {10 "tag": "RESIDENCY_PROOF",11 "file_id": "file-4b2e1d09c3",12 "description": "Utility bill confirming non-US address."13 }14 ],15 "profile_details": {16 "name": "Jane A. Smith",17 "business_name": "Smith Consulting LLC",18 "tax_classification": {19 "type": "LLC",20 "llc_type": "S"21 },22 "tax_identifier": {23 "type": "EIN",24 "number": "12-3456789"25 },26 "address": {27 "country_code": "US",28 "country_name": "United States",29 "address_line1": "456 Oak Avenue",30 "address_line2": "Suite 100",31 "postcode": "94105",32 "state": "California",33 "state_code": "CA",34 "suburb": "San Francisco"35 },36 "electronic_delivery_consent": true37 },38 "created_at": "2026-06-10T08:30:00+0000",39 "updated_at": "2026-06-10T09:15:00+0000"40}
List all Beneficiary Tax Profiles
GET /api/v1/beneficiary_tax_profiles
Retrieve a list of beneficiary tax profiles, filtered by the supplied query parameters. Results are paginated using a cursor.
x-on-behalf-of headerFilter by the unique identifier of a recipient.
The start date of created_at in ISO 8601 format (inclusive).
A bookmark for use in pagination to retrieve either the next page or the previous page of results.
To retrieve the next page of results, pass the value of page_after (if not null) from the response to a subsequent call.
To retrieve the previous page of results, pass the value of page_before (if not null) from the response to a subsequent call.
Number of results per page. Defaults to 100, minimum 10, maximum 200.
Filter by beneficiary tax profile status.
SUBMITTEDThe tax profile has been submitted and is pending review
REJECTEDThe tax profile has been rejected. The reason can be found in failure_reason
ACTION_REQUIREDAdditional information or action is required to continue. Details can be found in requirements
SUPERSEDEDThe tax profile version has been replaced by a newer version created through an approved amendment
READYProfile review passed and the profile is ready to be used for filing
The end date of created_at in ISO 8601 format (inclusive).
Filter by tax form type.
W_9Form W-9, for a US person.
W_8_BENForm W-8BEN, for a foreign individual.
W_8_BEN_EForm W-8BEN-E, for a foreign entity.
W_8_ECIForm W-8ECI, for income effectively connected with a US trade or business.
W_8_EXPForm W-8EXP, for a foreign government or other exempt organization.
W_8_IMYForm W-8IMY, for a foreign intermediary or flow-through entity.
8233Form 8233, for exemption from withholding on compensation of a nonresident alien individual.
An array of paged results.
Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.
Unique ID of the tax profile.
Status of the tax profile.
SUBMITTEDThe tax profile has been submitted and is pending review
REJECTEDThe tax profile has been rejected. The reason can be found in failure_reason
ACTION_REQUIREDAdditional information or action is required to continue. Details can be found in requirements
SUPERSEDEDThe tax profile version has been replaced by a newer version created through an approved amendment
READYProfile review passed and the profile is ready to be used for filing
The type of underlying tax form of the profile.
W_9Form W-9, for a US person.
W_8_BENForm W-8BEN, for a foreign individual.
W_8_BEN_EForm W-8BEN-E, for a foreign entity.
W_8_ECIForm W-8ECI, for income effectively connected with a US trade or business.
W_8_EXPForm W-8EXP, for a foreign government or other exempt organization.
W_8_IMYForm W-8IMY, for a foreign intermediary or flow-through entity.
8233Form 8233, for exemption from withholding on compensation of a nonresident alien individual.
The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.
Time when the tax profile was created, in ISO 8601 format.
Additional message if verification failed.
Recipient details used to file taxes.
Address of recipient.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Name of the individual or organization that is the beneficial owner / intermediary.
Taxpayer Identification Number.
The Tax Identification number.
Type of Tax Identification.
SSNSocial Security Number.
EINEmployer Identification Number.
ITINIndividual Taxpayer Identification Number.
QI_EINQualified Intermediary Employer Identification Number.
WP_EINWithholding Foreign Partnership Employer Identification Number.
WT_EINWithholding Foreign Trust Employer Identification Number.
Business address in the US. Applicable when type is W_8_ECI.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Business name, trade name, DBA name, or disregarded entity name that is different from the name on the tax return. Applicable when type is W_9.
Country of citizenship, incorporation, or organization (2-letter ISO 3166-1 alpha-2 country code). Applicable when type is W_8_BEN, W_8_BEN_E, W_8_ECI, W_8_EXP, W_8_IMY, or 8233.
Current nonimmigrant status in the US. Applicable when type is 8233.
Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.
Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.
Name of the disregarded entity receiving the payment, if applicable. Applicable when type is W_8_BEN_E, W_8_ECI, or W_8_IMY.
Whether the recipient consents to electronic delivery of Form 1099. Applicable when type is W_9.
Chapter 3 status of the entity (Forms W-8BEN-E, W-8ECI, W-8EXP), or the role in which the entity is acting as an intermediary or flow-through entity (Form W-8IMY). Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
PARTNERSHIPPartnership. Applicable to Form W-8BEN-E or W-8ECI
CORPORATIONCorporation. Applicable to Form W-8BEN-E or W-8ECI
SIMPLE_TRUSTSimple trust. Applicable to Form W-8BEN-E or W-8ECI
TAX_EXEMPT_ORGANIZATIONTax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI
COMPLEX_TRUSTComplex trust. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_CONTROLLED_ENTITYEntity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI
CENTRAL_BANK_OF_ISSUECentral bank of issue. Applicable to Form W-8BEN-E or W-8ECI
PRIVATE_FOUNDATIONPrivate foundation. Applicable to Form W-8BEN-E or W-8ECI
ESTATEEstate. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_INTEGRAL_PARTIntegral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI
GRANTOR_TRUSTGrantor trust. Applicable to Form W-8BEN-E or W-8ECI
DISREGARDED_ENTITYDisregarded entity. Applicable to Form W-8BEN-E or W-8ECI
INTERNATIONAL_ORGANIZATIONInternational organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP
FOREIGN_GOVERNMENTForeign government. Applicable to Form W-8EXP
FOREIGN_CENTRAL_BANK_OF_ISSUEForeign central bank of issue. Applicable to Form W-8EXP
FOREIGN_TAX_EXEMPT_ORGANIZATIONForeign tax-exempt organization under section 501(c). Applicable to Form W-8EXP
FOREIGN_PRIVATE_FOUNDATIONForeign private foundation. Applicable to Form W-8EXP
GOVERNMENT_OF_A_US_TERRITORYGovernment of a US territory or political subdivision. Applicable to Form W-8EXP
QIQualified Intermediary. Applicable to Form W-8IMY
NONQUALIFIED_INTERMEDIARYNonqualified intermediary. Applicable to Form W-8IMY
TERRITORY_FINANCIAL_INSTITUTIONTerritory financial institution. Applicable to Form W-8IMY
US_BRANCHUS branch. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_PARTNERSHIPWithholding foreign partnership. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_TRUSTWithholding foreign trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_PARTNERSHIPNonwithholding foreign partnership. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_SIMPLE_TRUSTNonwithholding foreign simple trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_GRANTOR_TRUSTNonwithholding foreign grantor trust. Applicable to Form W-8IMY
Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.
Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.
Sufficient facts to justify the exemption from withholding claimed, to allow the IRS to determine the tax treaty benefits being claimed. Applicable when type is 8233.
Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.
Foreign Tax Identifying Number. Empty if not legally required. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, W_8_IMY, or 8233.
Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.
Description of the personal services being provided. Applicable when type is 8233.
Mailing address, if different from address or if the form is not delivered electronically. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, or W_8_IMY.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Passport number. Applicable when type is 8233.
Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
Treaty article on which the exemption is based (e.g. "Article 14, paragraph 2"). Applicable when type is 8233 and exempt_from_withholding is true.
Federal tax classification. Applicable when type is W_9.
Tax classification.
INDIVIDUAL_OR_SOLE_PROPRIETORIndividual/sole proprietor or single-member LLC.
C_CORPORATIONC corporation.
S_CORPORATIONS corporation.
PARTNERSHIPPartnership.
TRUST_OR_ESTATETrust or estate.
LLCLimited liability company. Requires llc_type.
OTHEROther entity. Specify the tax classification on the applicable form.
true if the entity has any foreign partners, owners, or beneficiaries. Applicable when type is TRUST_OR_ESTATE or PARTNERSHIP, or when llc_type is P.
Tax classification of the LLC. Applicable when type is LLC.
CC corporation
SS corporation
PPartnership
Name of the tax treaty on which the exemption is based (e.g. "US-Germany tax treaty"). Applicable when type is 8233 and exempt_from_withholding is true.
Items of income to be received from payers that are effectively connected with the conduct of a trade or business in the US. Applicable when type is W_8_ECI.
Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.
Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.
Address in the United States. Applicable when type is 8233.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.
Chapter 3 status specific certifications. Applicable when type is W_8_EXP.
Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies: (1) the entity is a foreign central bank of issue, (2) it does not hold obligations for commercial banking activity, and (3) payments are within the §895 exemption scope. (line 12) Applicable when entity_type is FOREIGN_CENTRAL_BANK_OF_ISSUE.
Certifies that the entity is a foreign government within the meaning of §892 and payments are within the scope of the exemption granted by §892. (line 10a) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity has an IRS determination letter currently in effect concluding it is exempt under §501(c). (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies an opinion from U.S. counsel is attached concluding the entity is described in §501(c). (line 13b) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an international organization within §7701(a)(18) and payments are within the §892 exemption scope. (line 11) Applicable when entity_type is INTERNATIONAL_ORGANIZATION.
Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
A controlled entity of a foreign sovereign (other than a foreign central bank wholly owned) certifies the beneficial owner is not engaged in commercial activities within or outside the US. (line 10d) Applicable when entity_type is FOREIGN_GOVERNMENT.
For a foreign central bank of issue controlled by a foreign sovereign, certifies the beneficial owner is not engaged in commercial activities within the US. (line 10e) Applicable when entity_type is FOREIGN_GOVERNMENT.
For §501(c)(3) organizations only. Certifies the organization is not a private foundation under §509. Requires an affidavit attachment. (line 13c) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
For §501(c)(3) organizations only. Certifies the organization is a private foundation under §509. (line 13d) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies the entity is a US territory government or political subdivision claiming a §115(2) exemption. (line 14) Applicable when entity_type is GOVERNMENT_OF_A_US_TERRITORY.
Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.
Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.
Certifies the entity is acting as a qualified securities lender (other than a QI) assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 17d).
Certifies the entity is using this form to transmit withholding certificates and/or other documentation and has provided or will provide a withholding statement (Line 17b).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a withholding rate pool of US payees (Line 17c).
Certifies the entity is not acting as a QI with respect to accounts for which this form is provided and is not acting for its own account (Line 17a).
Certifies that, where an alternative withholding statement described in Regulations section 1.1441-1(e)(3)(iv)(C)(3) is provided, the information on all associated withholding statements has been (or will be) verified for inconsistency with other account information for determining the rate of withholding for each payee (Line 17e).
Certifications for a Nonwithholding Foreign Partnership, Simple Trust, or Grantor Trust. Applicable when entity_type is NONWITHHOLDING_FOREIGN_PARTNERSHIP, NONWITHHOLDING_FOREIGN_SIMPLE_TRUST, or NONWITHHOLDING_FOREIGN_GRANTOR_TRUST.
Certifies the entity is a foreign grantor trust providing the form on behalf of each grantor or other owner, transmitting withholding certificates and providing a withholding statement to allocate the amount realized (Line 21e).
Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).
Certifies the entity is a foreign partnership receiving an amount realized on the transfer of an interest in a partnership for section 1446(f) purposes (Line 21c).
Certifies the entity is providing this form for payments not effectively connected with a US trade or business, and is using this form to transmit withholding certificates and/or documentation with a withholding statement (Line 21a).
Certifies the entity is a foreign partnership or foreign grantor trust that is a partner in a lower-tier partnership providing this form for section 1446(a) purposes (Line 21b).
Certifies the entity represents that the information on the withholding certificates may be relied upon when providing an alternative withholding statement under Regulations section 1.1441-1(e)(3)(iv)(C)(3) (Line 21f).
Certifications for a Qualified Intermediary. Applicable when entity_type is QI.
Certifies the entity assumes primary Form 1099 reporting and backup withholding responsibility, or reporting responsibility as a participating FFI or registered deemed-compliant FFI, for accounts held by specified US persons (Line 15f).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 for each account identified on a withholding statement (or all accounts if no statement attached) (Line 15a).
Certifies the entity assumes primary withholding as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 15c).
Certifies the entity is a QI acting as a qualified securities lender assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 15d).
Certifies the entity assumes primary withholding and reporting responsibility for payments of amounts realized from sales of interests in publicly traded partnerships under section 1446(f) (Line 15b).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 and primary Form 1099 reporting and backup withholding responsibility for US source interest and substitute interest (Line 15e).
Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).
Certifies the entity has obtained or will obtain documentation for intermediaries or flow-through entities in a chapter 4 withholding rate pool of US payees (Line 15i).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a chapter 4 withholding rate pool of US payees (Line 15h).
Certifies each QDD identified meets the requirements to act as a QDD and assumes primary withholding and reporting responsibilities under chapters 3, 4, and 61 and section 3406 (Line 16a).
Certifies the entity is a QI with respect to identified accounts, has provided or will provide a withholding statement, and will provide required payee documentation if acting as a disclosing QI for section 1446(a) or (f) (Line 14).
Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.
Certifies the entity agrees to be treated as a US person and as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 18e).
Certifies the entity is using this form as evidence of agreement to be treated as a US person for chapters 3 and 4 purposes (Line 18b).
Certifies the entity agrees to be treated as a US person under Regulations section 1.1446(f)-4(a)(2)(i)(B) for amounts realized on sales of interests in publicly traded partnerships (Line 18d).
Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).
Certifies the entity is a financial institution (other than an investment entity that is not also a depository, custodial, or specified insurance institution) incorporated or organized under the laws of a US territory (Line 18a).
Certifications for a US Branch. Applicable when entity_type is US_BRANCH.
Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).
Certifies the entity is a US branch acting as a US person for amounts realized on sales of interests in publicly traded partnerships (Line 19d).
Certifies the entity is a US branch of a foreign bank or insurance company using this form as evidence of agreement to be treated as a US person (Line 19b).
Certifies the entity is using this form to transmit withholding certificates and/or documentation, will provide a withholding statement, and applies rules under Regulations section 1.1471-4(d)(2)(iii)(C) for withholdable payments (Line 19c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).
Certifies the entity is a US branch receiving reportable amounts or withholdable payments that are not ECI, distributions from publicly traded partnerships, or amounts realized on sales of interests in publicly traded partnerships (Line 19a).
Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.
Certifies the entity is a withholding foreign partnership or withholding foreign trust that is compliant with the terms of its WP or WT agreement (Line 20).
Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.
Details about what payer information is incomplete.
A detailed message describing the missing information.
Type of information that is missing or incorrect.
TAX_IDENTIFIERThe payer's tax identifier is missing or incorrect
STATEThe payer's state is missing or incorrect
CITYThe payer's city is missing or incorrect
COUNTRY_CODEThe payer's country code is missing or incorrect
BUSINESS_NAMEThe payer's business name is missing or incorrect
PHONE_NUMBERThe payer's phone number is missing or incorrect
Full legal name of the individual who provided the electronic signature.
Additional files uploaded for different supporting purposes.
The file ID returned when the document was uploaded to the file service.
Purpose of the supporting document. The applicable values depend on the tax form type.
RESIDENCY_PROOFSupporting document if the address is not in the US. Applicable when the form type is W_9
NON_US_TAX_PROOFSupporting document if the mailing address is in the US. Applicable when the form type is W_8_BEN or W_8_BEN_E
INCOME_ITEM_STATEMENTStatement of taxable income items. Applicable when the form type is W_8_ECI
WITHHOLDING_CERTIFICATIONCertification specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
WITHHOLDING_STATEMENTStatement specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
TAX_EXEMPTION_INCOME_STATEMENTStatement identifying amounts includible under section 512 in computing the entity's unrelated business taxable income. Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
US_COUNSEL_CONCLUSIONOpinion from U.S. counsel concluding the entity is described in section 501(c). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
AFFIDAVITAffidavit for the IRS to determine the organization is not a private foundation because it meets one of the exceptions described in section 509(a)(1), (2), (3), or (4). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
FOREIGN_SCHOLAR_ATTACHMENTStatement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true
Additional description of the file.
Time when the tax profile was last updated, in ISO 8601 format.
The cursor for the next page of results. Pass this value as page in a subsequent request. null if there are no more results.
The cursor for the previous page of results. Pass this value as page in a subsequent request. null if there are no previous results.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/beneficiary_tax_profiles' \> --header 'Authorization: Bearer <token>' \> --header 'Content-Type: application/json'
1{2 "items": [3 {4 "id": "txf-9a1b2c3d4e5f",5 "version": 1,6 "status": "READY",7 "type": "W_9",8 "external_id": "recipient-7f3a9c12",9 "signature_name": "Jane A. Smith",10 "profile_details": {11 "name": "Jane A. Smith",12 "business_name": "Smith Consulting LLC",13 "tax_classification": {14 "type": "LLC",15 "llc_type": "S"16 },17 "tax_identifier": {18 "type": "EIN",19 "number": "12-3456789"20 },21 "address": {22 "country_code": "US",23 "country_name": "United States",24 "address_line1": "456 Oak Avenue",25 "address_line2": "Suite 100",26 "postcode": "94105",27 "state": "California",28 "state_code": "CA",29 "suburb": "San Francisco"30 },31 "electronic_delivery_consent": true32 },33 "created_at": "2026-06-10T08:30:00+0000",34 "updated_at": "2026-06-10T09:15:00+0000"35 }36 ],37 "page_before": "<string>",38 "page_after": "eyJwYWdlIjogMn0"39}
Download the Latest Version of a Beneficiary Tax Profile
POST /api/v1/beneficiary_tax_profiles/{id}/download
Download the latest version of a beneficiary tax profile as a PDF (rendered from the underlying W-9 or W-8 form).
Use POST /api/v1/beneficiary_tax_profiles/{id}/versions/{version}/download to generate a PDF for a historical version.
x-on-behalf-of headerUnique ID of the tax profile.
URL that can be used to retrieve the file. This URL expires shortly after it is generated.
Download URL expiry timestamp, in ISO 8601 format.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 404 | Possible errors: |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/beneficiary_tax_profiles/txf-1a2b3c4d5e6f/download' \> --header 'Authorization: Bearer <token>'
1{2 "download_url": "https://api-downloads.airwallex.com/beneficiary_tax_profiles/txf-1a2b3c4d5e6f.pdf?signature=1a2b3c4d5e6f7a8b9c0d",3 "expires_at": "2026-06-10T08:35:00+0000"4}
Retrieve a Beneficiary Tax Profile Version
GET /api/v1/beneficiary_tax_profiles/{id}/versions/{version}
Retrieve a specific historical version of a beneficiary tax profile. The tax profile ID remains unchanged across versions; a new version is created each time an approved amendment is applied.
x-on-behalf-of headerUnique ID of the tax profile.
Exact tax profile version to retrieve.
Time when the tax profile was created, in ISO 8601 format.
Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.
Additional message if verification failed.
Unique ID of the tax profile.
Recipient details used to file taxes.
Address of recipient.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Name of the individual or organization that is the beneficial owner / intermediary.
Taxpayer Identification Number.
The Tax Identification number.
Type of Tax Identification.
SSNSocial Security Number.
EINEmployer Identification Number.
ITINIndividual Taxpayer Identification Number.
QI_EINQualified Intermediary Employer Identification Number.
WP_EINWithholding Foreign Partnership Employer Identification Number.
WT_EINWithholding Foreign Trust Employer Identification Number.
Business address in the US. Applicable when type is W_8_ECI.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Business name, trade name, DBA name, or disregarded entity name that is different from the name on the tax return. Applicable when type is W_9.
Country of citizenship, incorporation, or organization (2-letter ISO 3166-1 alpha-2 country code). Applicable when type is W_8_BEN, W_8_BEN_E, W_8_ECI, W_8_EXP, W_8_IMY, or 8233.
Current nonimmigrant status in the US. Applicable when type is 8233.
Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.
Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.
Name of the disregarded entity receiving the payment, if applicable. Applicable when type is W_8_BEN_E, W_8_ECI, or W_8_IMY.
Whether the recipient consents to electronic delivery of Form 1099. Applicable when type is W_9.
Chapter 3 status of the entity (Forms W-8BEN-E, W-8ECI, W-8EXP), or the role in which the entity is acting as an intermediary or flow-through entity (Form W-8IMY). Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
PARTNERSHIPPartnership. Applicable to Form W-8BEN-E or W-8ECI
CORPORATIONCorporation. Applicable to Form W-8BEN-E or W-8ECI
SIMPLE_TRUSTSimple trust. Applicable to Form W-8BEN-E or W-8ECI
TAX_EXEMPT_ORGANIZATIONTax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI
COMPLEX_TRUSTComplex trust. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_CONTROLLED_ENTITYEntity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI
CENTRAL_BANK_OF_ISSUECentral bank of issue. Applicable to Form W-8BEN-E or W-8ECI
PRIVATE_FOUNDATIONPrivate foundation. Applicable to Form W-8BEN-E or W-8ECI
ESTATEEstate. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_INTEGRAL_PARTIntegral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI
GRANTOR_TRUSTGrantor trust. Applicable to Form W-8BEN-E or W-8ECI
DISREGARDED_ENTITYDisregarded entity. Applicable to Form W-8BEN-E or W-8ECI
INTERNATIONAL_ORGANIZATIONInternational organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP
FOREIGN_GOVERNMENTForeign government. Applicable to Form W-8EXP
FOREIGN_CENTRAL_BANK_OF_ISSUEForeign central bank of issue. Applicable to Form W-8EXP
FOREIGN_TAX_EXEMPT_ORGANIZATIONForeign tax-exempt organization under section 501(c). Applicable to Form W-8EXP
FOREIGN_PRIVATE_FOUNDATIONForeign private foundation. Applicable to Form W-8EXP
GOVERNMENT_OF_A_US_TERRITORYGovernment of a US territory or political subdivision. Applicable to Form W-8EXP
QIQualified Intermediary. Applicable to Form W-8IMY
NONQUALIFIED_INTERMEDIARYNonqualified intermediary. Applicable to Form W-8IMY
TERRITORY_FINANCIAL_INSTITUTIONTerritory financial institution. Applicable to Form W-8IMY
US_BRANCHUS branch. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_PARTNERSHIPWithholding foreign partnership. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_TRUSTWithholding foreign trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_PARTNERSHIPNonwithholding foreign partnership. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_SIMPLE_TRUSTNonwithholding foreign simple trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_GRANTOR_TRUSTNonwithholding foreign grantor trust. Applicable to Form W-8IMY
Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.
Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.
Sufficient facts to justify the exemption from withholding claimed, to allow the IRS to determine the tax treaty benefits being claimed. Applicable when type is 8233.
Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.
Foreign Tax Identifying Number. Empty if not legally required. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, W_8_IMY, or 8233.
Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.
Description of the personal services being provided. Applicable when type is 8233.
Mailing address, if different from address or if the form is not delivered electronically. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, or W_8_IMY.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Passport number. Applicable when type is 8233.
Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
Treaty article on which the exemption is based (e.g. "Article 14, paragraph 2"). Applicable when type is 8233 and exempt_from_withholding is true.
Federal tax classification. Applicable when type is W_9.
Tax classification.
INDIVIDUAL_OR_SOLE_PROPRIETORIndividual/sole proprietor or single-member LLC.
C_CORPORATIONC corporation.
S_CORPORATIONS corporation.
PARTNERSHIPPartnership.
TRUST_OR_ESTATETrust or estate.
LLCLimited liability company. Requires llc_type.
OTHEROther entity. Specify the tax classification on the applicable form.
true if the entity has any foreign partners, owners, or beneficiaries. Applicable when type is TRUST_OR_ESTATE or PARTNERSHIP, or when llc_type is P.
Tax classification of the LLC. Applicable when type is LLC.
CC corporation
SS corporation
PPartnership
Name of the tax treaty on which the exemption is based (e.g. "US-Germany tax treaty"). Applicable when type is 8233 and exempt_from_withholding is true.
Items of income to be received from payers that are effectively connected with the conduct of a trade or business in the US. Applicable when type is W_8_ECI.
Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.
Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.
Address in the United States. Applicable when type is 8233.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.
Chapter 3 status specific certifications. Applicable when type is W_8_EXP.
Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies: (1) the entity is a foreign central bank of issue, (2) it does not hold obligations for commercial banking activity, and (3) payments are within the §895 exemption scope. (line 12) Applicable when entity_type is FOREIGN_CENTRAL_BANK_OF_ISSUE.
Certifies that the entity is a foreign government within the meaning of §892 and payments are within the scope of the exemption granted by §892. (line 10a) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity has an IRS determination letter currently in effect concluding it is exempt under §501(c). (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies an opinion from U.S. counsel is attached concluding the entity is described in §501(c). (line 13b) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an international organization within §7701(a)(18) and payments are within the §892 exemption scope. (line 11) Applicable when entity_type is INTERNATIONAL_ORGANIZATION.
Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
A controlled entity of a foreign sovereign (other than a foreign central bank wholly owned) certifies the beneficial owner is not engaged in commercial activities within or outside the US. (line 10d) Applicable when entity_type is FOREIGN_GOVERNMENT.
For a foreign central bank of issue controlled by a foreign sovereign, certifies the beneficial owner is not engaged in commercial activities within the US. (line 10e) Applicable when entity_type is FOREIGN_GOVERNMENT.
For §501(c)(3) organizations only. Certifies the organization is not a private foundation under §509. Requires an affidavit attachment. (line 13c) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
For §501(c)(3) organizations only. Certifies the organization is a private foundation under §509. (line 13d) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies the entity is a US territory government or political subdivision claiming a §115(2) exemption. (line 14) Applicable when entity_type is GOVERNMENT_OF_A_US_TERRITORY.
Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.
Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.
Certifies the entity is acting as a qualified securities lender (other than a QI) assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 17d).
Certifies the entity is using this form to transmit withholding certificates and/or other documentation and has provided or will provide a withholding statement (Line 17b).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a withholding rate pool of US payees (Line 17c).
Certifies the entity is not acting as a QI with respect to accounts for which this form is provided and is not acting for its own account (Line 17a).
Certifies that, where an alternative withholding statement described in Regulations section 1.1441-1(e)(3)(iv)(C)(3) is provided, the information on all associated withholding statements has been (or will be) verified for inconsistency with other account information for determining the rate of withholding for each payee (Line 17e).
Certifications for a Nonwithholding Foreign Partnership, Simple Trust, or Grantor Trust. Applicable when entity_type is NONWITHHOLDING_FOREIGN_PARTNERSHIP, NONWITHHOLDING_FOREIGN_SIMPLE_TRUST, or NONWITHHOLDING_FOREIGN_GRANTOR_TRUST.
Certifies the entity is a foreign grantor trust providing the form on behalf of each grantor or other owner, transmitting withholding certificates and providing a withholding statement to allocate the amount realized (Line 21e).
Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).
Certifies the entity is a foreign partnership receiving an amount realized on the transfer of an interest in a partnership for section 1446(f) purposes (Line 21c).
Certifies the entity is providing this form for payments not effectively connected with a US trade or business, and is using this form to transmit withholding certificates and/or documentation with a withholding statement (Line 21a).
Certifies the entity is a foreign partnership or foreign grantor trust that is a partner in a lower-tier partnership providing this form for section 1446(a) purposes (Line 21b).
Certifies the entity represents that the information on the withholding certificates may be relied upon when providing an alternative withholding statement under Regulations section 1.1441-1(e)(3)(iv)(C)(3) (Line 21f).
Certifications for a Qualified Intermediary. Applicable when entity_type is QI.
Certifies the entity assumes primary Form 1099 reporting and backup withholding responsibility, or reporting responsibility as a participating FFI or registered deemed-compliant FFI, for accounts held by specified US persons (Line 15f).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 for each account identified on a withholding statement (or all accounts if no statement attached) (Line 15a).
Certifies the entity assumes primary withholding as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 15c).
Certifies the entity is a QI acting as a qualified securities lender assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 15d).
Certifies the entity assumes primary withholding and reporting responsibility for payments of amounts realized from sales of interests in publicly traded partnerships under section 1446(f) (Line 15b).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 and primary Form 1099 reporting and backup withholding responsibility for US source interest and substitute interest (Line 15e).
Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).
Certifies the entity has obtained or will obtain documentation for intermediaries or flow-through entities in a chapter 4 withholding rate pool of US payees (Line 15i).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a chapter 4 withholding rate pool of US payees (Line 15h).
Certifies each QDD identified meets the requirements to act as a QDD and assumes primary withholding and reporting responsibilities under chapters 3, 4, and 61 and section 3406 (Line 16a).
Certifies the entity is a QI with respect to identified accounts, has provided or will provide a withholding statement, and will provide required payee documentation if acting as a disclosing QI for section 1446(a) or (f) (Line 14).
Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.
Certifies the entity agrees to be treated as a US person and as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 18e).
Certifies the entity is using this form as evidence of agreement to be treated as a US person for chapters 3 and 4 purposes (Line 18b).
Certifies the entity agrees to be treated as a US person under Regulations section 1.1446(f)-4(a)(2)(i)(B) for amounts realized on sales of interests in publicly traded partnerships (Line 18d).
Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).
Certifies the entity is a financial institution (other than an investment entity that is not also a depository, custodial, or specified insurance institution) incorporated or organized under the laws of a US territory (Line 18a).
Certifications for a US Branch. Applicable when entity_type is US_BRANCH.
Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).
Certifies the entity is a US branch acting as a US person for amounts realized on sales of interests in publicly traded partnerships (Line 19d).
Certifies the entity is a US branch of a foreign bank or insurance company using this form as evidence of agreement to be treated as a US person (Line 19b).
Certifies the entity is using this form to transmit withholding certificates and/or documentation, will provide a withholding statement, and applies rules under Regulations section 1.1471-4(d)(2)(iii)(C) for withholdable payments (Line 19c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).
Certifies the entity is a US branch receiving reportable amounts or withholdable payments that are not ECI, distributions from publicly traded partnerships, or amounts realized on sales of interests in publicly traded partnerships (Line 19a).
Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.
Certifies the entity is a withholding foreign partnership or withholding foreign trust that is compliant with the terms of its WP or WT agreement (Line 20).
Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.
Details about what payer information is incomplete.
A detailed message describing the missing information.
Type of information that is missing or incorrect.
TAX_IDENTIFIERThe payer's tax identifier is missing or incorrect
STATEThe payer's state is missing or incorrect
CITYThe payer's city is missing or incorrect
COUNTRY_CODEThe payer's country code is missing or incorrect
BUSINESS_NAMEThe payer's business name is missing or incorrect
PHONE_NUMBERThe payer's phone number is missing or incorrect
Full legal name of the individual who provided the electronic signature.
Status of the tax profile.
SUBMITTEDThe tax profile has been submitted and is pending review
REJECTEDThe tax profile has been rejected. The reason can be found in failure_reason
ACTION_REQUIREDAdditional information or action is required to continue. Details can be found in requirements
SUPERSEDEDThe tax profile version has been replaced by a newer version created through an approved amendment
READYProfile review passed and the profile is ready to be used for filing
Additional files uploaded for different supporting purposes.
The file ID returned when the document was uploaded to the file service.
Purpose of the supporting document. The applicable values depend on the tax form type.
RESIDENCY_PROOFSupporting document if the address is not in the US. Applicable when the form type is W_9
NON_US_TAX_PROOFSupporting document if the mailing address is in the US. Applicable when the form type is W_8_BEN or W_8_BEN_E
INCOME_ITEM_STATEMENTStatement of taxable income items. Applicable when the form type is W_8_ECI
WITHHOLDING_CERTIFICATIONCertification specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
WITHHOLDING_STATEMENTStatement specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
TAX_EXEMPTION_INCOME_STATEMENTStatement identifying amounts includible under section 512 in computing the entity's unrelated business taxable income. Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
US_COUNSEL_CONCLUSIONOpinion from U.S. counsel concluding the entity is described in section 501(c). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
AFFIDAVITAffidavit for the IRS to determine the organization is not a private foundation because it meets one of the exceptions described in section 509(a)(1), (2), (3), or (4). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
FOREIGN_SCHOLAR_ATTACHMENTStatement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true
Additional description of the file.
The type of underlying tax form of the profile.
W_9Form W-9, for a US person.
W_8_BENForm W-8BEN, for a foreign individual.
W_8_BEN_EForm W-8BEN-E, for a foreign entity.
W_8_ECIForm W-8ECI, for income effectively connected with a US trade or business.
W_8_EXPForm W-8EXP, for a foreign government or other exempt organization.
W_8_IMYForm W-8IMY, for a foreign intermediary or flow-through entity.
8233Form 8233, for exemption from withholding on compensation of a nonresident alien individual.
Time when the tax profile was last updated, in ISO 8601 format.
The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 404 | Possible errors: |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/beneficiary_tax_profiles/txf-9a1b2c3d4e5f/versions/1' \> --header 'Authorization: Bearer <token>' \> --header 'Content-Type: application/json'
1{2 "id": "txf-9a1b2c3d4e5f",3 "version": 1,4 "status": "SUPERSEDED",5 "type": "W_9",6 "external_id": "recipient-7f3a9c12",7 "signature_name": "Jane A. Smith",8 "supporting_documents": [9 {10 "tag": "RESIDENCY_PROOF",11 "file_id": "file-4b2e1d09c3",12 "description": "Utility bill confirming non-US address."13 }14 ],15 "profile_details": {16 "name": "Jane A. Smith",17 "business_name": "Smith Consulting LLC",18 "tax_classification": {19 "type": "LLC",20 "llc_type": "S"21 },22 "tax_identifier": {23 "type": "EIN",24 "number": "12-3456789"25 },26 "address": {27 "country_code": "US",28 "country_name": "United States",29 "address_line1": "456 Oak Avenue",30 "address_line2": "Suite 100",31 "postcode": "94105",32 "state": "California",33 "state_code": "CA",34 "suburb": "San Francisco"35 },36 "electronic_delivery_consent": true37 },38 "created_at": "2026-06-10T08:30:00+0000",39 "updated_at": "2026-06-10T09:15:00+0000"40}
List All Versions of a Beneficiary Tax Profile
GET /api/v1/beneficiary_tax_profiles/{id}/versions
Retrieve all versions of a beneficiary tax profile, filtered by the supplied query parameters. Results are paginated using a cursor.
x-on-behalf-of headerUnique ID of the tax profile.
The start date of created_at in ISO 8601 format (inclusive).
A bookmark for use in pagination to retrieve either the next page or the previous page of results.
To retrieve the next page of results, pass the value of page_after (if not null) from the response to a subsequent call.
To retrieve the previous page of results, pass the value of page_before (if not null) from the response to a subsequent call.
Number of results per page. Defaults to 100, minimum 10, maximum 200.
The end date of created_at in ISO 8601 format (inclusive).
Filter by form type.
W_9Form W-9, for a US person.
W_8_BENForm W-8BEN, for a foreign individual.
W_8_BEN_EForm W-8BEN-E, for a foreign entity.
W_8_ECIForm W-8ECI, for income effectively connected with a US trade or business.
W_8_EXPForm W-8EXP, for a foreign government or other exempt organization.
W_8_IMYForm W-8IMY, for a foreign intermediary or flow-through entity.
8233Form 8233, for exemption from withholding on compensation of a nonresident alien individual.
An array of paged results.
Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.
Unique ID of the tax profile.
Status of the tax profile.
SUBMITTEDThe tax profile has been submitted and is pending review
REJECTEDThe tax profile has been rejected. The reason can be found in failure_reason
ACTION_REQUIREDAdditional information or action is required to continue. Details can be found in requirements
SUPERSEDEDThe tax profile version has been replaced by a newer version created through an approved amendment
READYProfile review passed and the profile is ready to be used for filing
The type of underlying tax form of the profile.
W_9Form W-9, for a US person.
W_8_BENForm W-8BEN, for a foreign individual.
W_8_BEN_EForm W-8BEN-E, for a foreign entity.
W_8_ECIForm W-8ECI, for income effectively connected with a US trade or business.
W_8_EXPForm W-8EXP, for a foreign government or other exempt organization.
W_8_IMYForm W-8IMY, for a foreign intermediary or flow-through entity.
8233Form 8233, for exemption from withholding on compensation of a nonresident alien individual.
The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.
Time when the tax profile was created, in ISO 8601 format.
Additional message if verification failed.
Recipient details used to file taxes.
Address of recipient.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Name of the individual or organization that is the beneficial owner / intermediary.
Taxpayer Identification Number.
The Tax Identification number.
Type of Tax Identification.
SSNSocial Security Number.
EINEmployer Identification Number.
ITINIndividual Taxpayer Identification Number.
QI_EINQualified Intermediary Employer Identification Number.
WP_EINWithholding Foreign Partnership Employer Identification Number.
WT_EINWithholding Foreign Trust Employer Identification Number.
Business address in the US. Applicable when type is W_8_ECI.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Business name, trade name, DBA name, or disregarded entity name that is different from the name on the tax return. Applicable when type is W_9.
Country of citizenship, incorporation, or organization (2-letter ISO 3166-1 alpha-2 country code). Applicable when type is W_8_BEN, W_8_BEN_E, W_8_ECI, W_8_EXP, W_8_IMY, or 8233.
Current nonimmigrant status in the US. Applicable when type is 8233.
Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.
Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.
Name of the disregarded entity receiving the payment, if applicable. Applicable when type is W_8_BEN_E, W_8_ECI, or W_8_IMY.
Whether the recipient consents to electronic delivery of Form 1099. Applicable when type is W_9.
Chapter 3 status of the entity (Forms W-8BEN-E, W-8ECI, W-8EXP), or the role in which the entity is acting as an intermediary or flow-through entity (Form W-8IMY). Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
PARTNERSHIPPartnership. Applicable to Form W-8BEN-E or W-8ECI
CORPORATIONCorporation. Applicable to Form W-8BEN-E or W-8ECI
SIMPLE_TRUSTSimple trust. Applicable to Form W-8BEN-E or W-8ECI
TAX_EXEMPT_ORGANIZATIONTax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI
COMPLEX_TRUSTComplex trust. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_CONTROLLED_ENTITYEntity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI
CENTRAL_BANK_OF_ISSUECentral bank of issue. Applicable to Form W-8BEN-E or W-8ECI
PRIVATE_FOUNDATIONPrivate foundation. Applicable to Form W-8BEN-E or W-8ECI
ESTATEEstate. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_INTEGRAL_PARTIntegral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI
GRANTOR_TRUSTGrantor trust. Applicable to Form W-8BEN-E or W-8ECI
DISREGARDED_ENTITYDisregarded entity. Applicable to Form W-8BEN-E or W-8ECI
INTERNATIONAL_ORGANIZATIONInternational organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP
FOREIGN_GOVERNMENTForeign government. Applicable to Form W-8EXP
FOREIGN_CENTRAL_BANK_OF_ISSUEForeign central bank of issue. Applicable to Form W-8EXP
FOREIGN_TAX_EXEMPT_ORGANIZATIONForeign tax-exempt organization under section 501(c). Applicable to Form W-8EXP
FOREIGN_PRIVATE_FOUNDATIONForeign private foundation. Applicable to Form W-8EXP
GOVERNMENT_OF_A_US_TERRITORYGovernment of a US territory or political subdivision. Applicable to Form W-8EXP
QIQualified Intermediary. Applicable to Form W-8IMY
NONQUALIFIED_INTERMEDIARYNonqualified intermediary. Applicable to Form W-8IMY
TERRITORY_FINANCIAL_INSTITUTIONTerritory financial institution. Applicable to Form W-8IMY
US_BRANCHUS branch. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_PARTNERSHIPWithholding foreign partnership. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_TRUSTWithholding foreign trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_PARTNERSHIPNonwithholding foreign partnership. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_SIMPLE_TRUSTNonwithholding foreign simple trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_GRANTOR_TRUSTNonwithholding foreign grantor trust. Applicable to Form W-8IMY
Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.
Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.
Sufficient facts to justify the exemption from withholding claimed, to allow the IRS to determine the tax treaty benefits being claimed. Applicable when type is 8233.
Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.
Foreign Tax Identifying Number. Empty if not legally required. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, W_8_IMY, or 8233.
Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.
Description of the personal services being provided. Applicable when type is 8233.
Mailing address, if different from address or if the form is not delivered electronically. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, or W_8_IMY.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Passport number. Applicable when type is 8233.
Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
Treaty article on which the exemption is based (e.g. "Article 14, paragraph 2"). Applicable when type is 8233 and exempt_from_withholding is true.
Federal tax classification. Applicable when type is W_9.
Tax classification.
INDIVIDUAL_OR_SOLE_PROPRIETORIndividual/sole proprietor or single-member LLC.
C_CORPORATIONC corporation.
S_CORPORATIONS corporation.
PARTNERSHIPPartnership.
TRUST_OR_ESTATETrust or estate.
LLCLimited liability company. Requires llc_type.
OTHEROther entity. Specify the tax classification on the applicable form.
true if the entity has any foreign partners, owners, or beneficiaries. Applicable when type is TRUST_OR_ESTATE or PARTNERSHIP, or when llc_type is P.
Tax classification of the LLC. Applicable when type is LLC.
CC corporation
SS corporation
PPartnership
Name of the tax treaty on which the exemption is based (e.g. "US-Germany tax treaty"). Applicable when type is 8233 and exempt_from_withholding is true.
Items of income to be received from payers that are effectively connected with the conduct of a trade or business in the US. Applicable when type is W_8_ECI.
Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.
Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.
Address in the United States. Applicable when type is 8233.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.
Chapter 3 status specific certifications. Applicable when type is W_8_EXP.
Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies: (1) the entity is a foreign central bank of issue, (2) it does not hold obligations for commercial banking activity, and (3) payments are within the §895 exemption scope. (line 12) Applicable when entity_type is FOREIGN_CENTRAL_BANK_OF_ISSUE.
Certifies that the entity is a foreign government within the meaning of §892 and payments are within the scope of the exemption granted by §892. (line 10a) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity has an IRS determination letter currently in effect concluding it is exempt under §501(c). (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies an opinion from U.S. counsel is attached concluding the entity is described in §501(c). (line 13b) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an international organization within §7701(a)(18) and payments are within the §892 exemption scope. (line 11) Applicable when entity_type is INTERNATIONAL_ORGANIZATION.
Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
A controlled entity of a foreign sovereign (other than a foreign central bank wholly owned) certifies the beneficial owner is not engaged in commercial activities within or outside the US. (line 10d) Applicable when entity_type is FOREIGN_GOVERNMENT.
For a foreign central bank of issue controlled by a foreign sovereign, certifies the beneficial owner is not engaged in commercial activities within the US. (line 10e) Applicable when entity_type is FOREIGN_GOVERNMENT.
For §501(c)(3) organizations only. Certifies the organization is not a private foundation under §509. Requires an affidavit attachment. (line 13c) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
For §501(c)(3) organizations only. Certifies the organization is a private foundation under §509. (line 13d) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies the entity is a US territory government or political subdivision claiming a §115(2) exemption. (line 14) Applicable when entity_type is GOVERNMENT_OF_A_US_TERRITORY.
Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.
Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.
Certifies the entity is acting as a qualified securities lender (other than a QI) assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 17d).
Certifies the entity is using this form to transmit withholding certificates and/or other documentation and has provided or will provide a withholding statement (Line 17b).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a withholding rate pool of US payees (Line 17c).
Certifies the entity is not acting as a QI with respect to accounts for which this form is provided and is not acting for its own account (Line 17a).
Certifies that, where an alternative withholding statement described in Regulations section 1.1441-1(e)(3)(iv)(C)(3) is provided, the information on all associated withholding statements has been (or will be) verified for inconsistency with other account information for determining the rate of withholding for each payee (Line 17e).
Certifications for a Nonwithholding Foreign Partnership, Simple Trust, or Grantor Trust. Applicable when entity_type is NONWITHHOLDING_FOREIGN_PARTNERSHIP, NONWITHHOLDING_FOREIGN_SIMPLE_TRUST, or NONWITHHOLDING_FOREIGN_GRANTOR_TRUST.
Certifies the entity is a foreign grantor trust providing the form on behalf of each grantor or other owner, transmitting withholding certificates and providing a withholding statement to allocate the amount realized (Line 21e).
Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).
Certifies the entity is a foreign partnership receiving an amount realized on the transfer of an interest in a partnership for section 1446(f) purposes (Line 21c).
Certifies the entity is providing this form for payments not effectively connected with a US trade or business, and is using this form to transmit withholding certificates and/or documentation with a withholding statement (Line 21a).
Certifies the entity is a foreign partnership or foreign grantor trust that is a partner in a lower-tier partnership providing this form for section 1446(a) purposes (Line 21b).
Certifies the entity represents that the information on the withholding certificates may be relied upon when providing an alternative withholding statement under Regulations section 1.1441-1(e)(3)(iv)(C)(3) (Line 21f).
Certifications for a Qualified Intermediary. Applicable when entity_type is QI.
Certifies the entity assumes primary Form 1099 reporting and backup withholding responsibility, or reporting responsibility as a participating FFI or registered deemed-compliant FFI, for accounts held by specified US persons (Line 15f).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 for each account identified on a withholding statement (or all accounts if no statement attached) (Line 15a).
Certifies the entity assumes primary withholding as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 15c).
Certifies the entity is a QI acting as a qualified securities lender assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 15d).
Certifies the entity assumes primary withholding and reporting responsibility for payments of amounts realized from sales of interests in publicly traded partnerships under section 1446(f) (Line 15b).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 and primary Form 1099 reporting and backup withholding responsibility for US source interest and substitute interest (Line 15e).
Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).
Certifies the entity has obtained or will obtain documentation for intermediaries or flow-through entities in a chapter 4 withholding rate pool of US payees (Line 15i).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a chapter 4 withholding rate pool of US payees (Line 15h).
Certifies each QDD identified meets the requirements to act as a QDD and assumes primary withholding and reporting responsibilities under chapters 3, 4, and 61 and section 3406 (Line 16a).
Certifies the entity is a QI with respect to identified accounts, has provided or will provide a withholding statement, and will provide required payee documentation if acting as a disclosing QI for section 1446(a) or (f) (Line 14).
Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.
Certifies the entity agrees to be treated as a US person and as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 18e).
Certifies the entity is using this form as evidence of agreement to be treated as a US person for chapters 3 and 4 purposes (Line 18b).
Certifies the entity agrees to be treated as a US person under Regulations section 1.1446(f)-4(a)(2)(i)(B) for amounts realized on sales of interests in publicly traded partnerships (Line 18d).
Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).
Certifies the entity is a financial institution (other than an investment entity that is not also a depository, custodial, or specified insurance institution) incorporated or organized under the laws of a US territory (Line 18a).
Certifications for a US Branch. Applicable when entity_type is US_BRANCH.
Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).
Certifies the entity is a US branch acting as a US person for amounts realized on sales of interests in publicly traded partnerships (Line 19d).
Certifies the entity is a US branch of a foreign bank or insurance company using this form as evidence of agreement to be treated as a US person (Line 19b).
Certifies the entity is using this form to transmit withholding certificates and/or documentation, will provide a withholding statement, and applies rules under Regulations section 1.1471-4(d)(2)(iii)(C) for withholdable payments (Line 19c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).
Certifies the entity is a US branch receiving reportable amounts or withholdable payments that are not ECI, distributions from publicly traded partnerships, or amounts realized on sales of interests in publicly traded partnerships (Line 19a).
Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.
Certifies the entity is a withholding foreign partnership or withholding foreign trust that is compliant with the terms of its WP or WT agreement (Line 20).
Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.
Details about what payer information is incomplete.
A detailed message describing the missing information.
Type of information that is missing or incorrect.
TAX_IDENTIFIERThe payer's tax identifier is missing or incorrect
STATEThe payer's state is missing or incorrect
CITYThe payer's city is missing or incorrect
COUNTRY_CODEThe payer's country code is missing or incorrect
BUSINESS_NAMEThe payer's business name is missing or incorrect
PHONE_NUMBERThe payer's phone number is missing or incorrect
Full legal name of the individual who provided the electronic signature.
Additional files uploaded for different supporting purposes.
The file ID returned when the document was uploaded to the file service.
Purpose of the supporting document. The applicable values depend on the tax form type.
RESIDENCY_PROOFSupporting document if the address is not in the US. Applicable when the form type is W_9
NON_US_TAX_PROOFSupporting document if the mailing address is in the US. Applicable when the form type is W_8_BEN or W_8_BEN_E
INCOME_ITEM_STATEMENTStatement of taxable income items. Applicable when the form type is W_8_ECI
WITHHOLDING_CERTIFICATIONCertification specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
WITHHOLDING_STATEMENTStatement specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
TAX_EXEMPTION_INCOME_STATEMENTStatement identifying amounts includible under section 512 in computing the entity's unrelated business taxable income. Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
US_COUNSEL_CONCLUSIONOpinion from U.S. counsel concluding the entity is described in section 501(c). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
AFFIDAVITAffidavit for the IRS to determine the organization is not a private foundation because it meets one of the exceptions described in section 509(a)(1), (2), (3), or (4). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
FOREIGN_SCHOLAR_ATTACHMENTStatement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true
Additional description of the file.
Time when the tax profile was last updated, in ISO 8601 format.
The cursor for the next page of results. Pass this value as page in a subsequent request. null if there are no more results.
The cursor for the previous page of results. Pass this value as page in a subsequent request. null if there are no previous results.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 404 | Possible errors: |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/beneficiary_tax_profiles/txf-9a1b2c3d4e5f/versions' \> --header 'Authorization: Bearer <token>' \> --header 'Content-Type: application/json'
1{2 "items": [3 {4 "id": "txf-9a1b2c3d4e5f",5 "version": 1,6 "status": "SUPERSEDED",7 "type": "W_9",8 "external_id": "recipient-7f3a9c12",9 "signature_name": "Jane A. Smith",10 "profile_details": {11 "name": "Jane A. Smith",12 "business_name": "Smith Consulting LLC",13 "tax_classification": {14 "type": "LLC",15 "llc_type": "S"16 },17 "tax_identifier": {18 "type": "EIN",19 "number": "12-3456789"20 },21 "address": {22 "country_code": "US",23 "country_name": "United States",24 "address_line1": "456 Oak Avenue",25 "address_line2": "Suite 100",26 "postcode": "94105",27 "state": "California",28 "state_code": "CA",29 "suburb": "San Francisco"30 },31 "electronic_delivery_consent": true32 },33 "created_at": "2026-06-10T08:30:00+0000",34 "updated_at": "2026-06-10T09:15:00+0000"35 },36 {37 "id": "txf-9a1b2c3d4e5f",38 "version": 2,39 "status": "READY",40 "type": "W_9",41 "external_id": "recipient-7f3a9c12",42 "signature_name": "Jane A. Smith",43 "profile_details": {44 "name": "Jane A. Smith",45 "business_name": "Smith Consulting LLC",46 "tax_classification": {47 "type": "LLC",48 "llc_type": "S"49 },50 "tax_identifier": {51 "type": "EIN",52 "number": "12-3456789"53 },54 "address": {55 "country_code": "US",56 "country_name": "United States",57 "address_line1": "789 Pine Street",58 "address_line2": "Suite 210",59 "postcode": "94107",60 "state": "California",61 "state_code": "CA",62 "suburb": "San Francisco"63 },64 "electronic_delivery_consent": true65 },66 "created_at": "2026-07-02T10:05:00+0000",67 "updated_at": "2026-07-02T10:05:00+0000"68 }69 ],70 "page_before": "<string>",71 "page_after": "<string>"72}
Download a Historical Version of a Beneficiary Tax Profile
POST /api/v1/beneficiary_tax_profiles/{id}/versions/{version}/download
Generate a PDF of a specific historical version of a beneficiary tax profile (rendered from the underlying W-9 or W-8 form).
x-on-behalf-of headerUnique ID of the tax profile.
Exact tax profile version to download.
URL that can be used to retrieve the file. This URL expires shortly after it is generated.
Download URL expiry timestamp, in ISO 8601 format.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 404 | Possible errors: |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/beneficiary_tax_profiles/txf-1a2b3c4d5e6f/versions/1/download' \> --header 'Authorization: Bearer <token>'
1{2 "download_url": "https://api-downloads.airwallex.com/beneficiary_tax_profiles/txf-1a2b3c4d5e6f/v1.pdf?signature=1a2b3c4d5e6f7a8b9c0d",3 "expires_at": "2026-06-10T08:35:00+0000"4}
Create a Beneficiary Tax Profile Amendment
POST /api/v1/beneficiary_tax_profiles/{id}/amendments/create
Create an amendment to an existing beneficiary tax profile. The amendment creates a new version of the profile.
Amendments can only be created when the beneficiary tax profile status is READY or REJECTED.
The current active beneficiary tax profile version remains in effect until the amendment is approved and atomically applied on the beneficiary tax statement.
x-on-behalf-of headerUnique ID of the beneficiary tax profile to amend.
Recipient details used to file taxes.
Address of recipient.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Name of the individual or organization that is the beneficial owner / intermediary.
Taxpayer Identification Number.
The Tax Identification number.
Type of Tax Identification.
SSNSocial Security Number.
EINEmployer Identification Number.
ITINIndividual Taxpayer Identification Number.
QI_EINQualified Intermediary Employer Identification Number.
WP_EINWithholding Foreign Partnership Employer Identification Number.
WT_EINWithholding Foreign Trust Employer Identification Number.
Business address in the US. Applicable when type is W_8_ECI.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Business name, trade name, DBA name, or disregarded entity name that is different from the name on the tax return. Applicable when type is W_9.
Country of citizenship, incorporation, or organization (2-letter ISO 3166-1 alpha-2 country code). Applicable when type is W_8_BEN, W_8_BEN_E, W_8_ECI, W_8_EXP, W_8_IMY, or 8233.
Current nonimmigrant status in the US. Applicable when type is 8233.
Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.
Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.
Name of the disregarded entity receiving the payment, if applicable. Applicable when type is W_8_BEN_E, W_8_ECI, or W_8_IMY.
Whether the recipient consents to electronic delivery of Form 1099. Applicable when type is W_9.
Chapter 3 status of the entity (Forms W-8BEN-E, W-8ECI, W-8EXP), or the role in which the entity is acting as an intermediary or flow-through entity (Form W-8IMY). Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
PARTNERSHIPPartnership. Applicable to Form W-8BEN-E or W-8ECI
CORPORATIONCorporation. Applicable to Form W-8BEN-E or W-8ECI
SIMPLE_TRUSTSimple trust. Applicable to Form W-8BEN-E or W-8ECI
TAX_EXEMPT_ORGANIZATIONTax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI
COMPLEX_TRUSTComplex trust. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_CONTROLLED_ENTITYEntity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI
CENTRAL_BANK_OF_ISSUECentral bank of issue. Applicable to Form W-8BEN-E or W-8ECI
PRIVATE_FOUNDATIONPrivate foundation. Applicable to Form W-8BEN-E or W-8ECI
ESTATEEstate. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_INTEGRAL_PARTIntegral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI
GRANTOR_TRUSTGrantor trust. Applicable to Form W-8BEN-E or W-8ECI
DISREGARDED_ENTITYDisregarded entity. Applicable to Form W-8BEN-E or W-8ECI
INTERNATIONAL_ORGANIZATIONInternational organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP
FOREIGN_GOVERNMENTForeign government. Applicable to Form W-8EXP
FOREIGN_CENTRAL_BANK_OF_ISSUEForeign central bank of issue. Applicable to Form W-8EXP
FOREIGN_TAX_EXEMPT_ORGANIZATIONForeign tax-exempt organization under section 501(c). Applicable to Form W-8EXP
FOREIGN_PRIVATE_FOUNDATIONForeign private foundation. Applicable to Form W-8EXP
GOVERNMENT_OF_A_US_TERRITORYGovernment of a US territory or political subdivision. Applicable to Form W-8EXP
QIQualified Intermediary. Applicable to Form W-8IMY
NONQUALIFIED_INTERMEDIARYNonqualified intermediary. Applicable to Form W-8IMY
TERRITORY_FINANCIAL_INSTITUTIONTerritory financial institution. Applicable to Form W-8IMY
US_BRANCHUS branch. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_PARTNERSHIPWithholding foreign partnership. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_TRUSTWithholding foreign trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_PARTNERSHIPNonwithholding foreign partnership. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_SIMPLE_TRUSTNonwithholding foreign simple trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_GRANTOR_TRUSTNonwithholding foreign grantor trust. Applicable to Form W-8IMY
Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.
Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.
Sufficient facts to justify the exemption from withholding claimed, to allow the IRS to determine the tax treaty benefits being claimed. Applicable when type is 8233.
Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.
Foreign Tax Identifying Number. Empty if not legally required. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, W_8_IMY, or 8233.
Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.
Description of the personal services being provided. Applicable when type is 8233.
Mailing address, if different from address or if the form is not delivered electronically. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, or W_8_IMY.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Passport number. Applicable when type is 8233.
Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
Treaty article on which the exemption is based (e.g. "Article 14, paragraph 2"). Applicable when type is 8233 and exempt_from_withholding is true.
Federal tax classification. Applicable when type is W_9.
Tax classification.
INDIVIDUAL_OR_SOLE_PROPRIETORIndividual/sole proprietor or single-member LLC.
C_CORPORATIONC corporation.
S_CORPORATIONS corporation.
PARTNERSHIPPartnership.
TRUST_OR_ESTATETrust or estate.
LLCLimited liability company. Requires llc_type.
OTHEROther entity. Specify the tax classification on the applicable form.
true if the entity has any foreign partners, owners, or beneficiaries. Applicable when type is TRUST_OR_ESTATE or PARTNERSHIP, or when llc_type is P.
Tax classification of the LLC. Applicable when type is LLC.
CC corporation
SS corporation
PPartnership
Name of the tax treaty on which the exemption is based (e.g. "US-Germany tax treaty"). Applicable when type is 8233 and exempt_from_withholding is true.
Items of income to be received from payers that are effectively connected with the conduct of a trade or business in the US. Applicable when type is W_8_ECI.
Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.
Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.
Address in the United States. Applicable when type is 8233.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.
Chapter 3 status specific certifications. Applicable when type is W_8_EXP.
Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies: (1) the entity is a foreign central bank of issue, (2) it does not hold obligations for commercial banking activity, and (3) payments are within the §895 exemption scope. (line 12) Applicable when entity_type is FOREIGN_CENTRAL_BANK_OF_ISSUE.
Certifies that the entity is a foreign government within the meaning of §892 and payments are within the scope of the exemption granted by §892. (line 10a) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity has an IRS determination letter currently in effect concluding it is exempt under §501(c). (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies an opinion from U.S. counsel is attached concluding the entity is described in §501(c). (line 13b) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an international organization within §7701(a)(18) and payments are within the §892 exemption scope. (line 11) Applicable when entity_type is INTERNATIONAL_ORGANIZATION.
Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
A controlled entity of a foreign sovereign (other than a foreign central bank wholly owned) certifies the beneficial owner is not engaged in commercial activities within or outside the US. (line 10d) Applicable when entity_type is FOREIGN_GOVERNMENT.
For a foreign central bank of issue controlled by a foreign sovereign, certifies the beneficial owner is not engaged in commercial activities within the US. (line 10e) Applicable when entity_type is FOREIGN_GOVERNMENT.
For §501(c)(3) organizations only. Certifies the organization is not a private foundation under §509. Requires an affidavit attachment. (line 13c) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
For §501(c)(3) organizations only. Certifies the organization is a private foundation under §509. (line 13d) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies the entity is a US territory government or political subdivision claiming a §115(2) exemption. (line 14) Applicable when entity_type is GOVERNMENT_OF_A_US_TERRITORY.
Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.
Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.
Certifies the entity is acting as a qualified securities lender (other than a QI) assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 17d).
Certifies the entity is using this form to transmit withholding certificates and/or other documentation and has provided or will provide a withholding statement (Line 17b).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a withholding rate pool of US payees (Line 17c).
Certifies the entity is not acting as a QI with respect to accounts for which this form is provided and is not acting for its own account (Line 17a).
Certifies that, where an alternative withholding statement described in Regulations section 1.1441-1(e)(3)(iv)(C)(3) is provided, the information on all associated withholding statements has been (or will be) verified for inconsistency with other account information for determining the rate of withholding for each payee (Line 17e).
Certifications for a Nonwithholding Foreign Partnership, Simple Trust, or Grantor Trust. Applicable when entity_type is NONWITHHOLDING_FOREIGN_PARTNERSHIP, NONWITHHOLDING_FOREIGN_SIMPLE_TRUST, or NONWITHHOLDING_FOREIGN_GRANTOR_TRUST.
Certifies the entity is a foreign grantor trust providing the form on behalf of each grantor or other owner, transmitting withholding certificates and providing a withholding statement to allocate the amount realized (Line 21e).
Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).
Certifies the entity is a foreign partnership receiving an amount realized on the transfer of an interest in a partnership for section 1446(f) purposes (Line 21c).
Certifies the entity is providing this form for payments not effectively connected with a US trade or business, and is using this form to transmit withholding certificates and/or documentation with a withholding statement (Line 21a).
Certifies the entity is a foreign partnership or foreign grantor trust that is a partner in a lower-tier partnership providing this form for section 1446(a) purposes (Line 21b).
Certifies the entity represents that the information on the withholding certificates may be relied upon when providing an alternative withholding statement under Regulations section 1.1441-1(e)(3)(iv)(C)(3) (Line 21f).
Certifications for a Qualified Intermediary. Applicable when entity_type is QI.
Certifies the entity assumes primary Form 1099 reporting and backup withholding responsibility, or reporting responsibility as a participating FFI or registered deemed-compliant FFI, for accounts held by specified US persons (Line 15f).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 for each account identified on a withholding statement (or all accounts if no statement attached) (Line 15a).
Certifies the entity assumes primary withholding as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 15c).
Certifies the entity is a QI acting as a qualified securities lender assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 15d).
Certifies the entity assumes primary withholding and reporting responsibility for payments of amounts realized from sales of interests in publicly traded partnerships under section 1446(f) (Line 15b).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 and primary Form 1099 reporting and backup withholding responsibility for US source interest and substitute interest (Line 15e).
Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).
Certifies the entity has obtained or will obtain documentation for intermediaries or flow-through entities in a chapter 4 withholding rate pool of US payees (Line 15i).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a chapter 4 withholding rate pool of US payees (Line 15h).
Certifies each QDD identified meets the requirements to act as a QDD and assumes primary withholding and reporting responsibilities under chapters 3, 4, and 61 and section 3406 (Line 16a).
Certifies the entity is a QI with respect to identified accounts, has provided or will provide a withholding statement, and will provide required payee documentation if acting as a disclosing QI for section 1446(a) or (f) (Line 14).
Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.
Certifies the entity agrees to be treated as a US person and as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 18e).
Certifies the entity is using this form as evidence of agreement to be treated as a US person for chapters 3 and 4 purposes (Line 18b).
Certifies the entity agrees to be treated as a US person under Regulations section 1.1446(f)-4(a)(2)(i)(B) for amounts realized on sales of interests in publicly traded partnerships (Line 18d).
Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).
Certifies the entity is a financial institution (other than an investment entity that is not also a depository, custodial, or specified insurance institution) incorporated or organized under the laws of a US territory (Line 18a).
Certifications for a US Branch. Applicable when entity_type is US_BRANCH.
Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).
Certifies the entity is a US branch acting as a US person for amounts realized on sales of interests in publicly traded partnerships (Line 19d).
Certifies the entity is a US branch of a foreign bank or insurance company using this form as evidence of agreement to be treated as a US person (Line 19b).
Certifies the entity is using this form to transmit withholding certificates and/or documentation, will provide a withholding statement, and applies rules under Regulations section 1.1471-4(d)(2)(iii)(C) for withholdable payments (Line 19c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).
Certifies the entity is a US branch receiving reportable amounts or withholdable payments that are not ECI, distributions from publicly traded partnerships, or amounts realized on sales of interests in publicly traded partnerships (Line 19a).
Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.
Certifies the entity is a withholding foreign partnership or withholding foreign trust that is compliant with the terms of its WP or WT agreement (Line 20).
Full legal name of the individual providing the electronic signature.
The type of underlying tax form of the profile.
W_9Form W-9, for a US person.
W_8_BENForm W-8BEN, for a foreign individual.
W_8_BEN_EForm W-8BEN-E, for a foreign entity.
W_8_ECIForm W-8ECI, for income effectively connected with a US trade or business.
W_8_EXPForm W-8EXP, for a foreign government or other exempt organization.
W_8_IMYForm W-8IMY, for a foreign intermediary or flow-through entity.
8233Form 8233, for exemption from withholding on compensation of a nonresident alien individual.
Additional files for different supporting purposes.
The file ID returned when the document was uploaded to the file service.
Purpose of the supporting document. The applicable values depend on the tax form type.
RESIDENCY_PROOFSupporting document if the address is not in the US. Applicable when the form type is W_9
NON_US_TAX_PROOFSupporting document if the mailing address is in the US. Applicable when the form type is W_8_BEN or W_8_BEN_E
INCOME_ITEM_STATEMENTStatement of taxable income items. Applicable when the form type is W_8_ECI
WITHHOLDING_CERTIFICATIONCertification specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
WITHHOLDING_STATEMENTStatement specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
TAX_EXEMPTION_INCOME_STATEMENTStatement identifying amounts includible under section 512 in computing the entity's unrelated business taxable income. Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
US_COUNSEL_CONCLUSIONOpinion from U.S. counsel concluding the entity is described in section 501(c). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
AFFIDAVITAffidavit for the IRS to determine the organization is not a private foundation because it meets one of the exceptions described in section 509(a)(1), (2), (3), or (4). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
FOREIGN_SCHOLAR_ATTACHMENTStatement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true
Additional description of the file.
The new tax profile version created by this amendment.
Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.
Unique ID of the tax profile.
Status of the tax profile.
SUBMITTEDThe tax profile has been submitted and is pending review
REJECTEDThe tax profile has been rejected. The reason can be found in failure_reason
ACTION_REQUIREDAdditional information or action is required to continue. Details can be found in requirements
SUPERSEDEDThe tax profile version has been replaced by a newer version created through an approved amendment
READYProfile review passed and the profile is ready to be used for filing
The type of underlying tax form of the profile.
W_9Form W-9, for a US person.
W_8_BENForm W-8BEN, for a foreign individual.
W_8_BEN_EForm W-8BEN-E, for a foreign entity.
W_8_ECIForm W-8ECI, for income effectively connected with a US trade or business.
W_8_EXPForm W-8EXP, for a foreign government or other exempt organization.
W_8_IMYForm W-8IMY, for a foreign intermediary or flow-through entity.
8233Form 8233, for exemption from withholding on compensation of a nonresident alien individual.
The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.
Time when the tax profile was created, in ISO 8601 format.
Additional message if verification failed.
Recipient details used to file taxes.
Address of recipient.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Name of the individual or organization that is the beneficial owner / intermediary.
Taxpayer Identification Number.
The Tax Identification number.
Type of Tax Identification.
SSNSocial Security Number.
EINEmployer Identification Number.
ITINIndividual Taxpayer Identification Number.
QI_EINQualified Intermediary Employer Identification Number.
WP_EINWithholding Foreign Partnership Employer Identification Number.
WT_EINWithholding Foreign Trust Employer Identification Number.
Business address in the US. Applicable when type is W_8_ECI.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Business name, trade name, DBA name, or disregarded entity name that is different from the name on the tax return. Applicable when type is W_9.
Country of citizenship, incorporation, or organization (2-letter ISO 3166-1 alpha-2 country code). Applicable when type is W_8_BEN, W_8_BEN_E, W_8_ECI, W_8_EXP, W_8_IMY, or 8233.
Current nonimmigrant status in the US. Applicable when type is 8233.
Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.
Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.
Name of the disregarded entity receiving the payment, if applicable. Applicable when type is W_8_BEN_E, W_8_ECI, or W_8_IMY.
Whether the recipient consents to electronic delivery of Form 1099. Applicable when type is W_9.
Chapter 3 status of the entity (Forms W-8BEN-E, W-8ECI, W-8EXP), or the role in which the entity is acting as an intermediary or flow-through entity (Form W-8IMY). Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
PARTNERSHIPPartnership. Applicable to Form W-8BEN-E or W-8ECI
CORPORATIONCorporation. Applicable to Form W-8BEN-E or W-8ECI
SIMPLE_TRUSTSimple trust. Applicable to Form W-8BEN-E or W-8ECI
TAX_EXEMPT_ORGANIZATIONTax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI
COMPLEX_TRUSTComplex trust. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_CONTROLLED_ENTITYEntity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI
CENTRAL_BANK_OF_ISSUECentral bank of issue. Applicable to Form W-8BEN-E or W-8ECI
PRIVATE_FOUNDATIONPrivate foundation. Applicable to Form W-8BEN-E or W-8ECI
ESTATEEstate. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_INTEGRAL_PARTIntegral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI
GRANTOR_TRUSTGrantor trust. Applicable to Form W-8BEN-E or W-8ECI
DISREGARDED_ENTITYDisregarded entity. Applicable to Form W-8BEN-E or W-8ECI
INTERNATIONAL_ORGANIZATIONInternational organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP
FOREIGN_GOVERNMENTForeign government. Applicable to Form W-8EXP
FOREIGN_CENTRAL_BANK_OF_ISSUEForeign central bank of issue. Applicable to Form W-8EXP
FOREIGN_TAX_EXEMPT_ORGANIZATIONForeign tax-exempt organization under section 501(c). Applicable to Form W-8EXP
FOREIGN_PRIVATE_FOUNDATIONForeign private foundation. Applicable to Form W-8EXP
GOVERNMENT_OF_A_US_TERRITORYGovernment of a US territory or political subdivision. Applicable to Form W-8EXP
QIQualified Intermediary. Applicable to Form W-8IMY
NONQUALIFIED_INTERMEDIARYNonqualified intermediary. Applicable to Form W-8IMY
TERRITORY_FINANCIAL_INSTITUTIONTerritory financial institution. Applicable to Form W-8IMY
US_BRANCHUS branch. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_PARTNERSHIPWithholding foreign partnership. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_TRUSTWithholding foreign trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_PARTNERSHIPNonwithholding foreign partnership. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_SIMPLE_TRUSTNonwithholding foreign simple trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_GRANTOR_TRUSTNonwithholding foreign grantor trust. Applicable to Form W-8IMY
Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.
Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.
Sufficient facts to justify the exemption from withholding claimed, to allow the IRS to determine the tax treaty benefits being claimed. Applicable when type is 8233.
Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.
Foreign Tax Identifying Number. Empty if not legally required. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, W_8_IMY, or 8233.
Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.
Description of the personal services being provided. Applicable when type is 8233.
Mailing address, if different from address or if the form is not delivered electronically. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, or W_8_IMY.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Passport number. Applicable when type is 8233.
Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
Treaty article on which the exemption is based (e.g. "Article 14, paragraph 2"). Applicable when type is 8233 and exempt_from_withholding is true.
Federal tax classification. Applicable when type is W_9.
Tax classification.
INDIVIDUAL_OR_SOLE_PROPRIETORIndividual/sole proprietor or single-member LLC.
C_CORPORATIONC corporation.
S_CORPORATIONS corporation.
PARTNERSHIPPartnership.
TRUST_OR_ESTATETrust or estate.
LLCLimited liability company. Requires llc_type.
OTHEROther entity. Specify the tax classification on the applicable form.
true if the entity has any foreign partners, owners, or beneficiaries. Applicable when type is TRUST_OR_ESTATE or PARTNERSHIP, or when llc_type is P.
Tax classification of the LLC. Applicable when type is LLC.
CC corporation
SS corporation
PPartnership
Name of the tax treaty on which the exemption is based (e.g. "US-Germany tax treaty"). Applicable when type is 8233 and exempt_from_withholding is true.
Items of income to be received from payers that are effectively connected with the conduct of a trade or business in the US. Applicable when type is W_8_ECI.
Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.
Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.
Address in the United States. Applicable when type is 8233.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.
Chapter 3 status specific certifications. Applicable when type is W_8_EXP.
Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies: (1) the entity is a foreign central bank of issue, (2) it does not hold obligations for commercial banking activity, and (3) payments are within the §895 exemption scope. (line 12) Applicable when entity_type is FOREIGN_CENTRAL_BANK_OF_ISSUE.
Certifies that the entity is a foreign government within the meaning of §892 and payments are within the scope of the exemption granted by §892. (line 10a) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity has an IRS determination letter currently in effect concluding it is exempt under §501(c). (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies an opinion from U.S. counsel is attached concluding the entity is described in §501(c). (line 13b) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an international organization within §7701(a)(18) and payments are within the §892 exemption scope. (line 11) Applicable when entity_type is INTERNATIONAL_ORGANIZATION.
Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
A controlled entity of a foreign sovereign (other than a foreign central bank wholly owned) certifies the beneficial owner is not engaged in commercial activities within or outside the US. (line 10d) Applicable when entity_type is FOREIGN_GOVERNMENT.
For a foreign central bank of issue controlled by a foreign sovereign, certifies the beneficial owner is not engaged in commercial activities within the US. (line 10e) Applicable when entity_type is FOREIGN_GOVERNMENT.
For §501(c)(3) organizations only. Certifies the organization is not a private foundation under §509. Requires an affidavit attachment. (line 13c) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
For §501(c)(3) organizations only. Certifies the organization is a private foundation under §509. (line 13d) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies the entity is a US territory government or political subdivision claiming a §115(2) exemption. (line 14) Applicable when entity_type is GOVERNMENT_OF_A_US_TERRITORY.
Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.
Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.
Certifies the entity is acting as a qualified securities lender (other than a QI) assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 17d).
Certifies the entity is using this form to transmit withholding certificates and/or other documentation and has provided or will provide a withholding statement (Line 17b).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a withholding rate pool of US payees (Line 17c).
Certifies the entity is not acting as a QI with respect to accounts for which this form is provided and is not acting for its own account (Line 17a).
Certifies that, where an alternative withholding statement described in Regulations section 1.1441-1(e)(3)(iv)(C)(3) is provided, the information on all associated withholding statements has been (or will be) verified for inconsistency with other account information for determining the rate of withholding for each payee (Line 17e).
Certifications for a Nonwithholding Foreign Partnership, Simple Trust, or Grantor Trust. Applicable when entity_type is NONWITHHOLDING_FOREIGN_PARTNERSHIP, NONWITHHOLDING_FOREIGN_SIMPLE_TRUST, or NONWITHHOLDING_FOREIGN_GRANTOR_TRUST.
Certifies the entity is a foreign grantor trust providing the form on behalf of each grantor or other owner, transmitting withholding certificates and providing a withholding statement to allocate the amount realized (Line 21e).
Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).
Certifies the entity is a foreign partnership receiving an amount realized on the transfer of an interest in a partnership for section 1446(f) purposes (Line 21c).
Certifies the entity is providing this form for payments not effectively connected with a US trade or business, and is using this form to transmit withholding certificates and/or documentation with a withholding statement (Line 21a).
Certifies the entity is a foreign partnership or foreign grantor trust that is a partner in a lower-tier partnership providing this form for section 1446(a) purposes (Line 21b).
Certifies the entity represents that the information on the withholding certificates may be relied upon when providing an alternative withholding statement under Regulations section 1.1441-1(e)(3)(iv)(C)(3) (Line 21f).
Certifications for a Qualified Intermediary. Applicable when entity_type is QI.
Certifies the entity assumes primary Form 1099 reporting and backup withholding responsibility, or reporting responsibility as a participating FFI or registered deemed-compliant FFI, for accounts held by specified US persons (Line 15f).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 for each account identified on a withholding statement (or all accounts if no statement attached) (Line 15a).
Certifies the entity assumes primary withholding as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 15c).
Certifies the entity is a QI acting as a qualified securities lender assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 15d).
Certifies the entity assumes primary withholding and reporting responsibility for payments of amounts realized from sales of interests in publicly traded partnerships under section 1446(f) (Line 15b).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 and primary Form 1099 reporting and backup withholding responsibility for US source interest and substitute interest (Line 15e).
Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).
Certifies the entity has obtained or will obtain documentation for intermediaries or flow-through entities in a chapter 4 withholding rate pool of US payees (Line 15i).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a chapter 4 withholding rate pool of US payees (Line 15h).
Certifies each QDD identified meets the requirements to act as a QDD and assumes primary withholding and reporting responsibilities under chapters 3, 4, and 61 and section 3406 (Line 16a).
Certifies the entity is a QI with respect to identified accounts, has provided or will provide a withholding statement, and will provide required payee documentation if acting as a disclosing QI for section 1446(a) or (f) (Line 14).
Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.
Certifies the entity agrees to be treated as a US person and as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 18e).
Certifies the entity is using this form as evidence of agreement to be treated as a US person for chapters 3 and 4 purposes (Line 18b).
Certifies the entity agrees to be treated as a US person under Regulations section 1.1446(f)-4(a)(2)(i)(B) for amounts realized on sales of interests in publicly traded partnerships (Line 18d).
Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).
Certifies the entity is a financial institution (other than an investment entity that is not also a depository, custodial, or specified insurance institution) incorporated or organized under the laws of a US territory (Line 18a).
Certifications for a US Branch. Applicable when entity_type is US_BRANCH.
Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).
Certifies the entity is a US branch acting as a US person for amounts realized on sales of interests in publicly traded partnerships (Line 19d).
Certifies the entity is a US branch of a foreign bank or insurance company using this form as evidence of agreement to be treated as a US person (Line 19b).
Certifies the entity is using this form to transmit withholding certificates and/or documentation, will provide a withholding statement, and applies rules under Regulations section 1.1471-4(d)(2)(iii)(C) for withholdable payments (Line 19c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).
Certifies the entity is a US branch receiving reportable amounts or withholdable payments that are not ECI, distributions from publicly traded partnerships, or amounts realized on sales of interests in publicly traded partnerships (Line 19a).
Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.
Certifies the entity is a withholding foreign partnership or withholding foreign trust that is compliant with the terms of its WP or WT agreement (Line 20).
Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.
Details about what payer information is incomplete.
A detailed message describing the missing information.
Type of information that is missing or incorrect.
TAX_IDENTIFIERThe payer's tax identifier is missing or incorrect
STATEThe payer's state is missing or incorrect
CITYThe payer's city is missing or incorrect
COUNTRY_CODEThe payer's country code is missing or incorrect
BUSINESS_NAMEThe payer's business name is missing or incorrect
PHONE_NUMBERThe payer's phone number is missing or incorrect
Full legal name of the individual who provided the electronic signature.
Additional files uploaded for different supporting purposes.
The file ID returned when the document was uploaded to the file service.
Purpose of the supporting document. The applicable values depend on the tax form type.
RESIDENCY_PROOFSupporting document if the address is not in the US. Applicable when the form type is W_9
NON_US_TAX_PROOFSupporting document if the mailing address is in the US. Applicable when the form type is W_8_BEN or W_8_BEN_E
INCOME_ITEM_STATEMENTStatement of taxable income items. Applicable when the form type is W_8_ECI
WITHHOLDING_CERTIFICATIONCertification specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
WITHHOLDING_STATEMENTStatement specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
TAX_EXEMPTION_INCOME_STATEMENTStatement identifying amounts includible under section 512 in computing the entity's unrelated business taxable income. Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
US_COUNSEL_CONCLUSIONOpinion from U.S. counsel concluding the entity is described in section 501(c). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
AFFIDAVITAffidavit for the IRS to determine the organization is not a private foundation because it meets one of the exceptions described in section 509(a)(1), (2), (3), or (4). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
FOREIGN_SCHOLAR_ATTACHMENTStatement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true
Additional description of the file.
Time when the tax profile was last updated, in ISO 8601 format.
Time when the amendment was created, in ISO 8601 format.
Unique ID of the amendment.
Status of the amendment.
PENDINGThe amendment is pending review
APPROVEDThe amendment is approved
REJECTEDThe amendment is rejected
Time when the amendment was last updated, in ISO 8601 format.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 404 | Possible errors: |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/beneficiary_tax_profiles/txf-9a1b2c3d4e5f/amendments/create' \> --header 'Authorization: Bearer <token>' \> --header 'Content-Type: application/json' \> --data '{> "type": "W_9",> "signature_name": "Jane A. Smith",> "supporting_documents": [> {> "tag": "RESIDENCY_PROOF",> "file_id": "file-4b2e1d09c3",> "description": "Utility bill confirming non-US address."> }> ],> "profile_details": {> "name": "Jane A. Smith",> "business_name": "Smith Consulting LLC",> "tax_classification": {> "type": "LLC",> "llc_type": "S"> },> "tax_identifier": {> "type": "EIN",> "number": "12-3456789"> },> "address": {> "country_code": "US",> "country_name": "United States",> "address_line1": "456 Oak Avenue",> "address_line2": "Suite 100",> "postcode": "94105",> "state": "California",> "state_code": "CA",> "suburb": "San Francisco"> },> "electronic_delivery_consent": true> }>}'
1{2 "id": "amd-1a2b3c4d5e6f",3 "status": "PENDING",4 "beneficiary_tax_profile": {5 "id": "txf-9a1b2c3d4e5f",6 "version": 2,7 "status": "SUBMITTED",8 "type": "W_9",9 "external_id": "recipient-7f3a9c12",10 "signature_name": "Jane A. Smith",11 "supporting_documents": [12 {13 "tag": "RESIDENCY_PROOF",14 "file_id": "file-4b2e1d09c3",15 "description": "Utility bill confirming non-US address."16 }17 ],18 "profile_details": {19 "name": "Jane A. Smith",20 "business_name": "Smith Consulting LLC",21 "tax_classification": {22 "type": "LLC",23 "llc_type": "S"24 },25 "tax_identifier": {26 "type": "EIN",27 "number": "12-3456789"28 },29 "address": {30 "country_code": "US",31 "country_name": "United States",32 "address_line1": "456 Oak Avenue",33 "address_line2": "Suite 100",34 "postcode": "94105",35 "state": "California",36 "state_code": "CA",37 "suburb": "San Francisco"38 },39 "electronic_delivery_consent": true40 }41 },42 "created_at": "2026-06-10T08:30:00+0000",43 "updated_at": "2026-06-10T08:30:00+0000"44}
Retrieve a Beneficiary Tax Profile Amendment
GET /api/v1/beneficiary_tax_profiles/{id}/amendments/{amendment_id}
Retrieve the details of a specific amendment to a beneficiary tax profile by its unique ID.
x-on-behalf-of headerUnique ID of the amendment.
Unique ID of the tax profile.
The new tax profile version created by this amendment.
Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.
Unique ID of the tax profile.
Status of the tax profile.
SUBMITTEDThe tax profile has been submitted and is pending review
REJECTEDThe tax profile has been rejected. The reason can be found in failure_reason
ACTION_REQUIREDAdditional information or action is required to continue. Details can be found in requirements
SUPERSEDEDThe tax profile version has been replaced by a newer version created through an approved amendment
READYProfile review passed and the profile is ready to be used for filing
The type of underlying tax form of the profile.
W_9Form W-9, for a US person.
W_8_BENForm W-8BEN, for a foreign individual.
W_8_BEN_EForm W-8BEN-E, for a foreign entity.
W_8_ECIForm W-8ECI, for income effectively connected with a US trade or business.
W_8_EXPForm W-8EXP, for a foreign government or other exempt organization.
W_8_IMYForm W-8IMY, for a foreign intermediary or flow-through entity.
8233Form 8233, for exemption from withholding on compensation of a nonresident alien individual.
The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.
Time when the tax profile was created, in ISO 8601 format.
Additional message if verification failed.
Recipient details used to file taxes.
Address of recipient.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Name of the individual or organization that is the beneficial owner / intermediary.
Taxpayer Identification Number.
The Tax Identification number.
Type of Tax Identification.
SSNSocial Security Number.
EINEmployer Identification Number.
ITINIndividual Taxpayer Identification Number.
QI_EINQualified Intermediary Employer Identification Number.
WP_EINWithholding Foreign Partnership Employer Identification Number.
WT_EINWithholding Foreign Trust Employer Identification Number.
Business address in the US. Applicable when type is W_8_ECI.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Business name, trade name, DBA name, or disregarded entity name that is different from the name on the tax return. Applicable when type is W_9.
Country of citizenship, incorporation, or organization (2-letter ISO 3166-1 alpha-2 country code). Applicable when type is W_8_BEN, W_8_BEN_E, W_8_ECI, W_8_EXP, W_8_IMY, or 8233.
Current nonimmigrant status in the US. Applicable when type is 8233.
Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.
Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.
Name of the disregarded entity receiving the payment, if applicable. Applicable when type is W_8_BEN_E, W_8_ECI, or W_8_IMY.
Whether the recipient consents to electronic delivery of Form 1099. Applicable when type is W_9.
Chapter 3 status of the entity (Forms W-8BEN-E, W-8ECI, W-8EXP), or the role in which the entity is acting as an intermediary or flow-through entity (Form W-8IMY). Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
PARTNERSHIPPartnership. Applicable to Form W-8BEN-E or W-8ECI
CORPORATIONCorporation. Applicable to Form W-8BEN-E or W-8ECI
SIMPLE_TRUSTSimple trust. Applicable to Form W-8BEN-E or W-8ECI
TAX_EXEMPT_ORGANIZATIONTax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI
COMPLEX_TRUSTComplex trust. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_CONTROLLED_ENTITYEntity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI
CENTRAL_BANK_OF_ISSUECentral bank of issue. Applicable to Form W-8BEN-E or W-8ECI
PRIVATE_FOUNDATIONPrivate foundation. Applicable to Form W-8BEN-E or W-8ECI
ESTATEEstate. Applicable to Form W-8BEN-E or W-8ECI
FOREIGN_GOVERNMENT_INTEGRAL_PARTIntegral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI
GRANTOR_TRUSTGrantor trust. Applicable to Form W-8BEN-E or W-8ECI
DISREGARDED_ENTITYDisregarded entity. Applicable to Form W-8BEN-E or W-8ECI
INTERNATIONAL_ORGANIZATIONInternational organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP
FOREIGN_GOVERNMENTForeign government. Applicable to Form W-8EXP
FOREIGN_CENTRAL_BANK_OF_ISSUEForeign central bank of issue. Applicable to Form W-8EXP
FOREIGN_TAX_EXEMPT_ORGANIZATIONForeign tax-exempt organization under section 501(c). Applicable to Form W-8EXP
FOREIGN_PRIVATE_FOUNDATIONForeign private foundation. Applicable to Form W-8EXP
GOVERNMENT_OF_A_US_TERRITORYGovernment of a US territory or political subdivision. Applicable to Form W-8EXP
QIQualified Intermediary. Applicable to Form W-8IMY
NONQUALIFIED_INTERMEDIARYNonqualified intermediary. Applicable to Form W-8IMY
TERRITORY_FINANCIAL_INSTITUTIONTerritory financial institution. Applicable to Form W-8IMY
US_BRANCHUS branch. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_PARTNERSHIPWithholding foreign partnership. Applicable to Form W-8IMY
WITHHOLDING_FOREIGN_TRUSTWithholding foreign trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_PARTNERSHIPNonwithholding foreign partnership. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_SIMPLE_TRUSTNonwithholding foreign simple trust. Applicable to Form W-8IMY
NONWITHHOLDING_FOREIGN_GRANTOR_TRUSTNonwithholding foreign grantor trust. Applicable to Form W-8IMY
Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.
Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.
Sufficient facts to justify the exemption from withholding claimed, to allow the IRS to determine the tax treaty benefits being claimed. Applicable when type is 8233.
Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.
Foreign Tax Identifying Number. Empty if not legally required. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, W_8_IMY, or 8233.
Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.
Description of the personal services being provided. Applicable when type is 8233.
Mailing address, if different from address or if the form is not delivered electronically. Applicable when type is W_8_BEN, W_8_BEN_E, W_8_EXP, or W_8_IMY.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.
Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.
Passport number. Applicable when type is 8233.
Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.
Treaty article on which the exemption is based (e.g. "Article 14, paragraph 2"). Applicable when type is 8233 and exempt_from_withholding is true.
Federal tax classification. Applicable when type is W_9.
Tax classification.
INDIVIDUAL_OR_SOLE_PROPRIETORIndividual/sole proprietor or single-member LLC.
C_CORPORATIONC corporation.
S_CORPORATIONS corporation.
PARTNERSHIPPartnership.
TRUST_OR_ESTATETrust or estate.
LLCLimited liability company. Requires llc_type.
OTHEROther entity. Specify the tax classification on the applicable form.
true if the entity has any foreign partners, owners, or beneficiaries. Applicable when type is TRUST_OR_ESTATE or PARTNERSHIP, or when llc_type is P.
Tax classification of the LLC. Applicable when type is LLC.
CC corporation
SS corporation
PPartnership
Name of the tax treaty on which the exemption is based (e.g. "US-Germany tax treaty"). Applicable when type is 8233 and exempt_from_withholding is true.
Items of income to be received from payers that are effectively connected with the conduct of a trade or business in the US. Applicable when type is W_8_ECI.
Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.
Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.
Address in the United States. Applicable when type is 8233.
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
Country code (2-letter ISO 3166-1 alpha-2 country code).
Country name.
Postcode or zip code.
Name of state.
Name of city / suburb.
An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.
2-letter state code.
US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.
Chapter 3 status specific certifications. Applicable when type is W_8_EXP.
Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies: (1) the entity is a foreign central bank of issue, (2) it does not hold obligations for commercial banking activity, and (3) payments are within the §895 exemption scope. (line 12) Applicable when entity_type is FOREIGN_CENTRAL_BANK_OF_ISSUE.
Certifies that the entity is a foreign government within the meaning of §892 and payments are within the scope of the exemption granted by §892. (line 10a) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity has an IRS determination letter currently in effect concluding it is exempt under §501(c). (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies an opinion from U.S. counsel is attached concluding the entity is described in §501(c). (line 13b) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.
Certifies the entity is an international organization within §7701(a)(18) and payments are within the §892 exemption scope. (line 11) Applicable when entity_type is INTERNATIONAL_ORGANIZATION.
Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
A controlled entity of a foreign sovereign (other than a foreign central bank wholly owned) certifies the beneficial owner is not engaged in commercial activities within or outside the US. (line 10d) Applicable when entity_type is FOREIGN_GOVERNMENT.
For a foreign central bank of issue controlled by a foreign sovereign, certifies the beneficial owner is not engaged in commercial activities within the US. (line 10e) Applicable when entity_type is FOREIGN_GOVERNMENT.
For §501(c)(3) organizations only. Certifies the organization is not a private foundation under §509. Requires an affidavit attachment. (line 13c) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
For §501(c)(3) organizations only. Certifies the organization is a private foundation under §509. (line 13d) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.
Certifies the entity is a US territory government or political subdivision claiming a §115(2) exemption. (line 14) Applicable when entity_type is GOVERNMENT_OF_A_US_TERRITORY.
Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.
Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.
Certifies the entity is acting as a qualified securities lender (other than a QI) assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 17d).
Certifies the entity is using this form to transmit withholding certificates and/or other documentation and has provided or will provide a withholding statement (Line 17b).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a withholding rate pool of US payees (Line 17c).
Certifies the entity is not acting as a QI with respect to accounts for which this form is provided and is not acting for its own account (Line 17a).
Certifies that, where an alternative withholding statement described in Regulations section 1.1441-1(e)(3)(iv)(C)(3) is provided, the information on all associated withholding statements has been (or will be) verified for inconsistency with other account information for determining the rate of withholding for each payee (Line 17e).
Certifications for a Nonwithholding Foreign Partnership, Simple Trust, or Grantor Trust. Applicable when entity_type is NONWITHHOLDING_FOREIGN_PARTNERSHIP, NONWITHHOLDING_FOREIGN_SIMPLE_TRUST, or NONWITHHOLDING_FOREIGN_GRANTOR_TRUST.
Certifies the entity is a foreign grantor trust providing the form on behalf of each grantor or other owner, transmitting withholding certificates and providing a withholding statement to allocate the amount realized (Line 21e).
Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).
Certifies the entity is a foreign partnership receiving an amount realized on the transfer of an interest in a partnership for section 1446(f) purposes (Line 21c).
Certifies the entity is providing this form for payments not effectively connected with a US trade or business, and is using this form to transmit withholding certificates and/or documentation with a withholding statement (Line 21a).
Certifies the entity is a foreign partnership or foreign grantor trust that is a partner in a lower-tier partnership providing this form for section 1446(a) purposes (Line 21b).
Certifies the entity represents that the information on the withholding certificates may be relied upon when providing an alternative withholding statement under Regulations section 1.1441-1(e)(3)(iv)(C)(3) (Line 21f).
Certifications for a Qualified Intermediary. Applicable when entity_type is QI.
Certifies the entity assumes primary Form 1099 reporting and backup withholding responsibility, or reporting responsibility as a participating FFI or registered deemed-compliant FFI, for accounts held by specified US persons (Line 15f).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 for each account identified on a withholding statement (or all accounts if no statement attached) (Line 15a).
Certifies the entity assumes primary withholding as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 15c).
Certifies the entity is a QI acting as a qualified securities lender assuming primary withholding and reporting responsibilities for US source substitute dividends (Line 15d).
Certifies the entity assumes primary withholding and reporting responsibility for payments of amounts realized from sales of interests in publicly traded partnerships under section 1446(f) (Line 15b).
Certifies the entity assumes primary withholding responsibility for chapters 3 and 4 and primary Form 1099 reporting and backup withholding responsibility for US source interest and substitute interest (Line 15e).
Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).
Certifies the entity has obtained or will obtain documentation for intermediaries or flow-through entities in a chapter 4 withholding rate pool of US payees (Line 15i).
Certifies the entity meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for account holders included in a chapter 4 withholding rate pool of US payees (Line 15h).
Certifies each QDD identified meets the requirements to act as a QDD and assumes primary withholding and reporting responsibilities under chapters 3, 4, and 61 and section 3406 (Line 16a).
Certifies the entity is a QI with respect to identified accounts, has provided or will provide a withholding statement, and will provide required payee documentation if acting as a disclosing QI for section 1446(a) or (f) (Line 14).
Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.
Certifies the entity agrees to be treated as a US person and as a nominee under Regulations section 1.1446-4(b)(3) for distributions by publicly traded partnerships (Line 18e).
Certifies the entity is using this form as evidence of agreement to be treated as a US person for chapters 3 and 4 purposes (Line 18b).
Certifies the entity agrees to be treated as a US person under Regulations section 1.1446(f)-4(a)(2)(i)(B) for amounts realized on sales of interests in publicly traded partnerships (Line 18d).
Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).
Certifies the entity is a financial institution (other than an investment entity that is not also a depository, custodial, or specified insurance institution) incorporated or organized under the laws of a US territory (Line 18a).
Certifications for a US Branch. Applicable when entity_type is US_BRANCH.
Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).
Certifies the entity is a US branch acting as a US person for amounts realized on sales of interests in publicly traded partnerships (Line 19d).
Certifies the entity is a US branch of a foreign bank or insurance company using this form as evidence of agreement to be treated as a US person (Line 19b).
Certifies the entity is using this form to transmit withholding certificates and/or documentation, will provide a withholding statement, and applies rules under Regulations section 1.1471-4(d)(2)(iii)(C) for withholdable payments (Line 19c).
Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).
Certifies the entity is a US branch receiving reportable amounts or withholdable payments that are not ECI, distributions from publicly traded partnerships, or amounts realized on sales of interests in publicly traded partnerships (Line 19a).
Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.
Certifies the entity is a withholding foreign partnership or withholding foreign trust that is compliant with the terms of its WP or WT agreement (Line 20).
Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.
Details about what payer information is incomplete.
A detailed message describing the missing information.
Type of information that is missing or incorrect.
TAX_IDENTIFIERThe payer's tax identifier is missing or incorrect
STATEThe payer's state is missing or incorrect
CITYThe payer's city is missing or incorrect
COUNTRY_CODEThe payer's country code is missing or incorrect
BUSINESS_NAMEThe payer's business name is missing or incorrect
PHONE_NUMBERThe payer's phone number is missing or incorrect
Full legal name of the individual who provided the electronic signature.
Additional files uploaded for different supporting purposes.
The file ID returned when the document was uploaded to the file service.
Purpose of the supporting document. The applicable values depend on the tax form type.
RESIDENCY_PROOFSupporting document if the address is not in the US. Applicable when the form type is W_9
NON_US_TAX_PROOFSupporting document if the mailing address is in the US. Applicable when the form type is W_8_BEN or W_8_BEN_E
INCOME_ITEM_STATEMENTStatement of taxable income items. Applicable when the form type is W_8_ECI
WITHHOLDING_CERTIFICATIONCertification specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
WITHHOLDING_STATEMENTStatement specifying the accounts and reportable amounts, required for purposes of chapter 4. Applicable when the form type is W_8_IMY and the entity type is QI
TAX_EXEMPTION_INCOME_STATEMENTStatement identifying amounts includible under section 512 in computing the entity's unrelated business taxable income. Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
US_COUNSEL_CONCLUSIONOpinion from U.S. counsel concluding the entity is described in section 501(c). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
AFFIDAVITAffidavit for the IRS to determine the organization is not a private foundation because it meets one of the exceptions described in section 509(a)(1), (2), (3), or (4). Applicable when the form type is W_8_EXP and the entity type is FOREIGN_TAX_EXEMPT_ORGANIZATION
FOREIGN_SCHOLAR_ATTACHMENTStatement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true
Additional description of the file.
Time when the tax profile was last updated, in ISO 8601 format.
Time when the amendment was created, in ISO 8601 format.
Unique ID of the amendment.
Status of the amendment.
PENDINGThe amendment is pending review
APPROVEDThe amendment is approved
REJECTEDThe amendment is rejected
Time when the amendment was last updated, in ISO 8601 format.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 404 | Possible errors: |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/beneficiary_tax_profiles/txf-9a1b2c3d4e5f/amendments/amd-1a2b3c4d5e6f' \> --header 'Authorization: Bearer <token>' \> --header 'Content-Type: application/json'
1{2 "id": "amd-1a2b3c4d5e6f",3 "status": "APPROVED",4 "type": "W_9",5 "beneficiary_tax_profile": {6 "id": "txf-9a1b2c3d4e5f",7 "version": 2,8 "status": "READY",9 "type": "W_9",10 "external_id": "recipient-7f3a9c12",11 "signature_name": "Jane A. Smith",12 "supporting_documents": [13 {14 "tag": "RESIDENCY_PROOF",15 "file_id": "file-4b2e1d09c3",16 "description": "Utility bill confirming non-US address."17 }18 ],19 "profile_details": {20 "name": "Jane A. Smith",21 "business_name": "Smith Consulting LLC",22 "tax_classification": {23 "type": "LLC",24 "llc_type": "S"25 },26 "tax_identifier": {27 "type": "EIN",28 "number": "12-3456789"29 },30 "address": {31 "country_code": "US",32 "country_name": "United States",33 "address_line1": "456 Oak Avenue",34 "address_line2": "Suite 100",35 "postcode": "94105",36 "state": "California",37 "state_code": "CA",38 "suburb": "San Francisco"39 },40 "electronic_delivery_consent": true41 },42 "created_at": "2026-06-10T08:30:00+0000",43 "updated_at": "2026-06-10T09:15:00+0000"44 },45 "created_at": "2026-01-15T08:30:00+0000",46 "updated_at": "2026-02-03T14:22:45+0000"47}