Airwallex logo

Beneficiary Tax Profiles

Copy for LLMView as Markdown

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.

POST /api/v1/beneficiary_tax_profiles/createCreate a Beneficiary Tax Profile
GET /api/v1/beneficiary_tax_profiles/{id}Retrieve a Beneficiary Tax Profile
GET /api/v1/beneficiary_tax_profilesList all Beneficiary Tax Profiles
POST /api/v1/beneficiary_tax_profiles/{id}/downloadDownload the Latest Version of a Beneficiary Tax Profile
GET /api/v1/beneficiary_tax_profiles/{id}/versions/{version}Retrieve a Beneficiary Tax Profile Version
GET /api/v1/beneficiary_tax_profiles/{id}/versionsList All Versions of a Beneficiary Tax Profile
POST /api/v1/beneficiary_tax_profiles/{id}/versions/{version}/downloadDownload a Historical Version of a Beneficiary Tax Profile
POST /api/v1/beneficiary_tax_profiles/{id}/amendments/createCreate a Beneficiary Tax Profile Amendment
GET /api/v1/beneficiary_tax_profiles/{id}/amendments/{amendment_id}Retrieve a Beneficiary Tax Profile Amendment

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.

Scoped API key permissions
PayoutsBeneficiary Tax ProfilesWrite
On behalf of
Supports x-on-behalf-of header
Request body
external_idrequiredstring

Unique 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.

profile_detailsrequiredobject

Recipient details used to file taxes.

profile_details.addressrequiredobject

Address of recipient.

profile_details.address.address_line1requiredstring

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.

profile_details.address.country_coderequiredstring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.address.country_namerequiredstring

Country name.

profile_details.address.postcoderequiredstring

Postcode or zip code.

profile_details.address.staterequiredstring

Name of state.

profile_details.address.suburbrequiredstring

Name of city / suburb.

profile_details.address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.address.state_codestring

2-letter state code.

profile_details.namerequiredstring

Name of the individual or organization that is the beneficial owner / intermediary.

profile_details.tax_identifierrequiredobject

Taxpayer Identification Number.

profile_details.tax_identifier.numberrequiredstring

The Tax Identification number.

profile_details.tax_identifier.typerequiredstring

Type of Tax Identification.

SSN

Social Security Number.

EIN

Employer Identification Number.

ITIN

Individual Taxpayer Identification Number.

QI_EIN

Qualified Intermediary Employer Identification Number.

WP_EIN

Withholding Foreign Partnership Employer Identification Number.

WT_EIN

Withholding Foreign Trust Employer Identification Number.

profile_details.business_addressobject

Business address in the US. Applicable when type is W_8_ECI.

profile_details.business_address.address_line1requiredstring

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.

profile_details.business_address.country_coderequiredstring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.business_address.country_namerequiredstring

Country name.

profile_details.business_address.postcoderequiredstring

Postcode or zip code.

profile_details.business_address.staterequiredstring

Name of state.

profile_details.business_address.suburbrequiredstring

Name of city / suburb.

profile_details.business_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.business_address.state_codestring

2-letter state code.

profile_details.business_namestring

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.

profile_details.countrystring

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.

profile_details.current_non_immigrant_statusstring

Current nonimmigrant status in the US. Applicable when type is 8233.

profile_details.current_non_immigrant_status_expiry_datestring

Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.

profile_details.date_of_birthstring

Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.

profile_details.disregarded_entity_namestring

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.

profile_details.entity_typestring

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.

PARTNERSHIP

Partnership. Applicable to Form W-8BEN-E or W-8ECI

CORPORATION

Corporation. Applicable to Form W-8BEN-E or W-8ECI

SIMPLE_TRUST

Simple trust. Applicable to Form W-8BEN-E or W-8ECI

TAX_EXEMPT_ORGANIZATION

Tax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI

COMPLEX_TRUST

Complex trust. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_CONTROLLED_ENTITY

Entity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI

CENTRAL_BANK_OF_ISSUE

Central bank of issue. Applicable to Form W-8BEN-E or W-8ECI

PRIVATE_FOUNDATION

Private foundation. Applicable to Form W-8BEN-E or W-8ECI

ESTATE

Estate. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_INTEGRAL_PART

Integral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI

GRANTOR_TRUST

Grantor trust. Applicable to Form W-8BEN-E or W-8ECI

DISREGARDED_ENTITY

Disregarded entity. Applicable to Form W-8BEN-E or W-8ECI

INTERNATIONAL_ORGANIZATION

International organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP

FOREIGN_GOVERNMENT

Foreign government. Applicable to Form W-8EXP

FOREIGN_CENTRAL_BANK_OF_ISSUE

Foreign central bank of issue. Applicable to Form W-8EXP

FOREIGN_TAX_EXEMPT_ORGANIZATION

Foreign tax-exempt organization under section 501(c). Applicable to Form W-8EXP

FOREIGN_PRIVATE_FOUNDATION

Foreign private foundation. Applicable to Form W-8EXP

GOVERNMENT_OF_A_US_TERRITORY

Government of a US territory or political subdivision. Applicable to Form W-8EXP

QI

Qualified Intermediary. Applicable to Form W-8IMY

NONQUALIFIED_INTERMEDIARY

Nonqualified intermediary. Applicable to Form W-8IMY

TERRITORY_FINANCIAL_INSTITUTION

Territory financial institution. Applicable to Form W-8IMY

US_BRANCH

US branch. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_PARTNERSHIP

Withholding foreign partnership. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_TRUST

Withholding foreign trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_PARTNERSHIP

Nonwithholding foreign partnership. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_SIMPLE_TRUST

Nonwithholding foreign simple trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_GRANTOR_TRUST

Nonwithholding foreign grantor trust. Applicable to Form W-8IMY

profile_details.entry_to_us_datestring

Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.

profile_details.exempt_from_withholdingboolean

Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.

profile_details.exemption_justificationstring

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.

profile_details.foreign_scholarboolean

Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.

profile_details.foreign_tax_identifierstring

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.

profile_details.has_non_compensatory_incomeboolean

Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.

profile_details.independent_personal_servicesstring

Description of the personal services being provided. Applicable when type is 8233.

profile_details.mailing_addressobject

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.

profile_details.mailing_address.address_line1requiredstring

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.

profile_details.mailing_address.country_coderequiredstring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.mailing_address.country_namerequiredstring

Country name.

profile_details.mailing_address.postcoderequiredstring

Postcode or zip code.

profile_details.mailing_address.staterequiredstring

Name of state.

profile_details.mailing_address.suburbrequiredstring

Name of city / suburb.

profile_details.mailing_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.mailing_address.state_codestring

2-letter state code.

profile_details.non_compensatory_exempt_amountstring

Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_tax_articlestring

Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_tax_treatystring

Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_total_incomestring

Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.passport_numberstring

Passport number. Applicable when type is 8233.

profile_details.reference_numberstring

Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.

profile_details.tax_articlestring

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.

profile_details.tax_classificationobject

Federal tax classification. Applicable when type is W_9.

profile_details.tax_classification.typerequiredstring

Tax classification.

INDIVIDUAL_OR_SOLE_PROPRIETOR

Individual/sole proprietor or single-member LLC.

C_CORPORATION

C corporation.

S_CORPORATION

S corporation.

PARTNERSHIP

Partnership.

TRUST_OR_ESTATE

Trust or estate.

LLC

Limited liability company. Requires llc_type.

OTHER

Other entity. Specify the tax classification on the applicable form.

profile_details.tax_classification.has_foreign_beneficiariesboolean

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.

profile_details.tax_classification.llc_typestring

Tax classification of the LLC. Applicable when type is LLC.

C

C corporation

S

S corporation

P

Partnership

profile_details.tax_treatystring

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.

profile_details.taxable_income_itemsstring

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.

profile_details.total_compensationstring

Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.

profile_details.total_paid_compensationstring

Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.

profile_details.us_addressobject

Address in the United States. Applicable when type is 8233.

profile_details.us_address.address_line1requiredstring

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.

profile_details.us_address.country_coderequiredstring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.us_address.country_namerequiredstring

Country name.

profile_details.us_address.postcoderequiredstring

Postcode or zip code.

profile_details.us_address.staterequiredstring

Name of state.

profile_details.us_address.suburbrequiredstring

Name of city / suburb.

profile_details.us_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.us_address.state_codestring

2-letter state code.

profile_details.visa_typestring

US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.

profile_details.w8_exp_certificationobject

Chapter 3 status specific certifications. Applicable when type is W_8_EXP.

profile_details.w8_exp_certification.controlled_entityboolean

Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.controlling_government_namestring

The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.foreign_central_bank_of_issueboolean

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.

profile_details.w8_exp_certification.foreign_governmentboolean

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.

profile_details.w8_exp_certification.has_irs_determination_letterboolean

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.

profile_details.w8_exp_certification.has_us_counsel_opinionboolean

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.

profile_details.w8_exp_certification.integral_part_government_namestring

The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.integral_part_of_governmentboolean

Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.international_organizationboolean

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.

profile_details.w8_exp_certification.irs_determination_letter_datestring

Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.

profile_details.w8_exp_certification.no_commercial_activityboolean

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.

profile_details.w8_exp_certification.no_us_commercial_activityboolean

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.

profile_details.w8_exp_certification.not_private_foundationboolean

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.

profile_details.w8_exp_certification.private_foundationboolean

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.

profile_details.w8_exp_certification.us_territory_governmentboolean

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.

profile_details.w8_imy_certificationobject

Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.

profile_details.w8_imy_certification.nonqualified_intermediaryobject

Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.

profile_details.w8_imy_certification.nonqualified_intermediary.assumes_primary_withholding_as_qslboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.has_provide_withholding_statementboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.meets_requirements_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.not_acting_as_qiboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.withholding_statement_consistency_verifiedboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entityobject

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.

profile_details.w8_imy_certification.nonwithholding_foreign_entity.acts_on_behalf_of_grantorsboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_provide_modified_amount_statementboolean

Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_receive_amount_from_partnership_transferboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.non_eci_paymentboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.partner_in_lower_tier_partnershipboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.reliable_for_alternative_withholdingboolean

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).

profile_details.w8_imy_certification.qiobject

Certifications for a Qualified Intermediary. Applicable when entity_type is QI.

profile_details.w8_imy_certification.qi.assumes_1099_reporting_for_us_personsboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholdingboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_ptp_nomineeboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_qslboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_ptp_salesboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_us_interestboolean

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).

profile_details.w8_imy_certification.qi.does_not_assume_1099_reportingboolean

Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).

profile_details.w8_imy_certification.qi.has_documentation_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.qi.meets_requirements_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.qi.qdd_statusboolean

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).

profile_details.w8_imy_certification.qi.qi_statusboolean

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).

profile_details.w8_imy_certification.territory_financial_institutionobject

Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.

profile_details.w8_imy_certification.territory_financial_institution.agrees_act_as_nominee_for_ptp_distributionsboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_personboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_person_for_ptp_salesboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.has_provide_withholding_statementboolean

Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).

profile_details.w8_imy_certification.territory_financial_institution.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).

profile_details.w8_imy_certification.territory_financial_institution.territory_financial_institutionboolean

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).

profile_details.w8_imy_certification.us_branchobject

Certifications for a US Branch. Applicable when entity_type is US_BRANCH.

profile_details.w8_imy_certification.us_branch.agrees_act_as_nominee_for_ptp_distributionsboolean

Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).

profile_details.w8_imy_certification.us_branch.agrees_act_as_us_person_for_ptp_salesboolean

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).

profile_details.w8_imy_certification.us_branch.agrees_treat_as_us_personboolean

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).

profile_details.w8_imy_certification.us_branch.has_provide_withholding_statementboolean

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).

profile_details.w8_imy_certification.us_branch.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).

profile_details.w8_imy_certification.us_branch.us_branchboolean

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).

profile_details.w8_imy_certification.withholding_foreign_entityobject

Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.

profile_details.w8_imy_certification.withholding_foreign_entity.compliance_with_agreementboolean

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).

signature_namerequiredstring

Full legal name of the individual providing the electronic signature for the tax form.

typerequiredstring

The type of underlying tax form of the profile.

W_9

Form W-9, for a US person.

W_8_BEN

Form W-8BEN, for a foreign individual.

W_8_BEN_E

Form W-8BEN-E, for a foreign entity.

W_8_ECI

Form W-8ECI, for income effectively connected with a US trade or business.

W_8_EXP

Form W-8EXP, for a foreign government or other exempt organization.

W_8_IMY

Form W-8IMY, for a foreign intermediary or flow-through entity.

8233

Form 8233, for exemption from withholding on compensation of a nonresident alien individual.

supporting_documentsarray

Additional files for different supporting purposes.

supporting_documents.file_idrequiredstring

The file ID returned when the document was uploaded to the file service.

supporting_documents.tagrequiredstring

Purpose of the supporting document. The applicable values depend on the tax form type.

RESIDENCY_PROOF

Supporting document if the address is not in the US. Applicable when the form type is W_9

NON_US_TAX_PROOF

Supporting 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_STATEMENT

Statement of taxable income items. Applicable when the form type is W_8_ECI

WITHHOLDING_CERTIFICATION

Certification 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_STATEMENT

Statement 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_STATEMENT

Statement 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_CONCLUSION

Opinion 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

AFFIDAVIT

Affidavit 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_ATTACHMENT

Statement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true

supporting_documents.descriptionstring

Additional description of the file.

Response body - 201 Created
created_atstring

Time when the tax profile was created, in ISO 8601 format.

external_idstring

Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.

failure_reasonstring

Additional message if verification failed.

idstring

Unique ID of the tax profile.

profile_detailsobject

Recipient details used to file taxes.

profile_details.addressobject

Address of recipient.

profile_details.address.address_line1string

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.

profile_details.address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.address.country_namestring

Country name.

profile_details.address.postcodestring

Postcode or zip code.

profile_details.address.statestring

Name of state.

profile_details.address.suburbstring

Name of city / suburb.

profile_details.address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.address.state_codestring

2-letter state code.

profile_details.namestring

Name of the individual or organization that is the beneficial owner / intermediary.

profile_details.tax_identifierobject

Taxpayer Identification Number.

profile_details.tax_identifier.numberstring

The Tax Identification number.

profile_details.tax_identifier.typestring

Type of Tax Identification.

SSN

Social Security Number.

EIN

Employer Identification Number.

ITIN

Individual Taxpayer Identification Number.

QI_EIN

Qualified Intermediary Employer Identification Number.

WP_EIN

Withholding Foreign Partnership Employer Identification Number.

WT_EIN

Withholding Foreign Trust Employer Identification Number.

profile_details.business_addressobject

Business address in the US. Applicable when type is W_8_ECI.

profile_details.business_address.address_line1string

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.

profile_details.business_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.business_address.country_namestring

Country name.

profile_details.business_address.postcodestring

Postcode or zip code.

profile_details.business_address.statestring

Name of state.

profile_details.business_address.suburbstring

Name of city / suburb.

profile_details.business_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.business_address.state_codestring

2-letter state code.

profile_details.business_namestring

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.

profile_details.countrystring

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.

profile_details.current_non_immigrant_statusstring

Current nonimmigrant status in the US. Applicable when type is 8233.

profile_details.current_non_immigrant_status_expiry_datestring

Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.

profile_details.date_of_birthstring

Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.

profile_details.disregarded_entity_namestring

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.

profile_details.entity_typestring

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.

PARTNERSHIP

Partnership. Applicable to Form W-8BEN-E or W-8ECI

CORPORATION

Corporation. Applicable to Form W-8BEN-E or W-8ECI

SIMPLE_TRUST

Simple trust. Applicable to Form W-8BEN-E or W-8ECI

TAX_EXEMPT_ORGANIZATION

Tax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI

COMPLEX_TRUST

Complex trust. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_CONTROLLED_ENTITY

Entity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI

CENTRAL_BANK_OF_ISSUE

Central bank of issue. Applicable to Form W-8BEN-E or W-8ECI

PRIVATE_FOUNDATION

Private foundation. Applicable to Form W-8BEN-E or W-8ECI

ESTATE

Estate. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_INTEGRAL_PART

Integral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI

GRANTOR_TRUST

Grantor trust. Applicable to Form W-8BEN-E or W-8ECI

DISREGARDED_ENTITY

Disregarded entity. Applicable to Form W-8BEN-E or W-8ECI

INTERNATIONAL_ORGANIZATION

International organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP

FOREIGN_GOVERNMENT

Foreign government. Applicable to Form W-8EXP

FOREIGN_CENTRAL_BANK_OF_ISSUE

Foreign central bank of issue. Applicable to Form W-8EXP

FOREIGN_TAX_EXEMPT_ORGANIZATION

Foreign tax-exempt organization under section 501(c). Applicable to Form W-8EXP

FOREIGN_PRIVATE_FOUNDATION

Foreign private foundation. Applicable to Form W-8EXP

GOVERNMENT_OF_A_US_TERRITORY

Government of a US territory or political subdivision. Applicable to Form W-8EXP

QI

Qualified Intermediary. Applicable to Form W-8IMY

NONQUALIFIED_INTERMEDIARY

Nonqualified intermediary. Applicable to Form W-8IMY

TERRITORY_FINANCIAL_INSTITUTION

Territory financial institution. Applicable to Form W-8IMY

US_BRANCH

US branch. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_PARTNERSHIP

Withholding foreign partnership. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_TRUST

Withholding foreign trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_PARTNERSHIP

Nonwithholding foreign partnership. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_SIMPLE_TRUST

Nonwithholding foreign simple trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_GRANTOR_TRUST

Nonwithholding foreign grantor trust. Applicable to Form W-8IMY

profile_details.entry_to_us_datestring

Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.

profile_details.exempt_from_withholdingboolean

Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.

profile_details.exemption_justificationstring

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.

profile_details.foreign_scholarboolean

Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.

profile_details.foreign_tax_identifierstring

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.

profile_details.has_non_compensatory_incomeboolean

Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.

profile_details.independent_personal_servicesstring

Description of the personal services being provided. Applicable when type is 8233.

profile_details.mailing_addressobject

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.

profile_details.mailing_address.address_line1string

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.

profile_details.mailing_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.mailing_address.country_namestring

Country name.

profile_details.mailing_address.postcodestring

Postcode or zip code.

profile_details.mailing_address.statestring

Name of state.

profile_details.mailing_address.suburbstring

Name of city / suburb.

profile_details.mailing_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.mailing_address.state_codestring

2-letter state code.

profile_details.non_compensatory_exempt_amountstring

Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_tax_articlestring

Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_tax_treatystring

Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_total_incomestring

Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.passport_numberstring

Passport number. Applicable when type is 8233.

profile_details.reference_numberstring

Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.

profile_details.tax_articlestring

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.

profile_details.tax_classificationobject

Federal tax classification. Applicable when type is W_9.

profile_details.tax_classification.typestring

Tax classification.

INDIVIDUAL_OR_SOLE_PROPRIETOR

Individual/sole proprietor or single-member LLC.

C_CORPORATION

C corporation.

S_CORPORATION

S corporation.

PARTNERSHIP

Partnership.

TRUST_OR_ESTATE

Trust or estate.

LLC

Limited liability company. Requires llc_type.

OTHER

Other entity. Specify the tax classification on the applicable form.

profile_details.tax_classification.has_foreign_beneficiariesboolean

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.

profile_details.tax_classification.llc_typestring

Tax classification of the LLC. Applicable when type is LLC.

C

C corporation

S

S corporation

P

Partnership

profile_details.tax_treatystring

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.

profile_details.taxable_income_itemsstring

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.

profile_details.total_compensationstring

Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.

profile_details.total_paid_compensationstring

Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.

profile_details.us_addressobject

Address in the United States. Applicable when type is 8233.

profile_details.us_address.address_line1string

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.

profile_details.us_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.us_address.country_namestring

Country name.

profile_details.us_address.postcodestring

Postcode or zip code.

profile_details.us_address.statestring

Name of state.

profile_details.us_address.suburbstring

Name of city / suburb.

profile_details.us_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.us_address.state_codestring

2-letter state code.

profile_details.visa_typestring

US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.

profile_details.w8_exp_certificationobject

Chapter 3 status specific certifications. Applicable when type is W_8_EXP.

profile_details.w8_exp_certification.controlled_entityboolean

Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.controlling_government_namestring

The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.foreign_central_bank_of_issueboolean

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.

profile_details.w8_exp_certification.foreign_governmentboolean

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.

profile_details.w8_exp_certification.has_irs_determination_letterboolean

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.

profile_details.w8_exp_certification.has_us_counsel_opinionboolean

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.

profile_details.w8_exp_certification.integral_part_government_namestring

The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.integral_part_of_governmentboolean

Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.international_organizationboolean

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.

profile_details.w8_exp_certification.irs_determination_letter_datestring

Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.

profile_details.w8_exp_certification.no_commercial_activityboolean

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.

profile_details.w8_exp_certification.no_us_commercial_activityboolean

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.

profile_details.w8_exp_certification.not_private_foundationboolean

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.

profile_details.w8_exp_certification.private_foundationboolean

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.

profile_details.w8_exp_certification.us_territory_governmentboolean

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.

profile_details.w8_imy_certificationobject

Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.

profile_details.w8_imy_certification.nonqualified_intermediaryobject

Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.

profile_details.w8_imy_certification.nonqualified_intermediary.assumes_primary_withholding_as_qslboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.has_provide_withholding_statementboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.meets_requirements_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.not_acting_as_qiboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.withholding_statement_consistency_verifiedboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entityobject

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.

profile_details.w8_imy_certification.nonwithholding_foreign_entity.acts_on_behalf_of_grantorsboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_provide_modified_amount_statementboolean

Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_receive_amount_from_partnership_transferboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.non_eci_paymentboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.partner_in_lower_tier_partnershipboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.reliable_for_alternative_withholdingboolean

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).

profile_details.w8_imy_certification.qiobject

Certifications for a Qualified Intermediary. Applicable when entity_type is QI.

profile_details.w8_imy_certification.qi.assumes_1099_reporting_for_us_personsboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholdingboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_ptp_nomineeboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_qslboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_ptp_salesboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_us_interestboolean

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).

profile_details.w8_imy_certification.qi.does_not_assume_1099_reportingboolean

Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).

profile_details.w8_imy_certification.qi.has_documentation_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.qi.meets_requirements_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.qi.qdd_statusboolean

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).

profile_details.w8_imy_certification.qi.qi_statusboolean

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).

profile_details.w8_imy_certification.territory_financial_institutionobject

Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.

profile_details.w8_imy_certification.territory_financial_institution.agrees_act_as_nominee_for_ptp_distributionsboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_personboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_person_for_ptp_salesboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.has_provide_withholding_statementboolean

Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).

profile_details.w8_imy_certification.territory_financial_institution.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).

profile_details.w8_imy_certification.territory_financial_institution.territory_financial_institutionboolean

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).

profile_details.w8_imy_certification.us_branchobject

Certifications for a US Branch. Applicable when entity_type is US_BRANCH.

profile_details.w8_imy_certification.us_branch.agrees_act_as_nominee_for_ptp_distributionsboolean

Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).

profile_details.w8_imy_certification.us_branch.agrees_act_as_us_person_for_ptp_salesboolean

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).

profile_details.w8_imy_certification.us_branch.agrees_treat_as_us_personboolean

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).

profile_details.w8_imy_certification.us_branch.has_provide_withholding_statementboolean

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).

profile_details.w8_imy_certification.us_branch.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).

profile_details.w8_imy_certification.us_branch.us_branchboolean

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).

profile_details.w8_imy_certification.withholding_foreign_entityobject

Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.

profile_details.w8_imy_certification.withholding_foreign_entity.compliance_with_agreementboolean

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).

requirementsobject

Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.

requirements.payer_info_requiredarray

Details about what payer information is incomplete.

requirements.payer_info_required.descriptionstring

A detailed message describing the missing information.

requirements.payer_info_required.typestring

Type of information that is missing or incorrect.

TAX_IDENTIFIER

The payer's tax identifier is missing or incorrect

STATE

The payer's state is missing or incorrect

CITY

The payer's city is missing or incorrect

COUNTRY_CODE

The payer's country code is missing or incorrect

BUSINESS_NAME

The payer's business name is missing or incorrect

PHONE_NUMBER

The payer's phone number is missing or incorrect

signature_namestring

Full legal name of the individual who provided the electronic signature.

statusstring

Status of the tax profile.

SUBMITTED

The tax profile has been submitted and is pending review

REJECTED

The tax profile has been rejected. The reason can be found in failure_reason

ACTION_REQUIRED

Additional information or action is required to continue. Details can be found in requirements

SUPERSEDED

The tax profile version has been replaced by a newer version created through an approved amendment

READY

Profile review passed and the profile is ready to be used for filing

supporting_documentsarray

Additional files uploaded for different supporting purposes.

supporting_documents.file_idstring

The file ID returned when the document was uploaded to the file service.

supporting_documents.tagstring

Purpose of the supporting document. The applicable values depend on the tax form type.

RESIDENCY_PROOF

Supporting document if the address is not in the US. Applicable when the form type is W_9

NON_US_TAX_PROOF

Supporting 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_STATEMENT

Statement of taxable income items. Applicable when the form type is W_8_ECI

WITHHOLDING_CERTIFICATION

Certification 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_STATEMENT

Statement 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_STATEMENT

Statement 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_CONCLUSION

Opinion 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

AFFIDAVIT

Affidavit 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_ATTACHMENT

Statement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true

supporting_documents.descriptionstring

Additional description of the file.

typestring

The type of underlying tax form of the profile.

W_9

Form W-9, for a US person.

W_8_BEN

Form W-8BEN, for a foreign individual.

W_8_BEN_E

Form W-8BEN-E, for a foreign entity.

W_8_ECI

Form W-8ECI, for income effectively connected with a US trade or business.

W_8_EXP

Form W-8EXP, for a foreign government or other exempt organization.

W_8_IMY

Form W-8IMY, for a foreign intermediary or flow-through entity.

8233

Form 8233, for exemption from withholding on compensation of a nonresident alien individual.

updated_atstring

Time when the tax profile was last updated, in ISO 8601 format.

versioninteger

The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.

Errors
Error statusDescription
400

Possible errors: invalid_argument, bad_request

POST /api/v1/beneficiary_tax_profiles/create
$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
> }
>}'
Response (201 Created)
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": true
37 },
38 "created_at": "2026-06-10T08:30:00+0000",
39 "updated_at": "2026-06-10T08:30:00+0000"
40}
Was this section helpful?

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}.

Scoped API key permissions
PayoutsBeneficiary Tax ProfilesRead
On behalf of
Supports x-on-behalf-of header
Path parameters
idrequiredstring

Unique ID of the tax profile.

Response body - 200 OK
created_atstring

Time when the tax profile was created, in ISO 8601 format.

external_idstring

Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.

failure_reasonstring

Additional message if verification failed.

idstring

Unique ID of the tax profile.

profile_detailsobject

Recipient details used to file taxes.

profile_details.addressobject

Address of recipient.

profile_details.address.address_line1string

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.

profile_details.address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.address.country_namestring

Country name.

profile_details.address.postcodestring

Postcode or zip code.

profile_details.address.statestring

Name of state.

profile_details.address.suburbstring

Name of city / suburb.

profile_details.address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.address.state_codestring

2-letter state code.

profile_details.namestring

Name of the individual or organization that is the beneficial owner / intermediary.

profile_details.tax_identifierobject

Taxpayer Identification Number.

profile_details.tax_identifier.numberstring

The Tax Identification number.

profile_details.tax_identifier.typestring

Type of Tax Identification.

SSN

Social Security Number.

EIN

Employer Identification Number.

ITIN

Individual Taxpayer Identification Number.

QI_EIN

Qualified Intermediary Employer Identification Number.

WP_EIN

Withholding Foreign Partnership Employer Identification Number.

WT_EIN

Withholding Foreign Trust Employer Identification Number.

profile_details.business_addressobject

Business address in the US. Applicable when type is W_8_ECI.

profile_details.business_address.address_line1string

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.

profile_details.business_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.business_address.country_namestring

Country name.

profile_details.business_address.postcodestring

Postcode or zip code.

profile_details.business_address.statestring

Name of state.

profile_details.business_address.suburbstring

Name of city / suburb.

profile_details.business_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.business_address.state_codestring

2-letter state code.

profile_details.business_namestring

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.

profile_details.countrystring

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.

profile_details.current_non_immigrant_statusstring

Current nonimmigrant status in the US. Applicable when type is 8233.

profile_details.current_non_immigrant_status_expiry_datestring

Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.

profile_details.date_of_birthstring

Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.

profile_details.disregarded_entity_namestring

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.

profile_details.entity_typestring

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.

PARTNERSHIP

Partnership. Applicable to Form W-8BEN-E or W-8ECI

CORPORATION

Corporation. Applicable to Form W-8BEN-E or W-8ECI

SIMPLE_TRUST

Simple trust. Applicable to Form W-8BEN-E or W-8ECI

TAX_EXEMPT_ORGANIZATION

Tax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI

COMPLEX_TRUST

Complex trust. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_CONTROLLED_ENTITY

Entity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI

CENTRAL_BANK_OF_ISSUE

Central bank of issue. Applicable to Form W-8BEN-E or W-8ECI

PRIVATE_FOUNDATION

Private foundation. Applicable to Form W-8BEN-E or W-8ECI

ESTATE

Estate. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_INTEGRAL_PART

Integral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI

GRANTOR_TRUST

Grantor trust. Applicable to Form W-8BEN-E or W-8ECI

DISREGARDED_ENTITY

Disregarded entity. Applicable to Form W-8BEN-E or W-8ECI

INTERNATIONAL_ORGANIZATION

International organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP

FOREIGN_GOVERNMENT

Foreign government. Applicable to Form W-8EXP

FOREIGN_CENTRAL_BANK_OF_ISSUE

Foreign central bank of issue. Applicable to Form W-8EXP

FOREIGN_TAX_EXEMPT_ORGANIZATION

Foreign tax-exempt organization under section 501(c). Applicable to Form W-8EXP

FOREIGN_PRIVATE_FOUNDATION

Foreign private foundation. Applicable to Form W-8EXP

GOVERNMENT_OF_A_US_TERRITORY

Government of a US territory or political subdivision. Applicable to Form W-8EXP

QI

Qualified Intermediary. Applicable to Form W-8IMY

NONQUALIFIED_INTERMEDIARY

Nonqualified intermediary. Applicable to Form W-8IMY

TERRITORY_FINANCIAL_INSTITUTION

Territory financial institution. Applicable to Form W-8IMY

US_BRANCH

US branch. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_PARTNERSHIP

Withholding foreign partnership. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_TRUST

Withholding foreign trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_PARTNERSHIP

Nonwithholding foreign partnership. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_SIMPLE_TRUST

Nonwithholding foreign simple trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_GRANTOR_TRUST

Nonwithholding foreign grantor trust. Applicable to Form W-8IMY

profile_details.entry_to_us_datestring

Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.

profile_details.exempt_from_withholdingboolean

Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.

profile_details.exemption_justificationstring

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.

profile_details.foreign_scholarboolean

Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.

profile_details.foreign_tax_identifierstring

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.

profile_details.has_non_compensatory_incomeboolean

Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.

profile_details.independent_personal_servicesstring

Description of the personal services being provided. Applicable when type is 8233.

profile_details.mailing_addressobject

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.

profile_details.mailing_address.address_line1string

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.

profile_details.mailing_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.mailing_address.country_namestring

Country name.

profile_details.mailing_address.postcodestring

Postcode or zip code.

profile_details.mailing_address.statestring

Name of state.

profile_details.mailing_address.suburbstring

Name of city / suburb.

profile_details.mailing_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.mailing_address.state_codestring

2-letter state code.

profile_details.non_compensatory_exempt_amountstring

Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_tax_articlestring

Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_tax_treatystring

Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_total_incomestring

Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.passport_numberstring

Passport number. Applicable when type is 8233.

profile_details.reference_numberstring

Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.

profile_details.tax_articlestring

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.

profile_details.tax_classificationobject

Federal tax classification. Applicable when type is W_9.

profile_details.tax_classification.typestring

Tax classification.

INDIVIDUAL_OR_SOLE_PROPRIETOR

Individual/sole proprietor or single-member LLC.

C_CORPORATION

C corporation.

S_CORPORATION

S corporation.

PARTNERSHIP

Partnership.

TRUST_OR_ESTATE

Trust or estate.

LLC

Limited liability company. Requires llc_type.

OTHER

Other entity. Specify the tax classification on the applicable form.

profile_details.tax_classification.has_foreign_beneficiariesboolean

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.

profile_details.tax_classification.llc_typestring

Tax classification of the LLC. Applicable when type is LLC.

C

C corporation

S

S corporation

P

Partnership

profile_details.tax_treatystring

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.

profile_details.taxable_income_itemsstring

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.

profile_details.total_compensationstring

Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.

profile_details.total_paid_compensationstring

Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.

profile_details.us_addressobject

Address in the United States. Applicable when type is 8233.

profile_details.us_address.address_line1string

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.

profile_details.us_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.us_address.country_namestring

Country name.

profile_details.us_address.postcodestring

Postcode or zip code.

profile_details.us_address.statestring

Name of state.

profile_details.us_address.suburbstring

Name of city / suburb.

profile_details.us_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.us_address.state_codestring

2-letter state code.

profile_details.visa_typestring

US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.

profile_details.w8_exp_certificationobject

Chapter 3 status specific certifications. Applicable when type is W_8_EXP.

profile_details.w8_exp_certification.controlled_entityboolean

Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.controlling_government_namestring

The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.foreign_central_bank_of_issueboolean

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.

profile_details.w8_exp_certification.foreign_governmentboolean

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.

profile_details.w8_exp_certification.has_irs_determination_letterboolean

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.

profile_details.w8_exp_certification.has_us_counsel_opinionboolean

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.

profile_details.w8_exp_certification.integral_part_government_namestring

The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.integral_part_of_governmentboolean

Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.international_organizationboolean

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.

profile_details.w8_exp_certification.irs_determination_letter_datestring

Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.

profile_details.w8_exp_certification.no_commercial_activityboolean

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.

profile_details.w8_exp_certification.no_us_commercial_activityboolean

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.

profile_details.w8_exp_certification.not_private_foundationboolean

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.

profile_details.w8_exp_certification.private_foundationboolean

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.

profile_details.w8_exp_certification.us_territory_governmentboolean

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.

profile_details.w8_imy_certificationobject

Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.

profile_details.w8_imy_certification.nonqualified_intermediaryobject

Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.

profile_details.w8_imy_certification.nonqualified_intermediary.assumes_primary_withholding_as_qslboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.has_provide_withholding_statementboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.meets_requirements_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.not_acting_as_qiboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.withholding_statement_consistency_verifiedboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entityobject

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.

profile_details.w8_imy_certification.nonwithholding_foreign_entity.acts_on_behalf_of_grantorsboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_provide_modified_amount_statementboolean

Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_receive_amount_from_partnership_transferboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.non_eci_paymentboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.partner_in_lower_tier_partnershipboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.reliable_for_alternative_withholdingboolean

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).

profile_details.w8_imy_certification.qiobject

Certifications for a Qualified Intermediary. Applicable when entity_type is QI.

profile_details.w8_imy_certification.qi.assumes_1099_reporting_for_us_personsboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholdingboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_ptp_nomineeboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_qslboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_ptp_salesboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_us_interestboolean

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).

profile_details.w8_imy_certification.qi.does_not_assume_1099_reportingboolean

Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).

profile_details.w8_imy_certification.qi.has_documentation_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.qi.meets_requirements_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.qi.qdd_statusboolean

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).

profile_details.w8_imy_certification.qi.qi_statusboolean

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).

profile_details.w8_imy_certification.territory_financial_institutionobject

Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.

profile_details.w8_imy_certification.territory_financial_institution.agrees_act_as_nominee_for_ptp_distributionsboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_personboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_person_for_ptp_salesboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.has_provide_withholding_statementboolean

Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).

profile_details.w8_imy_certification.territory_financial_institution.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).

profile_details.w8_imy_certification.territory_financial_institution.territory_financial_institutionboolean

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).

profile_details.w8_imy_certification.us_branchobject

Certifications for a US Branch. Applicable when entity_type is US_BRANCH.

profile_details.w8_imy_certification.us_branch.agrees_act_as_nominee_for_ptp_distributionsboolean

Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).

profile_details.w8_imy_certification.us_branch.agrees_act_as_us_person_for_ptp_salesboolean

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).

profile_details.w8_imy_certification.us_branch.agrees_treat_as_us_personboolean

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).

profile_details.w8_imy_certification.us_branch.has_provide_withholding_statementboolean

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).

profile_details.w8_imy_certification.us_branch.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).

profile_details.w8_imy_certification.us_branch.us_branchboolean

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).

profile_details.w8_imy_certification.withholding_foreign_entityobject

Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.

profile_details.w8_imy_certification.withholding_foreign_entity.compliance_with_agreementboolean

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).

requirementsobject

Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.

requirements.payer_info_requiredarray

Details about what payer information is incomplete.

requirements.payer_info_required.descriptionstring

A detailed message describing the missing information.

requirements.payer_info_required.typestring

Type of information that is missing or incorrect.

TAX_IDENTIFIER

The payer's tax identifier is missing or incorrect

STATE

The payer's state is missing or incorrect

CITY

The payer's city is missing or incorrect

COUNTRY_CODE

The payer's country code is missing or incorrect

BUSINESS_NAME

The payer's business name is missing or incorrect

PHONE_NUMBER

The payer's phone number is missing or incorrect

signature_namestring

Full legal name of the individual who provided the electronic signature.

statusstring

Status of the tax profile.

SUBMITTED

The tax profile has been submitted and is pending review

REJECTED

The tax profile has been rejected. The reason can be found in failure_reason

ACTION_REQUIRED

Additional information or action is required to continue. Details can be found in requirements

SUPERSEDED

The tax profile version has been replaced by a newer version created through an approved amendment

READY

Profile review passed and the profile is ready to be used for filing

supporting_documentsarray

Additional files uploaded for different supporting purposes.

supporting_documents.file_idstring

The file ID returned when the document was uploaded to the file service.

supporting_documents.tagstring

Purpose of the supporting document. The applicable values depend on the tax form type.

RESIDENCY_PROOF

Supporting document if the address is not in the US. Applicable when the form type is W_9

NON_US_TAX_PROOF

Supporting 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_STATEMENT

Statement of taxable income items. Applicable when the form type is W_8_ECI

WITHHOLDING_CERTIFICATION

Certification 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_STATEMENT

Statement 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_STATEMENT

Statement 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_CONCLUSION

Opinion 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

AFFIDAVIT

Affidavit 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_ATTACHMENT

Statement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true

supporting_documents.descriptionstring

Additional description of the file.

typestring

The type of underlying tax form of the profile.

W_9

Form W-9, for a US person.

W_8_BEN

Form W-8BEN, for a foreign individual.

W_8_BEN_E

Form W-8BEN-E, for a foreign entity.

W_8_ECI

Form W-8ECI, for income effectively connected with a US trade or business.

W_8_EXP

Form W-8EXP, for a foreign government or other exempt organization.

W_8_IMY

Form W-8IMY, for a foreign intermediary or flow-through entity.

8233

Form 8233, for exemption from withholding on compensation of a nonresident alien individual.

updated_atstring

Time when the tax profile was last updated, in ISO 8601 format.

versioninteger

The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.

Errors
Error statusDescription
400

Possible errors: invalid_argument, bad_request

404

Possible errors: not_found

GET /api/v1/beneficiary_tax_profiles/{id}
$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'
Response (200 OK)
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": true
37 },
38 "created_at": "2026-06-10T08:30:00+0000",
39 "updated_at": "2026-06-10T09:15:00+0000"
40}
Was this section helpful?

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.

Scoped API key permissions
PayoutsBeneficiary Tax ProfilesRead
On behalf of
Supports x-on-behalf-of header
Query parameters
external_idstring

Filter by the unique identifier of a recipient.

from_created_atstring

The start date of created_at in ISO 8601 format (inclusive).

pagestring

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.

page_sizeinteger

Number of results per page. Defaults to 100, minimum 10, maximum 200.

statusstring

Filter by beneficiary tax profile status.

SUBMITTED

The tax profile has been submitted and is pending review

REJECTED

The tax profile has been rejected. The reason can be found in failure_reason

ACTION_REQUIRED

Additional information or action is required to continue. Details can be found in requirements

SUPERSEDED

The tax profile version has been replaced by a newer version created through an approved amendment

READY

Profile review passed and the profile is ready to be used for filing

to_created_atstring

The end date of created_at in ISO 8601 format (inclusive).

typestring

Filter by tax form type.

W_9

Form W-9, for a US person.

W_8_BEN

Form W-8BEN, for a foreign individual.

W_8_BEN_E

Form W-8BEN-E, for a foreign entity.

W_8_ECI

Form W-8ECI, for income effectively connected with a US trade or business.

W_8_EXP

Form W-8EXP, for a foreign government or other exempt organization.

W_8_IMY

Form W-8IMY, for a foreign intermediary or flow-through entity.

8233

Form 8233, for exemption from withholding on compensation of a nonresident alien individual.

Response body - 200 OK
itemsarray

An array of paged results.

items.external_idstring

Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.

items.idstring

Unique ID of the tax profile.

items.statusstring

Status of the tax profile.

SUBMITTED

The tax profile has been submitted and is pending review

REJECTED

The tax profile has been rejected. The reason can be found in failure_reason

ACTION_REQUIRED

Additional information or action is required to continue. Details can be found in requirements

SUPERSEDED

The tax profile version has been replaced by a newer version created through an approved amendment

READY

Profile review passed and the profile is ready to be used for filing

items.typestring

The type of underlying tax form of the profile.

W_9

Form W-9, for a US person.

W_8_BEN

Form W-8BEN, for a foreign individual.

W_8_BEN_E

Form W-8BEN-E, for a foreign entity.

W_8_ECI

Form W-8ECI, for income effectively connected with a US trade or business.

W_8_EXP

Form W-8EXP, for a foreign government or other exempt organization.

W_8_IMY

Form W-8IMY, for a foreign intermediary or flow-through entity.

8233

Form 8233, for exemption from withholding on compensation of a nonresident alien individual.

items.versioninteger

The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.

items.created_atstring

Time when the tax profile was created, in ISO 8601 format.

items.failure_reasonstring

Additional message if verification failed.

items.profile_detailsobject

Recipient details used to file taxes.

items.profile_details.addressobject

Address of recipient.

items.profile_details.address.address_line1string

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.

items.profile_details.address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

items.profile_details.address.country_namestring

Country name.

items.profile_details.address.postcodestring

Postcode or zip code.

items.profile_details.address.statestring

Name of state.

items.profile_details.address.suburbstring

Name of city / suburb.

items.profile_details.address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

items.profile_details.address.state_codestring

2-letter state code.

items.profile_details.namestring

Name of the individual or organization that is the beneficial owner / intermediary.

items.profile_details.tax_identifierobject

Taxpayer Identification Number.

items.profile_details.tax_identifier.numberstring

The Tax Identification number.

items.profile_details.tax_identifier.typestring

Type of Tax Identification.

SSN

Social Security Number.

EIN

Employer Identification Number.

ITIN

Individual Taxpayer Identification Number.

QI_EIN

Qualified Intermediary Employer Identification Number.

WP_EIN

Withholding Foreign Partnership Employer Identification Number.

WT_EIN

Withholding Foreign Trust Employer Identification Number.

items.profile_details.business_addressobject

Business address in the US. Applicable when type is W_8_ECI.

items.profile_details.business_address.address_line1string

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.

items.profile_details.business_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

items.profile_details.business_address.country_namestring

Country name.

items.profile_details.business_address.postcodestring

Postcode or zip code.

items.profile_details.business_address.statestring

Name of state.

items.profile_details.business_address.suburbstring

Name of city / suburb.

items.profile_details.business_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

items.profile_details.business_address.state_codestring

2-letter state code.

items.profile_details.business_namestring

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.

items.profile_details.countrystring

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.

items.profile_details.current_non_immigrant_statusstring

Current nonimmigrant status in the US. Applicable when type is 8233.

items.profile_details.current_non_immigrant_status_expiry_datestring

Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.

items.profile_details.date_of_birthstring

Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.

items.profile_details.disregarded_entity_namestring

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.

items.profile_details.entity_typestring

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.

PARTNERSHIP

Partnership. Applicable to Form W-8BEN-E or W-8ECI

CORPORATION

Corporation. Applicable to Form W-8BEN-E or W-8ECI

SIMPLE_TRUST

Simple trust. Applicable to Form W-8BEN-E or W-8ECI

TAX_EXEMPT_ORGANIZATION

Tax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI

COMPLEX_TRUST

Complex trust. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_CONTROLLED_ENTITY

Entity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI

CENTRAL_BANK_OF_ISSUE

Central bank of issue. Applicable to Form W-8BEN-E or W-8ECI

PRIVATE_FOUNDATION

Private foundation. Applicable to Form W-8BEN-E or W-8ECI

ESTATE

Estate. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_INTEGRAL_PART

Integral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI

GRANTOR_TRUST

Grantor trust. Applicable to Form W-8BEN-E or W-8ECI

DISREGARDED_ENTITY

Disregarded entity. Applicable to Form W-8BEN-E or W-8ECI

INTERNATIONAL_ORGANIZATION

International organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP

FOREIGN_GOVERNMENT

Foreign government. Applicable to Form W-8EXP

FOREIGN_CENTRAL_BANK_OF_ISSUE

Foreign central bank of issue. Applicable to Form W-8EXP

FOREIGN_TAX_EXEMPT_ORGANIZATION

Foreign tax-exempt organization under section 501(c). Applicable to Form W-8EXP

FOREIGN_PRIVATE_FOUNDATION

Foreign private foundation. Applicable to Form W-8EXP

GOVERNMENT_OF_A_US_TERRITORY

Government of a US territory or political subdivision. Applicable to Form W-8EXP

QI

Qualified Intermediary. Applicable to Form W-8IMY

NONQUALIFIED_INTERMEDIARY

Nonqualified intermediary. Applicable to Form W-8IMY

TERRITORY_FINANCIAL_INSTITUTION

Territory financial institution. Applicable to Form W-8IMY

US_BRANCH

US branch. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_PARTNERSHIP

Withholding foreign partnership. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_TRUST

Withholding foreign trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_PARTNERSHIP

Nonwithholding foreign partnership. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_SIMPLE_TRUST

Nonwithholding foreign simple trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_GRANTOR_TRUST

Nonwithholding foreign grantor trust. Applicable to Form W-8IMY

items.profile_details.entry_to_us_datestring

Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.

items.profile_details.exempt_from_withholdingboolean

Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.

items.profile_details.exemption_justificationstring

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.

items.profile_details.foreign_scholarboolean

Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.

items.profile_details.foreign_tax_identifierstring

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.

items.profile_details.has_non_compensatory_incomeboolean

Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.

items.profile_details.independent_personal_servicesstring

Description of the personal services being provided. Applicable when type is 8233.

items.profile_details.mailing_addressobject

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.

items.profile_details.mailing_address.address_line1string

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.

items.profile_details.mailing_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

items.profile_details.mailing_address.country_namestring

Country name.

items.profile_details.mailing_address.postcodestring

Postcode or zip code.

items.profile_details.mailing_address.statestring

Name of state.

items.profile_details.mailing_address.suburbstring

Name of city / suburb.

items.profile_details.mailing_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

items.profile_details.mailing_address.state_codestring

2-letter state code.

items.profile_details.non_compensatory_exempt_amountstring

Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

items.profile_details.non_compensatory_tax_articlestring

Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

items.profile_details.non_compensatory_tax_treatystring

Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

items.profile_details.non_compensatory_total_incomestring

Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

items.profile_details.passport_numberstring

Passport number. Applicable when type is 8233.

items.profile_details.reference_numberstring

Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.

items.profile_details.tax_articlestring

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.

items.profile_details.tax_classificationobject

Federal tax classification. Applicable when type is W_9.

items.profile_details.tax_classification.typestring

Tax classification.

INDIVIDUAL_OR_SOLE_PROPRIETOR

Individual/sole proprietor or single-member LLC.

C_CORPORATION

C corporation.

S_CORPORATION

S corporation.

PARTNERSHIP

Partnership.

TRUST_OR_ESTATE

Trust or estate.

LLC

Limited liability company. Requires llc_type.

OTHER

Other entity. Specify the tax classification on the applicable form.

items.profile_details.tax_classification.has_foreign_beneficiariesboolean

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.

items.profile_details.tax_classification.llc_typestring

Tax classification of the LLC. Applicable when type is LLC.

C

C corporation

S

S corporation

P

Partnership

items.profile_details.tax_treatystring

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.profile_details.taxable_income_itemsstring

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.

items.profile_details.total_compensationstring

Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.

items.profile_details.total_paid_compensationstring

Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.

items.profile_details.us_addressobject

Address in the United States. Applicable when type is 8233.

items.profile_details.us_address.address_line1string

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.

items.profile_details.us_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

items.profile_details.us_address.country_namestring

Country name.

items.profile_details.us_address.postcodestring

Postcode or zip code.

items.profile_details.us_address.statestring

Name of state.

items.profile_details.us_address.suburbstring

Name of city / suburb.

items.profile_details.us_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

items.profile_details.us_address.state_codestring

2-letter state code.

items.profile_details.visa_typestring

US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.

items.profile_details.w8_exp_certificationobject

Chapter 3 status specific certifications. Applicable when type is W_8_EXP.

items.profile_details.w8_exp_certification.controlled_entityboolean

Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

items.profile_details.w8_exp_certification.controlling_government_namestring

The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

items.profile_details.w8_exp_certification.foreign_central_bank_of_issueboolean

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.

items.profile_details.w8_exp_certification.foreign_governmentboolean

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.

items.profile_details.w8_exp_certification.has_irs_determination_letterboolean

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.

items.profile_details.w8_exp_certification.has_us_counsel_opinionboolean

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.

items.profile_details.w8_exp_certification.integral_part_government_namestring

The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

items.profile_details.w8_exp_certification.integral_part_of_governmentboolean

Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

items.profile_details.w8_exp_certification.international_organizationboolean

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.

items.profile_details.w8_exp_certification.irs_determination_letter_datestring

Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.

items.profile_details.w8_exp_certification.no_commercial_activityboolean

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.

items.profile_details.w8_exp_certification.no_us_commercial_activityboolean

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.

items.profile_details.w8_exp_certification.not_private_foundationboolean

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.

items.profile_details.w8_exp_certification.private_foundationboolean

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.

items.profile_details.w8_exp_certification.us_territory_governmentboolean

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.

items.profile_details.w8_imy_certificationobject

Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.

items.profile_details.w8_imy_certification.nonqualified_intermediaryobject

Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.

items.profile_details.w8_imy_certification.nonqualified_intermediary.assumes_primary_withholding_as_qslboolean

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).

items.profile_details.w8_imy_certification.nonqualified_intermediary.has_provide_withholding_statementboolean

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).

items.profile_details.w8_imy_certification.nonqualified_intermediary.meets_requirements_for_us_payee_poolboolean

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).

items.profile_details.w8_imy_certification.nonqualified_intermediary.not_acting_as_qiboolean

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).

items.profile_details.w8_imy_certification.nonqualified_intermediary.withholding_statement_consistency_verifiedboolean

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).

items.profile_details.w8_imy_certification.nonwithholding_foreign_entityobject

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.

items.profile_details.w8_imy_certification.nonwithholding_foreign_entity.acts_on_behalf_of_grantorsboolean

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).

items.profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_provide_modified_amount_statementboolean

Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).

items.profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_receive_amount_from_partnership_transferboolean

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).

items.profile_details.w8_imy_certification.nonwithholding_foreign_entity.non_eci_paymentboolean

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).

items.profile_details.w8_imy_certification.nonwithholding_foreign_entity.partner_in_lower_tier_partnershipboolean

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).

items.profile_details.w8_imy_certification.nonwithholding_foreign_entity.reliable_for_alternative_withholdingboolean

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).

items.profile_details.w8_imy_certification.qiobject

Certifications for a Qualified Intermediary. Applicable when entity_type is QI.

items.profile_details.w8_imy_certification.qi.assumes_1099_reporting_for_us_personsboolean

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).

items.profile_details.w8_imy_certification.qi.assumes_primary_withholdingboolean

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).

items.profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_ptp_nomineeboolean

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).

items.profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_qslboolean

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).

items.profile_details.w8_imy_certification.qi.assumes_primary_withholding_ptp_salesboolean

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).

items.profile_details.w8_imy_certification.qi.assumes_primary_withholding_us_interestboolean

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).

items.profile_details.w8_imy_certification.qi.does_not_assume_1099_reportingboolean

Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).

items.profile_details.w8_imy_certification.qi.has_documentation_for_us_payee_poolboolean

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).

items.profile_details.w8_imy_certification.qi.meets_requirements_for_us_payee_poolboolean

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).

items.profile_details.w8_imy_certification.qi.qdd_statusboolean

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).

items.profile_details.w8_imy_certification.qi.qi_statusboolean

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).

items.profile_details.w8_imy_certification.territory_financial_institutionobject

Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.

items.profile_details.w8_imy_certification.territory_financial_institution.agrees_act_as_nominee_for_ptp_distributionsboolean

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).

items.profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_personboolean

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).

items.profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_person_for_ptp_salesboolean

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).

items.profile_details.w8_imy_certification.territory_financial_institution.has_provide_withholding_statementboolean

Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).

items.profile_details.w8_imy_certification.territory_financial_institution.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).

items.profile_details.w8_imy_certification.territory_financial_institution.territory_financial_institutionboolean

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).

items.profile_details.w8_imy_certification.us_branchobject

Certifications for a US Branch. Applicable when entity_type is US_BRANCH.

items.profile_details.w8_imy_certification.us_branch.agrees_act_as_nominee_for_ptp_distributionsboolean

Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).

items.profile_details.w8_imy_certification.us_branch.agrees_act_as_us_person_for_ptp_salesboolean

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).

items.profile_details.w8_imy_certification.us_branch.agrees_treat_as_us_personboolean

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).

items.profile_details.w8_imy_certification.us_branch.has_provide_withholding_statementboolean

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).

items.profile_details.w8_imy_certification.us_branch.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).

items.profile_details.w8_imy_certification.us_branch.us_branchboolean

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).

items.profile_details.w8_imy_certification.withholding_foreign_entityobject

Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.

items.profile_details.w8_imy_certification.withholding_foreign_entity.compliance_with_agreementboolean

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).

items.requirementsobject

Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.

items.requirements.payer_info_requiredarray

Details about what payer information is incomplete.

items.requirements.payer_info_required.descriptionstring

A detailed message describing the missing information.

items.requirements.payer_info_required.typestring

Type of information that is missing or incorrect.

TAX_IDENTIFIER

The payer's tax identifier is missing or incorrect

STATE

The payer's state is missing or incorrect

CITY

The payer's city is missing or incorrect

COUNTRY_CODE

The payer's country code is missing or incorrect

BUSINESS_NAME

The payer's business name is missing or incorrect

PHONE_NUMBER

The payer's phone number is missing or incorrect

items.signature_namestring

Full legal name of the individual who provided the electronic signature.

items.supporting_documentsarray

Additional files uploaded for different supporting purposes.

items.supporting_documents.file_idstring

The file ID returned when the document was uploaded to the file service.

items.supporting_documents.tagstring

Purpose of the supporting document. The applicable values depend on the tax form type.

RESIDENCY_PROOF

Supporting document if the address is not in the US. Applicable when the form type is W_9

NON_US_TAX_PROOF

Supporting 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_STATEMENT

Statement of taxable income items. Applicable when the form type is W_8_ECI

WITHHOLDING_CERTIFICATION

Certification 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_STATEMENT

Statement 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_STATEMENT

Statement 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_CONCLUSION

Opinion 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

AFFIDAVIT

Affidavit 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_ATTACHMENT

Statement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true

items.supporting_documents.descriptionstring

Additional description of the file.

items.updated_atstring

Time when the tax profile was last updated, in ISO 8601 format.

page_afterstring

The cursor for the next page of results. Pass this value as page in a subsequent request. null if there are no more results.

page_beforestring

The cursor for the previous page of results. Pass this value as page in a subsequent request. null if there are no previous results.

Errors
Error statusDescription
400

Possible errors: invalid_argument, bad_request

GET /api/v1/beneficiary_tax_profiles
$curl --request GET \
> --url 'https://api.sandbox.airwallex.com/api/v1/beneficiary_tax_profiles' \
> --header 'Authorization: Bearer <token>' \
> --header 'Content-Type: application/json'
Response (200 OK)
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": true
32 },
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}
Was this section helpful?

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.

Scoped API key permissions
PayoutsBeneficiary Tax ProfilesRead
On behalf of
Supports x-on-behalf-of header
Path parameters
idrequiredstring

Unique ID of the tax profile.

Response body - 200 OK
download_urlstring

URL that can be used to retrieve the file. This URL expires shortly after it is generated.

expires_atstring

Download URL expiry timestamp, in ISO 8601 format.

Errors
Error statusDescription
400

Possible errors: invalid_argument, bad_request

404

Possible errors: not_found

POST /api/v1/beneficiary_tax_profiles/{id}/download
$curl --request POST \
> --url 'https://api.sandbox.airwallex.com/api/v1/beneficiary_tax_profiles/txf-1a2b3c4d5e6f/download' \
> --header 'Authorization: Bearer <token>'
Response (200 OK)
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}
Was this section helpful?

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.

Scoped API key permissions
PayoutsBeneficiary Tax ProfilesRead
On behalf of
Supports x-on-behalf-of header
Path parameters
idrequiredstring

Unique ID of the tax profile.

versionrequiredinteger

Exact tax profile version to retrieve.

Response body - 200 OK
created_atstring

Time when the tax profile was created, in ISO 8601 format.

external_idstring

Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.

failure_reasonstring

Additional message if verification failed.

idstring

Unique ID of the tax profile.

profile_detailsobject

Recipient details used to file taxes.

profile_details.addressobject

Address of recipient.

profile_details.address.address_line1string

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.

profile_details.address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.address.country_namestring

Country name.

profile_details.address.postcodestring

Postcode or zip code.

profile_details.address.statestring

Name of state.

profile_details.address.suburbstring

Name of city / suburb.

profile_details.address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.address.state_codestring

2-letter state code.

profile_details.namestring

Name of the individual or organization that is the beneficial owner / intermediary.

profile_details.tax_identifierobject

Taxpayer Identification Number.

profile_details.tax_identifier.numberstring

The Tax Identification number.

profile_details.tax_identifier.typestring

Type of Tax Identification.

SSN

Social Security Number.

EIN

Employer Identification Number.

ITIN

Individual Taxpayer Identification Number.

QI_EIN

Qualified Intermediary Employer Identification Number.

WP_EIN

Withholding Foreign Partnership Employer Identification Number.

WT_EIN

Withholding Foreign Trust Employer Identification Number.

profile_details.business_addressobject

Business address in the US. Applicable when type is W_8_ECI.

profile_details.business_address.address_line1string

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.

profile_details.business_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.business_address.country_namestring

Country name.

profile_details.business_address.postcodestring

Postcode or zip code.

profile_details.business_address.statestring

Name of state.

profile_details.business_address.suburbstring

Name of city / suburb.

profile_details.business_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.business_address.state_codestring

2-letter state code.

profile_details.business_namestring

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.

profile_details.countrystring

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.

profile_details.current_non_immigrant_statusstring

Current nonimmigrant status in the US. Applicable when type is 8233.

profile_details.current_non_immigrant_status_expiry_datestring

Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.

profile_details.date_of_birthstring

Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.

profile_details.disregarded_entity_namestring

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.

profile_details.entity_typestring

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.

PARTNERSHIP

Partnership. Applicable to Form W-8BEN-E or W-8ECI

CORPORATION

Corporation. Applicable to Form W-8BEN-E or W-8ECI

SIMPLE_TRUST

Simple trust. Applicable to Form W-8BEN-E or W-8ECI

TAX_EXEMPT_ORGANIZATION

Tax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI

COMPLEX_TRUST

Complex trust. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_CONTROLLED_ENTITY

Entity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI

CENTRAL_BANK_OF_ISSUE

Central bank of issue. Applicable to Form W-8BEN-E or W-8ECI

PRIVATE_FOUNDATION

Private foundation. Applicable to Form W-8BEN-E or W-8ECI

ESTATE

Estate. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_INTEGRAL_PART

Integral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI

GRANTOR_TRUST

Grantor trust. Applicable to Form W-8BEN-E or W-8ECI

DISREGARDED_ENTITY

Disregarded entity. Applicable to Form W-8BEN-E or W-8ECI

INTERNATIONAL_ORGANIZATION

International organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP

FOREIGN_GOVERNMENT

Foreign government. Applicable to Form W-8EXP

FOREIGN_CENTRAL_BANK_OF_ISSUE

Foreign central bank of issue. Applicable to Form W-8EXP

FOREIGN_TAX_EXEMPT_ORGANIZATION

Foreign tax-exempt organization under section 501(c). Applicable to Form W-8EXP

FOREIGN_PRIVATE_FOUNDATION

Foreign private foundation. Applicable to Form W-8EXP

GOVERNMENT_OF_A_US_TERRITORY

Government of a US territory or political subdivision. Applicable to Form W-8EXP

QI

Qualified Intermediary. Applicable to Form W-8IMY

NONQUALIFIED_INTERMEDIARY

Nonqualified intermediary. Applicable to Form W-8IMY

TERRITORY_FINANCIAL_INSTITUTION

Territory financial institution. Applicable to Form W-8IMY

US_BRANCH

US branch. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_PARTNERSHIP

Withholding foreign partnership. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_TRUST

Withholding foreign trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_PARTNERSHIP

Nonwithholding foreign partnership. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_SIMPLE_TRUST

Nonwithholding foreign simple trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_GRANTOR_TRUST

Nonwithholding foreign grantor trust. Applicable to Form W-8IMY

profile_details.entry_to_us_datestring

Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.

profile_details.exempt_from_withholdingboolean

Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.

profile_details.exemption_justificationstring

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.

profile_details.foreign_scholarboolean

Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.

profile_details.foreign_tax_identifierstring

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.

profile_details.has_non_compensatory_incomeboolean

Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.

profile_details.independent_personal_servicesstring

Description of the personal services being provided. Applicable when type is 8233.

profile_details.mailing_addressobject

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.

profile_details.mailing_address.address_line1string

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.

profile_details.mailing_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.mailing_address.country_namestring

Country name.

profile_details.mailing_address.postcodestring

Postcode or zip code.

profile_details.mailing_address.statestring

Name of state.

profile_details.mailing_address.suburbstring

Name of city / suburb.

profile_details.mailing_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.mailing_address.state_codestring

2-letter state code.

profile_details.non_compensatory_exempt_amountstring

Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_tax_articlestring

Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_tax_treatystring

Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_total_incomestring

Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.passport_numberstring

Passport number. Applicable when type is 8233.

profile_details.reference_numberstring

Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.

profile_details.tax_articlestring

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.

profile_details.tax_classificationobject

Federal tax classification. Applicable when type is W_9.

profile_details.tax_classification.typestring

Tax classification.

INDIVIDUAL_OR_SOLE_PROPRIETOR

Individual/sole proprietor or single-member LLC.

C_CORPORATION

C corporation.

S_CORPORATION

S corporation.

PARTNERSHIP

Partnership.

TRUST_OR_ESTATE

Trust or estate.

LLC

Limited liability company. Requires llc_type.

OTHER

Other entity. Specify the tax classification on the applicable form.

profile_details.tax_classification.has_foreign_beneficiariesboolean

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.

profile_details.tax_classification.llc_typestring

Tax classification of the LLC. Applicable when type is LLC.

C

C corporation

S

S corporation

P

Partnership

profile_details.tax_treatystring

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.

profile_details.taxable_income_itemsstring

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.

profile_details.total_compensationstring

Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.

profile_details.total_paid_compensationstring

Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.

profile_details.us_addressobject

Address in the United States. Applicable when type is 8233.

profile_details.us_address.address_line1string

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.

profile_details.us_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.us_address.country_namestring

Country name.

profile_details.us_address.postcodestring

Postcode or zip code.

profile_details.us_address.statestring

Name of state.

profile_details.us_address.suburbstring

Name of city / suburb.

profile_details.us_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.us_address.state_codestring

2-letter state code.

profile_details.visa_typestring

US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.

profile_details.w8_exp_certificationobject

Chapter 3 status specific certifications. Applicable when type is W_8_EXP.

profile_details.w8_exp_certification.controlled_entityboolean

Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.controlling_government_namestring

The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.foreign_central_bank_of_issueboolean

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.

profile_details.w8_exp_certification.foreign_governmentboolean

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.

profile_details.w8_exp_certification.has_irs_determination_letterboolean

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.

profile_details.w8_exp_certification.has_us_counsel_opinionboolean

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.

profile_details.w8_exp_certification.integral_part_government_namestring

The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.integral_part_of_governmentboolean

Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.international_organizationboolean

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.

profile_details.w8_exp_certification.irs_determination_letter_datestring

Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.

profile_details.w8_exp_certification.no_commercial_activityboolean

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.

profile_details.w8_exp_certification.no_us_commercial_activityboolean

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.

profile_details.w8_exp_certification.not_private_foundationboolean

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.

profile_details.w8_exp_certification.private_foundationboolean

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.

profile_details.w8_exp_certification.us_territory_governmentboolean

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.

profile_details.w8_imy_certificationobject

Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.

profile_details.w8_imy_certification.nonqualified_intermediaryobject

Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.

profile_details.w8_imy_certification.nonqualified_intermediary.assumes_primary_withholding_as_qslboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.has_provide_withholding_statementboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.meets_requirements_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.not_acting_as_qiboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.withholding_statement_consistency_verifiedboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entityobject

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.

profile_details.w8_imy_certification.nonwithholding_foreign_entity.acts_on_behalf_of_grantorsboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_provide_modified_amount_statementboolean

Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_receive_amount_from_partnership_transferboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.non_eci_paymentboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.partner_in_lower_tier_partnershipboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.reliable_for_alternative_withholdingboolean

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).

profile_details.w8_imy_certification.qiobject

Certifications for a Qualified Intermediary. Applicable when entity_type is QI.

profile_details.w8_imy_certification.qi.assumes_1099_reporting_for_us_personsboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholdingboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_ptp_nomineeboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_qslboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_ptp_salesboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_us_interestboolean

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).

profile_details.w8_imy_certification.qi.does_not_assume_1099_reportingboolean

Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).

profile_details.w8_imy_certification.qi.has_documentation_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.qi.meets_requirements_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.qi.qdd_statusboolean

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).

profile_details.w8_imy_certification.qi.qi_statusboolean

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).

profile_details.w8_imy_certification.territory_financial_institutionobject

Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.

profile_details.w8_imy_certification.territory_financial_institution.agrees_act_as_nominee_for_ptp_distributionsboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_personboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_person_for_ptp_salesboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.has_provide_withholding_statementboolean

Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).

profile_details.w8_imy_certification.territory_financial_institution.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).

profile_details.w8_imy_certification.territory_financial_institution.territory_financial_institutionboolean

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).

profile_details.w8_imy_certification.us_branchobject

Certifications for a US Branch. Applicable when entity_type is US_BRANCH.

profile_details.w8_imy_certification.us_branch.agrees_act_as_nominee_for_ptp_distributionsboolean

Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).

profile_details.w8_imy_certification.us_branch.agrees_act_as_us_person_for_ptp_salesboolean

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).

profile_details.w8_imy_certification.us_branch.agrees_treat_as_us_personboolean

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).

profile_details.w8_imy_certification.us_branch.has_provide_withholding_statementboolean

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).

profile_details.w8_imy_certification.us_branch.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).

profile_details.w8_imy_certification.us_branch.us_branchboolean

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).

profile_details.w8_imy_certification.withholding_foreign_entityobject

Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.

profile_details.w8_imy_certification.withholding_foreign_entity.compliance_with_agreementboolean

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).

requirementsobject

Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.

requirements.payer_info_requiredarray

Details about what payer information is incomplete.

requirements.payer_info_required.descriptionstring

A detailed message describing the missing information.

requirements.payer_info_required.typestring

Type of information that is missing or incorrect.

TAX_IDENTIFIER

The payer's tax identifier is missing or incorrect

STATE

The payer's state is missing or incorrect

CITY

The payer's city is missing or incorrect

COUNTRY_CODE

The payer's country code is missing or incorrect

BUSINESS_NAME

The payer's business name is missing or incorrect

PHONE_NUMBER

The payer's phone number is missing or incorrect

signature_namestring

Full legal name of the individual who provided the electronic signature.

statusstring

Status of the tax profile.

SUBMITTED

The tax profile has been submitted and is pending review

REJECTED

The tax profile has been rejected. The reason can be found in failure_reason

ACTION_REQUIRED

Additional information or action is required to continue. Details can be found in requirements

SUPERSEDED

The tax profile version has been replaced by a newer version created through an approved amendment

READY

Profile review passed and the profile is ready to be used for filing

supporting_documentsarray

Additional files uploaded for different supporting purposes.

supporting_documents.file_idstring

The file ID returned when the document was uploaded to the file service.

supporting_documents.tagstring

Purpose of the supporting document. The applicable values depend on the tax form type.

RESIDENCY_PROOF

Supporting document if the address is not in the US. Applicable when the form type is W_9

NON_US_TAX_PROOF

Supporting 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_STATEMENT

Statement of taxable income items. Applicable when the form type is W_8_ECI

WITHHOLDING_CERTIFICATION

Certification 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_STATEMENT

Statement 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_STATEMENT

Statement 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_CONCLUSION

Opinion 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

AFFIDAVIT

Affidavit 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_ATTACHMENT

Statement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true

supporting_documents.descriptionstring

Additional description of the file.

typestring

The type of underlying tax form of the profile.

W_9

Form W-9, for a US person.

W_8_BEN

Form W-8BEN, for a foreign individual.

W_8_BEN_E

Form W-8BEN-E, for a foreign entity.

W_8_ECI

Form W-8ECI, for income effectively connected with a US trade or business.

W_8_EXP

Form W-8EXP, for a foreign government or other exempt organization.

W_8_IMY

Form W-8IMY, for a foreign intermediary or flow-through entity.

8233

Form 8233, for exemption from withholding on compensation of a nonresident alien individual.

updated_atstring

Time when the tax profile was last updated, in ISO 8601 format.

versioninteger

The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.

Errors
Error statusDescription
400

Possible errors: invalid_argument, bad_request

404

Possible errors: not_found

GET /api/v1/beneficiary_tax_profiles/{id}/versions/{version}
$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'
Response (200 OK)
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": true
37 },
38 "created_at": "2026-06-10T08:30:00+0000",
39 "updated_at": "2026-06-10T09:15:00+0000"
40}
Was this section helpful?

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.

Scoped API key permissions
PayoutsBeneficiary Tax ProfilesRead
On behalf of
Supports x-on-behalf-of header
Path parameters
idrequiredstring

Unique ID of the tax profile.

Query parameters
from_created_atstring

The start date of created_at in ISO 8601 format (inclusive).

pagestring

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.

page_sizeinteger

Number of results per page. Defaults to 100, minimum 10, maximum 200.

to_created_atstring

The end date of created_at in ISO 8601 format (inclusive).

typestring

Filter by form type.

W_9

Form W-9, for a US person.

W_8_BEN

Form W-8BEN, for a foreign individual.

W_8_BEN_E

Form W-8BEN-E, for a foreign entity.

W_8_ECI

Form W-8ECI, for income effectively connected with a US trade or business.

W_8_EXP

Form W-8EXP, for a foreign government or other exempt organization.

W_8_IMY

Form W-8IMY, for a foreign intermediary or flow-through entity.

8233

Form 8233, for exemption from withholding on compensation of a nonresident alien individual.

Response body - 200 OK
itemsarray

An array of paged results.

items.external_idstring

Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.

items.idstring

Unique ID of the tax profile.

items.statusstring

Status of the tax profile.

SUBMITTED

The tax profile has been submitted and is pending review

REJECTED

The tax profile has been rejected. The reason can be found in failure_reason

ACTION_REQUIRED

Additional information or action is required to continue. Details can be found in requirements

SUPERSEDED

The tax profile version has been replaced by a newer version created through an approved amendment

READY

Profile review passed and the profile is ready to be used for filing

items.typestring

The type of underlying tax form of the profile.

W_9

Form W-9, for a US person.

W_8_BEN

Form W-8BEN, for a foreign individual.

W_8_BEN_E

Form W-8BEN-E, for a foreign entity.

W_8_ECI

Form W-8ECI, for income effectively connected with a US trade or business.

W_8_EXP

Form W-8EXP, for a foreign government or other exempt organization.

W_8_IMY

Form W-8IMY, for a foreign intermediary or flow-through entity.

8233

Form 8233, for exemption from withholding on compensation of a nonresident alien individual.

items.versioninteger

The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.

items.created_atstring

Time when the tax profile was created, in ISO 8601 format.

items.failure_reasonstring

Additional message if verification failed.

items.profile_detailsobject

Recipient details used to file taxes.

items.profile_details.addressobject

Address of recipient.

items.profile_details.address.address_line1string

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.

items.profile_details.address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

items.profile_details.address.country_namestring

Country name.

items.profile_details.address.postcodestring

Postcode or zip code.

items.profile_details.address.statestring

Name of state.

items.profile_details.address.suburbstring

Name of city / suburb.

items.profile_details.address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

items.profile_details.address.state_codestring

2-letter state code.

items.profile_details.namestring

Name of the individual or organization that is the beneficial owner / intermediary.

items.profile_details.tax_identifierobject

Taxpayer Identification Number.

items.profile_details.tax_identifier.numberstring

The Tax Identification number.

items.profile_details.tax_identifier.typestring

Type of Tax Identification.

SSN

Social Security Number.

EIN

Employer Identification Number.

ITIN

Individual Taxpayer Identification Number.

QI_EIN

Qualified Intermediary Employer Identification Number.

WP_EIN

Withholding Foreign Partnership Employer Identification Number.

WT_EIN

Withholding Foreign Trust Employer Identification Number.

items.profile_details.business_addressobject

Business address in the US. Applicable when type is W_8_ECI.

items.profile_details.business_address.address_line1string

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.

items.profile_details.business_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

items.profile_details.business_address.country_namestring

Country name.

items.profile_details.business_address.postcodestring

Postcode or zip code.

items.profile_details.business_address.statestring

Name of state.

items.profile_details.business_address.suburbstring

Name of city / suburb.

items.profile_details.business_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

items.profile_details.business_address.state_codestring

2-letter state code.

items.profile_details.business_namestring

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.

items.profile_details.countrystring

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.

items.profile_details.current_non_immigrant_statusstring

Current nonimmigrant status in the US. Applicable when type is 8233.

items.profile_details.current_non_immigrant_status_expiry_datestring

Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.

items.profile_details.date_of_birthstring

Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.

items.profile_details.disregarded_entity_namestring

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.

items.profile_details.entity_typestring

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.

PARTNERSHIP

Partnership. Applicable to Form W-8BEN-E or W-8ECI

CORPORATION

Corporation. Applicable to Form W-8BEN-E or W-8ECI

SIMPLE_TRUST

Simple trust. Applicable to Form W-8BEN-E or W-8ECI

TAX_EXEMPT_ORGANIZATION

Tax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI

COMPLEX_TRUST

Complex trust. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_CONTROLLED_ENTITY

Entity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI

CENTRAL_BANK_OF_ISSUE

Central bank of issue. Applicable to Form W-8BEN-E or W-8ECI

PRIVATE_FOUNDATION

Private foundation. Applicable to Form W-8BEN-E or W-8ECI

ESTATE

Estate. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_INTEGRAL_PART

Integral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI

GRANTOR_TRUST

Grantor trust. Applicable to Form W-8BEN-E or W-8ECI

DISREGARDED_ENTITY

Disregarded entity. Applicable to Form W-8BEN-E or W-8ECI

INTERNATIONAL_ORGANIZATION

International organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP

FOREIGN_GOVERNMENT

Foreign government. Applicable to Form W-8EXP

FOREIGN_CENTRAL_BANK_OF_ISSUE

Foreign central bank of issue. Applicable to Form W-8EXP

FOREIGN_TAX_EXEMPT_ORGANIZATION

Foreign tax-exempt organization under section 501(c). Applicable to Form W-8EXP

FOREIGN_PRIVATE_FOUNDATION

Foreign private foundation. Applicable to Form W-8EXP

GOVERNMENT_OF_A_US_TERRITORY

Government of a US territory or political subdivision. Applicable to Form W-8EXP

QI

Qualified Intermediary. Applicable to Form W-8IMY

NONQUALIFIED_INTERMEDIARY

Nonqualified intermediary. Applicable to Form W-8IMY

TERRITORY_FINANCIAL_INSTITUTION

Territory financial institution. Applicable to Form W-8IMY

US_BRANCH

US branch. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_PARTNERSHIP

Withholding foreign partnership. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_TRUST

Withholding foreign trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_PARTNERSHIP

Nonwithholding foreign partnership. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_SIMPLE_TRUST

Nonwithholding foreign simple trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_GRANTOR_TRUST

Nonwithholding foreign grantor trust. Applicable to Form W-8IMY

items.profile_details.entry_to_us_datestring

Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.

items.profile_details.exempt_from_withholdingboolean

Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.

items.profile_details.exemption_justificationstring

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.

items.profile_details.foreign_scholarboolean

Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.

items.profile_details.foreign_tax_identifierstring

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.

items.profile_details.has_non_compensatory_incomeboolean

Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.

items.profile_details.independent_personal_servicesstring

Description of the personal services being provided. Applicable when type is 8233.

items.profile_details.mailing_addressobject

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.

items.profile_details.mailing_address.address_line1string

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.

items.profile_details.mailing_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

items.profile_details.mailing_address.country_namestring

Country name.

items.profile_details.mailing_address.postcodestring

Postcode or zip code.

items.profile_details.mailing_address.statestring

Name of state.

items.profile_details.mailing_address.suburbstring

Name of city / suburb.

items.profile_details.mailing_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

items.profile_details.mailing_address.state_codestring

2-letter state code.

items.profile_details.non_compensatory_exempt_amountstring

Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

items.profile_details.non_compensatory_tax_articlestring

Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

items.profile_details.non_compensatory_tax_treatystring

Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

items.profile_details.non_compensatory_total_incomestring

Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

items.profile_details.passport_numberstring

Passport number. Applicable when type is 8233.

items.profile_details.reference_numberstring

Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.

items.profile_details.tax_articlestring

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.

items.profile_details.tax_classificationobject

Federal tax classification. Applicable when type is W_9.

items.profile_details.tax_classification.typestring

Tax classification.

INDIVIDUAL_OR_SOLE_PROPRIETOR

Individual/sole proprietor or single-member LLC.

C_CORPORATION

C corporation.

S_CORPORATION

S corporation.

PARTNERSHIP

Partnership.

TRUST_OR_ESTATE

Trust or estate.

LLC

Limited liability company. Requires llc_type.

OTHER

Other entity. Specify the tax classification on the applicable form.

items.profile_details.tax_classification.has_foreign_beneficiariesboolean

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.

items.profile_details.tax_classification.llc_typestring

Tax classification of the LLC. Applicable when type is LLC.

C

C corporation

S

S corporation

P

Partnership

items.profile_details.tax_treatystring

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.profile_details.taxable_income_itemsstring

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.

items.profile_details.total_compensationstring

Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.

items.profile_details.total_paid_compensationstring

Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.

items.profile_details.us_addressobject

Address in the United States. Applicable when type is 8233.

items.profile_details.us_address.address_line1string

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.

items.profile_details.us_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

items.profile_details.us_address.country_namestring

Country name.

items.profile_details.us_address.postcodestring

Postcode or zip code.

items.profile_details.us_address.statestring

Name of state.

items.profile_details.us_address.suburbstring

Name of city / suburb.

items.profile_details.us_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

items.profile_details.us_address.state_codestring

2-letter state code.

items.profile_details.visa_typestring

US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.

items.profile_details.w8_exp_certificationobject

Chapter 3 status specific certifications. Applicable when type is W_8_EXP.

items.profile_details.w8_exp_certification.controlled_entityboolean

Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

items.profile_details.w8_exp_certification.controlling_government_namestring

The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

items.profile_details.w8_exp_certification.foreign_central_bank_of_issueboolean

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.

items.profile_details.w8_exp_certification.foreign_governmentboolean

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.

items.profile_details.w8_exp_certification.has_irs_determination_letterboolean

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.

items.profile_details.w8_exp_certification.has_us_counsel_opinionboolean

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.

items.profile_details.w8_exp_certification.integral_part_government_namestring

The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

items.profile_details.w8_exp_certification.integral_part_of_governmentboolean

Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

items.profile_details.w8_exp_certification.international_organizationboolean

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.

items.profile_details.w8_exp_certification.irs_determination_letter_datestring

Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.

items.profile_details.w8_exp_certification.no_commercial_activityboolean

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.

items.profile_details.w8_exp_certification.no_us_commercial_activityboolean

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.

items.profile_details.w8_exp_certification.not_private_foundationboolean

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.

items.profile_details.w8_exp_certification.private_foundationboolean

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.

items.profile_details.w8_exp_certification.us_territory_governmentboolean

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.

items.profile_details.w8_imy_certificationobject

Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.

items.profile_details.w8_imy_certification.nonqualified_intermediaryobject

Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.

items.profile_details.w8_imy_certification.nonqualified_intermediary.assumes_primary_withholding_as_qslboolean

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).

items.profile_details.w8_imy_certification.nonqualified_intermediary.has_provide_withholding_statementboolean

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).

items.profile_details.w8_imy_certification.nonqualified_intermediary.meets_requirements_for_us_payee_poolboolean

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).

items.profile_details.w8_imy_certification.nonqualified_intermediary.not_acting_as_qiboolean

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).

items.profile_details.w8_imy_certification.nonqualified_intermediary.withholding_statement_consistency_verifiedboolean

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).

items.profile_details.w8_imy_certification.nonwithholding_foreign_entityobject

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.

items.profile_details.w8_imy_certification.nonwithholding_foreign_entity.acts_on_behalf_of_grantorsboolean

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).

items.profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_provide_modified_amount_statementboolean

Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).

items.profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_receive_amount_from_partnership_transferboolean

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).

items.profile_details.w8_imy_certification.nonwithholding_foreign_entity.non_eci_paymentboolean

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).

items.profile_details.w8_imy_certification.nonwithholding_foreign_entity.partner_in_lower_tier_partnershipboolean

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).

items.profile_details.w8_imy_certification.nonwithholding_foreign_entity.reliable_for_alternative_withholdingboolean

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).

items.profile_details.w8_imy_certification.qiobject

Certifications for a Qualified Intermediary. Applicable when entity_type is QI.

items.profile_details.w8_imy_certification.qi.assumes_1099_reporting_for_us_personsboolean

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).

items.profile_details.w8_imy_certification.qi.assumes_primary_withholdingboolean

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).

items.profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_ptp_nomineeboolean

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).

items.profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_qslboolean

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).

items.profile_details.w8_imy_certification.qi.assumes_primary_withholding_ptp_salesboolean

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).

items.profile_details.w8_imy_certification.qi.assumes_primary_withholding_us_interestboolean

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).

items.profile_details.w8_imy_certification.qi.does_not_assume_1099_reportingboolean

Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).

items.profile_details.w8_imy_certification.qi.has_documentation_for_us_payee_poolboolean

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).

items.profile_details.w8_imy_certification.qi.meets_requirements_for_us_payee_poolboolean

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).

items.profile_details.w8_imy_certification.qi.qdd_statusboolean

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).

items.profile_details.w8_imy_certification.qi.qi_statusboolean

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).

items.profile_details.w8_imy_certification.territory_financial_institutionobject

Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.

items.profile_details.w8_imy_certification.territory_financial_institution.agrees_act_as_nominee_for_ptp_distributionsboolean

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).

items.profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_personboolean

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).

items.profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_person_for_ptp_salesboolean

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).

items.profile_details.w8_imy_certification.territory_financial_institution.has_provide_withholding_statementboolean

Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).

items.profile_details.w8_imy_certification.territory_financial_institution.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).

items.profile_details.w8_imy_certification.territory_financial_institution.territory_financial_institutionboolean

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).

items.profile_details.w8_imy_certification.us_branchobject

Certifications for a US Branch. Applicable when entity_type is US_BRANCH.

items.profile_details.w8_imy_certification.us_branch.agrees_act_as_nominee_for_ptp_distributionsboolean

Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).

items.profile_details.w8_imy_certification.us_branch.agrees_act_as_us_person_for_ptp_salesboolean

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).

items.profile_details.w8_imy_certification.us_branch.agrees_treat_as_us_personboolean

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).

items.profile_details.w8_imy_certification.us_branch.has_provide_withholding_statementboolean

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).

items.profile_details.w8_imy_certification.us_branch.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).

items.profile_details.w8_imy_certification.us_branch.us_branchboolean

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).

items.profile_details.w8_imy_certification.withholding_foreign_entityobject

Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.

items.profile_details.w8_imy_certification.withholding_foreign_entity.compliance_with_agreementboolean

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).

items.requirementsobject

Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.

items.requirements.payer_info_requiredarray

Details about what payer information is incomplete.

items.requirements.payer_info_required.descriptionstring

A detailed message describing the missing information.

items.requirements.payer_info_required.typestring

Type of information that is missing or incorrect.

TAX_IDENTIFIER

The payer's tax identifier is missing or incorrect

STATE

The payer's state is missing or incorrect

CITY

The payer's city is missing or incorrect

COUNTRY_CODE

The payer's country code is missing or incorrect

BUSINESS_NAME

The payer's business name is missing or incorrect

PHONE_NUMBER

The payer's phone number is missing or incorrect

items.signature_namestring

Full legal name of the individual who provided the electronic signature.

items.supporting_documentsarray

Additional files uploaded for different supporting purposes.

items.supporting_documents.file_idstring

The file ID returned when the document was uploaded to the file service.

items.supporting_documents.tagstring

Purpose of the supporting document. The applicable values depend on the tax form type.

RESIDENCY_PROOF

Supporting document if the address is not in the US. Applicable when the form type is W_9

NON_US_TAX_PROOF

Supporting 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_STATEMENT

Statement of taxable income items. Applicable when the form type is W_8_ECI

WITHHOLDING_CERTIFICATION

Certification 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_STATEMENT

Statement 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_STATEMENT

Statement 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_CONCLUSION

Opinion 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

AFFIDAVIT

Affidavit 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_ATTACHMENT

Statement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true

items.supporting_documents.descriptionstring

Additional description of the file.

items.updated_atstring

Time when the tax profile was last updated, in ISO 8601 format.

page_afterstring

The cursor for the next page of results. Pass this value as page in a subsequent request. null if there are no more results.

page_beforestring

The cursor for the previous page of results. Pass this value as page in a subsequent request. null if there are no previous results.

Errors
Error statusDescription
400

Possible errors: invalid_argument, bad_request

404

Possible errors: not_found

GET /api/v1/beneficiary_tax_profiles/{id}/versions
$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'
Response (200 OK)
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": true
32 },
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": true
65 },
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}
Was this section helpful?

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).

Scoped API key permissions
PayoutsBeneficiary Tax ProfilesRead
On behalf of
Supports x-on-behalf-of header
Path parameters
idrequiredstring

Unique ID of the tax profile.

versionrequiredinteger

Exact tax profile version to download.

Response body - 200 OK
download_urlstring

URL that can be used to retrieve the file. This URL expires shortly after it is generated.

expires_atstring

Download URL expiry timestamp, in ISO 8601 format.

Errors
Error statusDescription
400

Possible errors: invalid_argument, bad_request

404

Possible errors: not_found

POST /api/v1/beneficiary_tax_profiles/{id}/versions/{version}/download
$curl --request POST \
> --url 'https://api.sandbox.airwallex.com/api/v1/beneficiary_tax_profiles/txf-1a2b3c4d5e6f/versions/1/download' \
> --header 'Authorization: Bearer <token>'
Response (200 OK)
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}
Was this section helpful?

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.

Scoped API key permissions
PayoutsBeneficiary Tax ProfilesWrite
On behalf of
Supports x-on-behalf-of header
Path parameters
idrequiredstring

Unique ID of the beneficiary tax profile to amend.

Request body
profile_detailsrequiredobject

Recipient details used to file taxes.

profile_details.addressrequiredobject

Address of recipient.

profile_details.address.address_line1requiredstring

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.

profile_details.address.country_coderequiredstring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.address.country_namerequiredstring

Country name.

profile_details.address.postcoderequiredstring

Postcode or zip code.

profile_details.address.staterequiredstring

Name of state.

profile_details.address.suburbrequiredstring

Name of city / suburb.

profile_details.address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.address.state_codestring

2-letter state code.

profile_details.namerequiredstring

Name of the individual or organization that is the beneficial owner / intermediary.

profile_details.tax_identifierrequiredobject

Taxpayer Identification Number.

profile_details.tax_identifier.numberrequiredstring

The Tax Identification number.

profile_details.tax_identifier.typerequiredstring

Type of Tax Identification.

SSN

Social Security Number.

EIN

Employer Identification Number.

ITIN

Individual Taxpayer Identification Number.

QI_EIN

Qualified Intermediary Employer Identification Number.

WP_EIN

Withholding Foreign Partnership Employer Identification Number.

WT_EIN

Withholding Foreign Trust Employer Identification Number.

profile_details.business_addressobject

Business address in the US. Applicable when type is W_8_ECI.

profile_details.business_address.address_line1requiredstring

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.

profile_details.business_address.country_coderequiredstring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.business_address.country_namerequiredstring

Country name.

profile_details.business_address.postcoderequiredstring

Postcode or zip code.

profile_details.business_address.staterequiredstring

Name of state.

profile_details.business_address.suburbrequiredstring

Name of city / suburb.

profile_details.business_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.business_address.state_codestring

2-letter state code.

profile_details.business_namestring

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.

profile_details.countrystring

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.

profile_details.current_non_immigrant_statusstring

Current nonimmigrant status in the US. Applicable when type is 8233.

profile_details.current_non_immigrant_status_expiry_datestring

Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.

profile_details.date_of_birthstring

Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.

profile_details.disregarded_entity_namestring

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.

profile_details.entity_typestring

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.

PARTNERSHIP

Partnership. Applicable to Form W-8BEN-E or W-8ECI

CORPORATION

Corporation. Applicable to Form W-8BEN-E or W-8ECI

SIMPLE_TRUST

Simple trust. Applicable to Form W-8BEN-E or W-8ECI

TAX_EXEMPT_ORGANIZATION

Tax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI

COMPLEX_TRUST

Complex trust. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_CONTROLLED_ENTITY

Entity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI

CENTRAL_BANK_OF_ISSUE

Central bank of issue. Applicable to Form W-8BEN-E or W-8ECI

PRIVATE_FOUNDATION

Private foundation. Applicable to Form W-8BEN-E or W-8ECI

ESTATE

Estate. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_INTEGRAL_PART

Integral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI

GRANTOR_TRUST

Grantor trust. Applicable to Form W-8BEN-E or W-8ECI

DISREGARDED_ENTITY

Disregarded entity. Applicable to Form W-8BEN-E or W-8ECI

INTERNATIONAL_ORGANIZATION

International organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP

FOREIGN_GOVERNMENT

Foreign government. Applicable to Form W-8EXP

FOREIGN_CENTRAL_BANK_OF_ISSUE

Foreign central bank of issue. Applicable to Form W-8EXP

FOREIGN_TAX_EXEMPT_ORGANIZATION

Foreign tax-exempt organization under section 501(c). Applicable to Form W-8EXP

FOREIGN_PRIVATE_FOUNDATION

Foreign private foundation. Applicable to Form W-8EXP

GOVERNMENT_OF_A_US_TERRITORY

Government of a US territory or political subdivision. Applicable to Form W-8EXP

QI

Qualified Intermediary. Applicable to Form W-8IMY

NONQUALIFIED_INTERMEDIARY

Nonqualified intermediary. Applicable to Form W-8IMY

TERRITORY_FINANCIAL_INSTITUTION

Territory financial institution. Applicable to Form W-8IMY

US_BRANCH

US branch. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_PARTNERSHIP

Withholding foreign partnership. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_TRUST

Withholding foreign trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_PARTNERSHIP

Nonwithholding foreign partnership. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_SIMPLE_TRUST

Nonwithholding foreign simple trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_GRANTOR_TRUST

Nonwithholding foreign grantor trust. Applicable to Form W-8IMY

profile_details.entry_to_us_datestring

Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.

profile_details.exempt_from_withholdingboolean

Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.

profile_details.exemption_justificationstring

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.

profile_details.foreign_scholarboolean

Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.

profile_details.foreign_tax_identifierstring

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.

profile_details.has_non_compensatory_incomeboolean

Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.

profile_details.independent_personal_servicesstring

Description of the personal services being provided. Applicable when type is 8233.

profile_details.mailing_addressobject

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.

profile_details.mailing_address.address_line1requiredstring

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.

profile_details.mailing_address.country_coderequiredstring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.mailing_address.country_namerequiredstring

Country name.

profile_details.mailing_address.postcoderequiredstring

Postcode or zip code.

profile_details.mailing_address.staterequiredstring

Name of state.

profile_details.mailing_address.suburbrequiredstring

Name of city / suburb.

profile_details.mailing_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.mailing_address.state_codestring

2-letter state code.

profile_details.non_compensatory_exempt_amountstring

Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_tax_articlestring

Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_tax_treatystring

Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.non_compensatory_total_incomestring

Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

profile_details.passport_numberstring

Passport number. Applicable when type is 8233.

profile_details.reference_numberstring

Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.

profile_details.tax_articlestring

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.

profile_details.tax_classificationobject

Federal tax classification. Applicable when type is W_9.

profile_details.tax_classification.typerequiredstring

Tax classification.

INDIVIDUAL_OR_SOLE_PROPRIETOR

Individual/sole proprietor or single-member LLC.

C_CORPORATION

C corporation.

S_CORPORATION

S corporation.

PARTNERSHIP

Partnership.

TRUST_OR_ESTATE

Trust or estate.

LLC

Limited liability company. Requires llc_type.

OTHER

Other entity. Specify the tax classification on the applicable form.

profile_details.tax_classification.has_foreign_beneficiariesboolean

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.

profile_details.tax_classification.llc_typestring

Tax classification of the LLC. Applicable when type is LLC.

C

C corporation

S

S corporation

P

Partnership

profile_details.tax_treatystring

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.

profile_details.taxable_income_itemsstring

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.

profile_details.total_compensationstring

Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.

profile_details.total_paid_compensationstring

Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.

profile_details.us_addressobject

Address in the United States. Applicable when type is 8233.

profile_details.us_address.address_line1requiredstring

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.

profile_details.us_address.country_coderequiredstring

Country code (2-letter ISO 3166-1 alpha-2 country code).

profile_details.us_address.country_namerequiredstring

Country name.

profile_details.us_address.postcoderequiredstring

Postcode or zip code.

profile_details.us_address.staterequiredstring

Name of state.

profile_details.us_address.suburbrequiredstring

Name of city / suburb.

profile_details.us_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

profile_details.us_address.state_codestring

2-letter state code.

profile_details.visa_typestring

US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.

profile_details.w8_exp_certificationobject

Chapter 3 status specific certifications. Applicable when type is W_8_EXP.

profile_details.w8_exp_certification.controlled_entityboolean

Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.controlling_government_namestring

The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.foreign_central_bank_of_issueboolean

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.

profile_details.w8_exp_certification.foreign_governmentboolean

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.

profile_details.w8_exp_certification.has_irs_determination_letterboolean

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.

profile_details.w8_exp_certification.has_us_counsel_opinionboolean

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.

profile_details.w8_exp_certification.integral_part_government_namestring

The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.integral_part_of_governmentboolean

Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

profile_details.w8_exp_certification.international_organizationboolean

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.

profile_details.w8_exp_certification.irs_determination_letter_datestring

Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.

profile_details.w8_exp_certification.no_commercial_activityboolean

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.

profile_details.w8_exp_certification.no_us_commercial_activityboolean

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.

profile_details.w8_exp_certification.not_private_foundationboolean

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.

profile_details.w8_exp_certification.private_foundationboolean

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.

profile_details.w8_exp_certification.us_territory_governmentboolean

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.

profile_details.w8_imy_certificationobject

Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.

profile_details.w8_imy_certification.nonqualified_intermediaryobject

Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.

profile_details.w8_imy_certification.nonqualified_intermediary.assumes_primary_withholding_as_qslboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.has_provide_withholding_statementboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.meets_requirements_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.not_acting_as_qiboolean

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).

profile_details.w8_imy_certification.nonqualified_intermediary.withholding_statement_consistency_verifiedboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entityobject

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.

profile_details.w8_imy_certification.nonwithholding_foreign_entity.acts_on_behalf_of_grantorsboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_provide_modified_amount_statementboolean

Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_receive_amount_from_partnership_transferboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.non_eci_paymentboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.partner_in_lower_tier_partnershipboolean

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).

profile_details.w8_imy_certification.nonwithholding_foreign_entity.reliable_for_alternative_withholdingboolean

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).

profile_details.w8_imy_certification.qiobject

Certifications for a Qualified Intermediary. Applicable when entity_type is QI.

profile_details.w8_imy_certification.qi.assumes_1099_reporting_for_us_personsboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholdingboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_ptp_nomineeboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_qslboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_ptp_salesboolean

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).

profile_details.w8_imy_certification.qi.assumes_primary_withholding_us_interestboolean

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).

profile_details.w8_imy_certification.qi.does_not_assume_1099_reportingboolean

Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).

profile_details.w8_imy_certification.qi.has_documentation_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.qi.meets_requirements_for_us_payee_poolboolean

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).

profile_details.w8_imy_certification.qi.qdd_statusboolean

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).

profile_details.w8_imy_certification.qi.qi_statusboolean

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).

profile_details.w8_imy_certification.territory_financial_institutionobject

Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.

profile_details.w8_imy_certification.territory_financial_institution.agrees_act_as_nominee_for_ptp_distributionsboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_personboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_person_for_ptp_salesboolean

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).

profile_details.w8_imy_certification.territory_financial_institution.has_provide_withholding_statementboolean

Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).

profile_details.w8_imy_certification.territory_financial_institution.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).

profile_details.w8_imy_certification.territory_financial_institution.territory_financial_institutionboolean

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).

profile_details.w8_imy_certification.us_branchobject

Certifications for a US Branch. Applicable when entity_type is US_BRANCH.

profile_details.w8_imy_certification.us_branch.agrees_act_as_nominee_for_ptp_distributionsboolean

Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).

profile_details.w8_imy_certification.us_branch.agrees_act_as_us_person_for_ptp_salesboolean

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).

profile_details.w8_imy_certification.us_branch.agrees_treat_as_us_personboolean

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).

profile_details.w8_imy_certification.us_branch.has_provide_withholding_statementboolean

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).

profile_details.w8_imy_certification.us_branch.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).

profile_details.w8_imy_certification.us_branch.us_branchboolean

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).

profile_details.w8_imy_certification.withholding_foreign_entityobject

Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.

profile_details.w8_imy_certification.withholding_foreign_entity.compliance_with_agreementboolean

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).

signature_namerequiredstring

Full legal name of the individual providing the electronic signature.

typerequiredstring

The type of underlying tax form of the profile.

W_9

Form W-9, for a US person.

W_8_BEN

Form W-8BEN, for a foreign individual.

W_8_BEN_E

Form W-8BEN-E, for a foreign entity.

W_8_ECI

Form W-8ECI, for income effectively connected with a US trade or business.

W_8_EXP

Form W-8EXP, for a foreign government or other exempt organization.

W_8_IMY

Form W-8IMY, for a foreign intermediary or flow-through entity.

8233

Form 8233, for exemption from withholding on compensation of a nonresident alien individual.

supporting_documentsarray

Additional files for different supporting purposes.

supporting_documents.file_idrequiredstring

The file ID returned when the document was uploaded to the file service.

supporting_documents.tagrequiredstring

Purpose of the supporting document. The applicable values depend on the tax form type.

RESIDENCY_PROOF

Supporting document if the address is not in the US. Applicable when the form type is W_9

NON_US_TAX_PROOF

Supporting 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_STATEMENT

Statement of taxable income items. Applicable when the form type is W_8_ECI

WITHHOLDING_CERTIFICATION

Certification 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_STATEMENT

Statement 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_STATEMENT

Statement 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_CONCLUSION

Opinion 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

AFFIDAVIT

Affidavit 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_ATTACHMENT

Statement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true

supporting_documents.descriptionstring

Additional description of the file.

Response body - 201 Created
beneficiary_tax_profileobject

The new tax profile version created by this amendment.

beneficiary_tax_profile.external_idstring

Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.

beneficiary_tax_profile.idstring

Unique ID of the tax profile.

beneficiary_tax_profile.statusstring

Status of the tax profile.

SUBMITTED

The tax profile has been submitted and is pending review

REJECTED

The tax profile has been rejected. The reason can be found in failure_reason

ACTION_REQUIRED

Additional information or action is required to continue. Details can be found in requirements

SUPERSEDED

The tax profile version has been replaced by a newer version created through an approved amendment

READY

Profile review passed and the profile is ready to be used for filing

beneficiary_tax_profile.typestring

The type of underlying tax form of the profile.

W_9

Form W-9, for a US person.

W_8_BEN

Form W-8BEN, for a foreign individual.

W_8_BEN_E

Form W-8BEN-E, for a foreign entity.

W_8_ECI

Form W-8ECI, for income effectively connected with a US trade or business.

W_8_EXP

Form W-8EXP, for a foreign government or other exempt organization.

W_8_IMY

Form W-8IMY, for a foreign intermediary or flow-through entity.

8233

Form 8233, for exemption from withholding on compensation of a nonresident alien individual.

beneficiary_tax_profile.versioninteger

The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.

beneficiary_tax_profile.created_atstring

Time when the tax profile was created, in ISO 8601 format.

beneficiary_tax_profile.failure_reasonstring

Additional message if verification failed.

beneficiary_tax_profile.profile_detailsobject

Recipient details used to file taxes.

beneficiary_tax_profile.profile_details.addressobject

Address of recipient.

beneficiary_tax_profile.profile_details.address.address_line1string

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.

beneficiary_tax_profile.profile_details.address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

beneficiary_tax_profile.profile_details.address.country_namestring

Country name.

beneficiary_tax_profile.profile_details.address.postcodestring

Postcode or zip code.

beneficiary_tax_profile.profile_details.address.statestring

Name of state.

beneficiary_tax_profile.profile_details.address.suburbstring

Name of city / suburb.

beneficiary_tax_profile.profile_details.address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

beneficiary_tax_profile.profile_details.address.state_codestring

2-letter state code.

beneficiary_tax_profile.profile_details.namestring

Name of the individual or organization that is the beneficial owner / intermediary.

beneficiary_tax_profile.profile_details.tax_identifierobject

Taxpayer Identification Number.

beneficiary_tax_profile.profile_details.tax_identifier.numberstring

The Tax Identification number.

beneficiary_tax_profile.profile_details.tax_identifier.typestring

Type of Tax Identification.

SSN

Social Security Number.

EIN

Employer Identification Number.

ITIN

Individual Taxpayer Identification Number.

QI_EIN

Qualified Intermediary Employer Identification Number.

WP_EIN

Withholding Foreign Partnership Employer Identification Number.

WT_EIN

Withholding Foreign Trust Employer Identification Number.

beneficiary_tax_profile.profile_details.business_addressobject

Business address in the US. Applicable when type is W_8_ECI.

beneficiary_tax_profile.profile_details.business_address.address_line1string

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.

beneficiary_tax_profile.profile_details.business_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

beneficiary_tax_profile.profile_details.business_address.country_namestring

Country name.

beneficiary_tax_profile.profile_details.business_address.postcodestring

Postcode or zip code.

beneficiary_tax_profile.profile_details.business_address.statestring

Name of state.

beneficiary_tax_profile.profile_details.business_address.suburbstring

Name of city / suburb.

beneficiary_tax_profile.profile_details.business_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

beneficiary_tax_profile.profile_details.business_address.state_codestring

2-letter state code.

beneficiary_tax_profile.profile_details.business_namestring

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.

beneficiary_tax_profile.profile_details.countrystring

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.

beneficiary_tax_profile.profile_details.current_non_immigrant_statusstring

Current nonimmigrant status in the US. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.current_non_immigrant_status_expiry_datestring

Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.date_of_birthstring

Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.

beneficiary_tax_profile.profile_details.disregarded_entity_namestring

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.

beneficiary_tax_profile.profile_details.entity_typestring

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.

PARTNERSHIP

Partnership. Applicable to Form W-8BEN-E or W-8ECI

CORPORATION

Corporation. Applicable to Form W-8BEN-E or W-8ECI

SIMPLE_TRUST

Simple trust. Applicable to Form W-8BEN-E or W-8ECI

TAX_EXEMPT_ORGANIZATION

Tax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI

COMPLEX_TRUST

Complex trust. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_CONTROLLED_ENTITY

Entity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI

CENTRAL_BANK_OF_ISSUE

Central bank of issue. Applicable to Form W-8BEN-E or W-8ECI

PRIVATE_FOUNDATION

Private foundation. Applicable to Form W-8BEN-E or W-8ECI

ESTATE

Estate. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_INTEGRAL_PART

Integral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI

GRANTOR_TRUST

Grantor trust. Applicable to Form W-8BEN-E or W-8ECI

DISREGARDED_ENTITY

Disregarded entity. Applicable to Form W-8BEN-E or W-8ECI

INTERNATIONAL_ORGANIZATION

International organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP

FOREIGN_GOVERNMENT

Foreign government. Applicable to Form W-8EXP

FOREIGN_CENTRAL_BANK_OF_ISSUE

Foreign central bank of issue. Applicable to Form W-8EXP

FOREIGN_TAX_EXEMPT_ORGANIZATION

Foreign tax-exempt organization under section 501(c). Applicable to Form W-8EXP

FOREIGN_PRIVATE_FOUNDATION

Foreign private foundation. Applicable to Form W-8EXP

GOVERNMENT_OF_A_US_TERRITORY

Government of a US territory or political subdivision. Applicable to Form W-8EXP

QI

Qualified Intermediary. Applicable to Form W-8IMY

NONQUALIFIED_INTERMEDIARY

Nonqualified intermediary. Applicable to Form W-8IMY

TERRITORY_FINANCIAL_INSTITUTION

Territory financial institution. Applicable to Form W-8IMY

US_BRANCH

US branch. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_PARTNERSHIP

Withholding foreign partnership. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_TRUST

Withholding foreign trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_PARTNERSHIP

Nonwithholding foreign partnership. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_SIMPLE_TRUST

Nonwithholding foreign simple trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_GRANTOR_TRUST

Nonwithholding foreign grantor trust. Applicable to Form W-8IMY

beneficiary_tax_profile.profile_details.entry_to_us_datestring

Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.exempt_from_withholdingboolean

Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.exemption_justificationstring

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.

beneficiary_tax_profile.profile_details.foreign_scholarboolean

Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.foreign_tax_identifierstring

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.

beneficiary_tax_profile.profile_details.has_non_compensatory_incomeboolean

Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.independent_personal_servicesstring

Description of the personal services being provided. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.mailing_addressobject

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.

beneficiary_tax_profile.profile_details.mailing_address.address_line1string

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.

beneficiary_tax_profile.profile_details.mailing_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

beneficiary_tax_profile.profile_details.mailing_address.country_namestring

Country name.

beneficiary_tax_profile.profile_details.mailing_address.postcodestring

Postcode or zip code.

beneficiary_tax_profile.profile_details.mailing_address.statestring

Name of state.

beneficiary_tax_profile.profile_details.mailing_address.suburbstring

Name of city / suburb.

beneficiary_tax_profile.profile_details.mailing_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

beneficiary_tax_profile.profile_details.mailing_address.state_codestring

2-letter state code.

beneficiary_tax_profile.profile_details.non_compensatory_exempt_amountstring

Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

beneficiary_tax_profile.profile_details.non_compensatory_tax_articlestring

Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

beneficiary_tax_profile.profile_details.non_compensatory_tax_treatystring

Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

beneficiary_tax_profile.profile_details.non_compensatory_total_incomestring

Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

beneficiary_tax_profile.profile_details.passport_numberstring

Passport number. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.reference_numberstring

Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.

beneficiary_tax_profile.profile_details.tax_articlestring

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.

beneficiary_tax_profile.profile_details.tax_classificationobject

Federal tax classification. Applicable when type is W_9.

beneficiary_tax_profile.profile_details.tax_classification.typestring

Tax classification.

INDIVIDUAL_OR_SOLE_PROPRIETOR

Individual/sole proprietor or single-member LLC.

C_CORPORATION

C corporation.

S_CORPORATION

S corporation.

PARTNERSHIP

Partnership.

TRUST_OR_ESTATE

Trust or estate.

LLC

Limited liability company. Requires llc_type.

OTHER

Other entity. Specify the tax classification on the applicable form.

beneficiary_tax_profile.profile_details.tax_classification.has_foreign_beneficiariesboolean

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.

beneficiary_tax_profile.profile_details.tax_classification.llc_typestring

Tax classification of the LLC. Applicable when type is LLC.

C

C corporation

S

S corporation

P

Partnership

beneficiary_tax_profile.profile_details.tax_treatystring

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.

beneficiary_tax_profile.profile_details.taxable_income_itemsstring

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.

beneficiary_tax_profile.profile_details.total_compensationstring

Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.

beneficiary_tax_profile.profile_details.total_paid_compensationstring

Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.us_addressobject

Address in the United States. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.us_address.address_line1string

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.

beneficiary_tax_profile.profile_details.us_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

beneficiary_tax_profile.profile_details.us_address.country_namestring

Country name.

beneficiary_tax_profile.profile_details.us_address.postcodestring

Postcode or zip code.

beneficiary_tax_profile.profile_details.us_address.statestring

Name of state.

beneficiary_tax_profile.profile_details.us_address.suburbstring

Name of city / suburb.

beneficiary_tax_profile.profile_details.us_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

beneficiary_tax_profile.profile_details.us_address.state_codestring

2-letter state code.

beneficiary_tax_profile.profile_details.visa_typestring

US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.

beneficiary_tax_profile.profile_details.w8_exp_certificationobject

Chapter 3 status specific certifications. Applicable when type is W_8_EXP.

beneficiary_tax_profile.profile_details.w8_exp_certification.controlled_entityboolean

Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

beneficiary_tax_profile.profile_details.w8_exp_certification.controlling_government_namestring

The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

beneficiary_tax_profile.profile_details.w8_exp_certification.foreign_central_bank_of_issueboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.foreign_governmentboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.has_irs_determination_letterboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.has_us_counsel_opinionboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.integral_part_government_namestring

The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

beneficiary_tax_profile.profile_details.w8_exp_certification.integral_part_of_governmentboolean

Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

beneficiary_tax_profile.profile_details.w8_exp_certification.international_organizationboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.irs_determination_letter_datestring

Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.

beneficiary_tax_profile.profile_details.w8_exp_certification.no_commercial_activityboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.no_us_commercial_activityboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.not_private_foundationboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.private_foundationboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.us_territory_governmentboolean

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.

beneficiary_tax_profile.profile_details.w8_imy_certificationobject

Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.

beneficiary_tax_profile.profile_details.w8_imy_certification.nonqualified_intermediaryobject

Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.

beneficiary_tax_profile.profile_details.w8_imy_certification.nonqualified_intermediary.assumes_primary_withholding_as_qslboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonqualified_intermediary.has_provide_withholding_statementboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonqualified_intermediary.meets_requirements_for_us_payee_poolboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonqualified_intermediary.not_acting_as_qiboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonqualified_intermediary.withholding_statement_consistency_verifiedboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entityobject

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.

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entity.acts_on_behalf_of_grantorsboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_provide_modified_amount_statementboolean

Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_receive_amount_from_partnership_transferboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entity.non_eci_paymentboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entity.partner_in_lower_tier_partnershipboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entity.reliable_for_alternative_withholdingboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qiobject

Certifications for a Qualified Intermediary. Applicable when entity_type is QI.

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.assumes_1099_reporting_for_us_personsboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.assumes_primary_withholdingboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_ptp_nomineeboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_qslboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.assumes_primary_withholding_ptp_salesboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.assumes_primary_withholding_us_interestboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.does_not_assume_1099_reportingboolean

Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.has_documentation_for_us_payee_poolboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.meets_requirements_for_us_payee_poolboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.qdd_statusboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.qi_statusboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institutionobject

Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institution.agrees_act_as_nominee_for_ptp_distributionsboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_personboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_person_for_ptp_salesboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institution.has_provide_withholding_statementboolean

Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institution.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institution.territory_financial_institutionboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branchobject

Certifications for a US Branch. Applicable when entity_type is US_BRANCH.

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branch.agrees_act_as_nominee_for_ptp_distributionsboolean

Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branch.agrees_act_as_us_person_for_ptp_salesboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branch.agrees_treat_as_us_personboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branch.has_provide_withholding_statementboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branch.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branch.us_branchboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.withholding_foreign_entityobject

Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.

beneficiary_tax_profile.profile_details.w8_imy_certification.withholding_foreign_entity.compliance_with_agreementboolean

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).

beneficiary_tax_profile.requirementsobject

Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.

beneficiary_tax_profile.requirements.payer_info_requiredarray

Details about what payer information is incomplete.

beneficiary_tax_profile.requirements.payer_info_required.descriptionstring

A detailed message describing the missing information.

beneficiary_tax_profile.requirements.payer_info_required.typestring

Type of information that is missing or incorrect.

TAX_IDENTIFIER

The payer's tax identifier is missing or incorrect

STATE

The payer's state is missing or incorrect

CITY

The payer's city is missing or incorrect

COUNTRY_CODE

The payer's country code is missing or incorrect

BUSINESS_NAME

The payer's business name is missing or incorrect

PHONE_NUMBER

The payer's phone number is missing or incorrect

beneficiary_tax_profile.signature_namestring

Full legal name of the individual who provided the electronic signature.

beneficiary_tax_profile.supporting_documentsarray

Additional files uploaded for different supporting purposes.

beneficiary_tax_profile.supporting_documents.file_idstring

The file ID returned when the document was uploaded to the file service.

beneficiary_tax_profile.supporting_documents.tagstring

Purpose of the supporting document. The applicable values depend on the tax form type.

RESIDENCY_PROOF

Supporting document if the address is not in the US. Applicable when the form type is W_9

NON_US_TAX_PROOF

Supporting 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_STATEMENT

Statement of taxable income items. Applicable when the form type is W_8_ECI

WITHHOLDING_CERTIFICATION

Certification 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_STATEMENT

Statement 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_STATEMENT

Statement 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_CONCLUSION

Opinion 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

AFFIDAVIT

Affidavit 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_ATTACHMENT

Statement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true

beneficiary_tax_profile.supporting_documents.descriptionstring

Additional description of the file.

beneficiary_tax_profile.updated_atstring

Time when the tax profile was last updated, in ISO 8601 format.

created_atstring

Time when the amendment was created, in ISO 8601 format.

idstring

Unique ID of the amendment.

statusstring

Status of the amendment.

PENDING

The amendment is pending review

APPROVED

The amendment is approved

REJECTED

The amendment is rejected

updated_atstring

Time when the amendment was last updated, in ISO 8601 format.

Errors
Error statusDescription
400

Possible errors: invalid_argument, bad_request

404

Possible errors: not_found

POST /api/v1/beneficiary_tax_profiles/{id}/amendments/create
$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
> }
>}'
Response (201 Created)
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": true
40 }
41 },
42 "created_at": "2026-06-10T08:30:00+0000",
43 "updated_at": "2026-06-10T08:30:00+0000"
44}
Was this section helpful?

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.

Scoped API key permissions
PayoutsBeneficiary Tax ProfilesRead
On behalf of
Supports x-on-behalf-of header
Path parameters
amendment_idrequiredstring

Unique ID of the amendment.

idrequiredstring

Unique ID of the tax profile.

Response body - 200 OK
beneficiary_tax_profileobject

The new tax profile version created by this amendment.

beneficiary_tax_profile.external_idstring

Unique identifier of a recipient. It should be the same value as the beneficiary.additional_info.external_identifier field in the Create beneficiary API.

beneficiary_tax_profile.idstring

Unique ID of the tax profile.

beneficiary_tax_profile.statusstring

Status of the tax profile.

SUBMITTED

The tax profile has been submitted and is pending review

REJECTED

The tax profile has been rejected. The reason can be found in failure_reason

ACTION_REQUIRED

Additional information or action is required to continue. Details can be found in requirements

SUPERSEDED

The tax profile version has been replaced by a newer version created through an approved amendment

READY

Profile review passed and the profile is ready to be used for filing

beneficiary_tax_profile.typestring

The type of underlying tax form of the profile.

W_9

Form W-9, for a US person.

W_8_BEN

Form W-8BEN, for a foreign individual.

W_8_BEN_E

Form W-8BEN-E, for a foreign entity.

W_8_ECI

Form W-8ECI, for income effectively connected with a US trade or business.

W_8_EXP

Form W-8EXP, for a foreign government or other exempt organization.

W_8_IMY

Form W-8IMY, for a foreign intermediary or flow-through entity.

8233

Form 8233, for exemption from withholding on compensation of a nonresident alien individual.

beneficiary_tax_profile.versioninteger

The exact version of the tax profile. Starts at 0 and increments each time an amendment is created.

beneficiary_tax_profile.created_atstring

Time when the tax profile was created, in ISO 8601 format.

beneficiary_tax_profile.failure_reasonstring

Additional message if verification failed.

beneficiary_tax_profile.profile_detailsobject

Recipient details used to file taxes.

beneficiary_tax_profile.profile_details.addressobject

Address of recipient.

beneficiary_tax_profile.profile_details.address.address_line1string

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.

beneficiary_tax_profile.profile_details.address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

beneficiary_tax_profile.profile_details.address.country_namestring

Country name.

beneficiary_tax_profile.profile_details.address.postcodestring

Postcode or zip code.

beneficiary_tax_profile.profile_details.address.statestring

Name of state.

beneficiary_tax_profile.profile_details.address.suburbstring

Name of city / suburb.

beneficiary_tax_profile.profile_details.address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

beneficiary_tax_profile.profile_details.address.state_codestring

2-letter state code.

beneficiary_tax_profile.profile_details.namestring

Name of the individual or organization that is the beneficial owner / intermediary.

beneficiary_tax_profile.profile_details.tax_identifierobject

Taxpayer Identification Number.

beneficiary_tax_profile.profile_details.tax_identifier.numberstring

The Tax Identification number.

beneficiary_tax_profile.profile_details.tax_identifier.typestring

Type of Tax Identification.

SSN

Social Security Number.

EIN

Employer Identification Number.

ITIN

Individual Taxpayer Identification Number.

QI_EIN

Qualified Intermediary Employer Identification Number.

WP_EIN

Withholding Foreign Partnership Employer Identification Number.

WT_EIN

Withholding Foreign Trust Employer Identification Number.

beneficiary_tax_profile.profile_details.business_addressobject

Business address in the US. Applicable when type is W_8_ECI.

beneficiary_tax_profile.profile_details.business_address.address_line1string

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.

beneficiary_tax_profile.profile_details.business_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

beneficiary_tax_profile.profile_details.business_address.country_namestring

Country name.

beneficiary_tax_profile.profile_details.business_address.postcodestring

Postcode or zip code.

beneficiary_tax_profile.profile_details.business_address.statestring

Name of state.

beneficiary_tax_profile.profile_details.business_address.suburbstring

Name of city / suburb.

beneficiary_tax_profile.profile_details.business_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

beneficiary_tax_profile.profile_details.business_address.state_codestring

2-letter state code.

beneficiary_tax_profile.profile_details.business_namestring

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.

beneficiary_tax_profile.profile_details.countrystring

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.

beneficiary_tax_profile.profile_details.current_non_immigrant_statusstring

Current nonimmigrant status in the US. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.current_non_immigrant_status_expiry_datestring

Date the current nonimmigrant status expires (based on duration of status), in YYYY-MM-DD format. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.date_of_birthstring

Birth date of the recipient, in YYYY-MM-DD format. Applicable when type is W_8_BEN or W_8_ECI.

beneficiary_tax_profile.profile_details.disregarded_entity_namestring

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.

beneficiary_tax_profile.profile_details.entity_typestring

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.

PARTNERSHIP

Partnership. Applicable to Form W-8BEN-E or W-8ECI

CORPORATION

Corporation. Applicable to Form W-8BEN-E or W-8ECI

SIMPLE_TRUST

Simple trust. Applicable to Form W-8BEN-E or W-8ECI

TAX_EXEMPT_ORGANIZATION

Tax-exempt organization under section 501(c). Applicable to Form W-8BEN-E or W-8ECI

COMPLEX_TRUST

Complex trust. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_CONTROLLED_ENTITY

Entity controlled by a foreign government. Applicable to Form W-8BEN-E or W-8ECI

CENTRAL_BANK_OF_ISSUE

Central bank of issue. Applicable to Form W-8BEN-E or W-8ECI

PRIVATE_FOUNDATION

Private foundation. Applicable to Form W-8BEN-E or W-8ECI

ESTATE

Estate. Applicable to Form W-8BEN-E or W-8ECI

FOREIGN_GOVERNMENT_INTEGRAL_PART

Integral part of a foreign government. Applicable to Form W-8BEN-E or W-8ECI

GRANTOR_TRUST

Grantor trust. Applicable to Form W-8BEN-E or W-8ECI

DISREGARDED_ENTITY

Disregarded entity. Applicable to Form W-8BEN-E or W-8ECI

INTERNATIONAL_ORGANIZATION

International organization. Applicable to Form W-8BEN-E, W-8ECI, or W-8EXP

FOREIGN_GOVERNMENT

Foreign government. Applicable to Form W-8EXP

FOREIGN_CENTRAL_BANK_OF_ISSUE

Foreign central bank of issue. Applicable to Form W-8EXP

FOREIGN_TAX_EXEMPT_ORGANIZATION

Foreign tax-exempt organization under section 501(c). Applicable to Form W-8EXP

FOREIGN_PRIVATE_FOUNDATION

Foreign private foundation. Applicable to Form W-8EXP

GOVERNMENT_OF_A_US_TERRITORY

Government of a US territory or political subdivision. Applicable to Form W-8EXP

QI

Qualified Intermediary. Applicable to Form W-8IMY

NONQUALIFIED_INTERMEDIARY

Nonqualified intermediary. Applicable to Form W-8IMY

TERRITORY_FINANCIAL_INSTITUTION

Territory financial institution. Applicable to Form W-8IMY

US_BRANCH

US branch. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_PARTNERSHIP

Withholding foreign partnership. Applicable to Form W-8IMY

WITHHOLDING_FOREIGN_TRUST

Withholding foreign trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_PARTNERSHIP

Nonwithholding foreign partnership. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_SIMPLE_TRUST

Nonwithholding foreign simple trust. Applicable to Form W-8IMY

NONWITHHOLDING_FOREIGN_GRANTOR_TRUST

Nonwithholding foreign grantor trust. Applicable to Form W-8IMY

beneficiary_tax_profile.profile_details.entry_to_us_datestring

Date of entry into the US, in YYYY-MM-DD format. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.exempt_from_withholdingboolean

Indicates whether compensation is exempt from withholding based on a tax treaty benefit. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.exemption_justificationstring

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.

beneficiary_tax_profile.profile_details.foreign_scholarboolean

Indicates whether the recipient is a foreign student, trainee, professor/teacher, or researcher. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.foreign_tax_identifierstring

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.

beneficiary_tax_profile.profile_details.has_non_compensatory_incomeboolean

Indicates whether the individual has received noncompensatory scholarship or fellowship income from the same withholding agent. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.independent_personal_servicesstring

Description of the personal services being provided. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.mailing_addressobject

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.

beneficiary_tax_profile.profile_details.mailing_address.address_line1string

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.

beneficiary_tax_profile.profile_details.mailing_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

beneficiary_tax_profile.profile_details.mailing_address.country_namestring

Country name.

beneficiary_tax_profile.profile_details.mailing_address.postcodestring

Postcode or zip code.

beneficiary_tax_profile.profile_details.mailing_address.statestring

Name of state.

beneficiary_tax_profile.profile_details.mailing_address.suburbstring

Name of city / suburb.

beneficiary_tax_profile.profile_details.mailing_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

beneficiary_tax_profile.profile_details.mailing_address.state_codestring

2-letter state code.

beneficiary_tax_profile.profile_details.non_compensatory_exempt_amountstring

Total income exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

beneficiary_tax_profile.profile_details.non_compensatory_tax_articlestring

Treaty article on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

beneficiary_tax_profile.profile_details.non_compensatory_tax_treatystring

Tax treaty on which the exemption from withholding is based. Applicable when type is 8233 and has_non_compensatory_income is true.

beneficiary_tax_profile.profile_details.non_compensatory_total_incomestring

Total amount of noncompensatory scholarship or fellowship income, in US dollars. Applicable when type is 8233 and has_non_compensatory_income is true.

beneficiary_tax_profile.profile_details.passport_numberstring

Passport number. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.reference_numberstring

Reference information for the withholding agent. Applicable when type is W_8_BEN_E, W_8_ECI, W_8_EXP, or W_8_IMY.

beneficiary_tax_profile.profile_details.tax_articlestring

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.

beneficiary_tax_profile.profile_details.tax_classificationobject

Federal tax classification. Applicable when type is W_9.

beneficiary_tax_profile.profile_details.tax_classification.typestring

Tax classification.

INDIVIDUAL_OR_SOLE_PROPRIETOR

Individual/sole proprietor or single-member LLC.

C_CORPORATION

C corporation.

S_CORPORATION

S corporation.

PARTNERSHIP

Partnership.

TRUST_OR_ESTATE

Trust or estate.

LLC

Limited liability company. Requires llc_type.

OTHER

Other entity. Specify the tax classification on the applicable form.

beneficiary_tax_profile.profile_details.tax_classification.has_foreign_beneficiariesboolean

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.

beneficiary_tax_profile.profile_details.tax_classification.llc_typestring

Tax classification of the LLC. Applicable when type is LLC.

C

C corporation

S

S corporation

P

Partnership

beneficiary_tax_profile.profile_details.tax_treatystring

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.

beneficiary_tax_profile.profile_details.taxable_income_itemsstring

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.

beneficiary_tax_profile.profile_details.total_compensationstring

Total compensation exempt from tax under the treaty, in US dollars. Applicable when type is 8233 and exempt_from_withholding is true.

beneficiary_tax_profile.profile_details.total_paid_compensationstring

Total compensation expected to be paid for services in this tax year, in US dollars. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.us_addressobject

Address in the United States. Applicable when type is 8233.

beneficiary_tax_profile.profile_details.us_address.address_line1string

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.

beneficiary_tax_profile.profile_details.us_address.country_codestring

Country code (2-letter ISO 3166-1 alpha-2 country code).

beneficiary_tax_profile.profile_details.us_address.country_namestring

Country name.

beneficiary_tax_profile.profile_details.us_address.postcodestring

Postcode or zip code.

beneficiary_tax_profile.profile_details.us_address.statestring

Name of state.

beneficiary_tax_profile.profile_details.us_address.suburbstring

Name of city / suburb.

beneficiary_tax_profile.profile_details.us_address.address_line2string

An optional field that can be used to capture additional information about the address, such as the apartment/suite number, or floor number.

beneficiary_tax_profile.profile_details.us_address.state_codestring

2-letter state code.

beneficiary_tax_profile.profile_details.visa_typestring

US visa type (e.g. F-1, J-1, M-1). Applicable when type is 8233.

beneficiary_tax_profile.profile_details.w8_exp_certificationobject

Chapter 3 status specific certifications. Applicable when type is W_8_EXP.

beneficiary_tax_profile.profile_details.w8_exp_certification.controlled_entityboolean

Certifies the entity is a controlled entity of the government. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

beneficiary_tax_profile.profile_details.w8_exp_certification.controlling_government_namestring

The name of the government that controls the entity. (line 10c) Applicable when entity_type is FOREIGN_GOVERNMENT.

beneficiary_tax_profile.profile_details.w8_exp_certification.foreign_central_bank_of_issueboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.foreign_governmentboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.has_irs_determination_letterboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.has_us_counsel_opinionboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.integral_part_government_namestring

The name of the government of which the entity is an integral part. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

beneficiary_tax_profile.profile_details.w8_exp_certification.integral_part_of_governmentboolean

Certifies the entity is an integral part of the government. (line 10b) Applicable when entity_type is FOREIGN_GOVERNMENT.

beneficiary_tax_profile.profile_details.w8_exp_certification.international_organizationboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.irs_determination_letter_datestring

Date of the IRS determination letter, in YYYY-MM-DD format. (line 13a) Applicable when entity_type is FOREIGN_TAX_EXEMPT_ORGANIZATION.

beneficiary_tax_profile.profile_details.w8_exp_certification.no_commercial_activityboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.no_us_commercial_activityboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.not_private_foundationboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.private_foundationboolean

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.

beneficiary_tax_profile.profile_details.w8_exp_certification.us_territory_governmentboolean

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.

beneficiary_tax_profile.profile_details.w8_imy_certificationobject

Certifications for the entity's role as an intermediary or flow-through entity. Applicable when type is W_8_IMY.

beneficiary_tax_profile.profile_details.w8_imy_certification.nonqualified_intermediaryobject

Certifications for a Nonqualified Intermediary. Applicable when entity_type is NONQUALIFIED_INTERMEDIARY.

beneficiary_tax_profile.profile_details.w8_imy_certification.nonqualified_intermediary.assumes_primary_withholding_as_qslboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonqualified_intermediary.has_provide_withholding_statementboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonqualified_intermediary.meets_requirements_for_us_payee_poolboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonqualified_intermediary.not_acting_as_qiboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonqualified_intermediary.withholding_statement_consistency_verifiedboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entityobject

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.

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entity.acts_on_behalf_of_grantorsboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_provide_modified_amount_statementboolean

Certifies the entity is providing a withholding statement for a modified amount realized from the transfer (Line 21d).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entity.has_receive_amount_from_partnership_transferboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entity.non_eci_paymentboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entity.partner_in_lower_tier_partnershipboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.nonwithholding_foreign_entity.reliable_for_alternative_withholdingboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qiobject

Certifications for a Qualified Intermediary. Applicable when entity_type is QI.

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.assumes_1099_reporting_for_us_personsboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.assumes_primary_withholdingboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_ptp_nomineeboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.assumes_primary_withholding_as_qslboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.assumes_primary_withholding_ptp_salesboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.assumes_primary_withholding_us_interestboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.does_not_assume_1099_reportingboolean

Certifies the entity does NOT assume primary Form 1099 reporting and backup withholding responsibility for identified accounts (Line 15g).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.has_documentation_for_us_payee_poolboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.meets_requirements_for_us_payee_poolboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.qdd_statusboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.qi.qi_statusboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institutionobject

Certifications for a Territory Financial Institution. Applicable when entity_type is TERRITORY_FINANCIAL_INSTITUTION.

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institution.agrees_act_as_nominee_for_ptp_distributionsboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_personboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institution.agrees_treat_as_us_person_for_ptp_salesboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institution.has_provide_withholding_statementboolean

Certifies the entity is using this form to transmit withholding certificates and/or documentation and will provide a withholding statement (Line 18c).

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institution.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements for distributions (Line 18f).

beneficiary_tax_profile.profile_details.w8_imy_certification.territory_financial_institution.territory_financial_institutionboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branchobject

Certifications for a US Branch. Applicable when entity_type is US_BRANCH.

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branch.agrees_act_as_nominee_for_ptp_distributionsboolean

Certifies the entity is a US branch treated as a US person and as a nominee for distributions by publicly traded partnerships (Line 19e).

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branch.agrees_act_as_us_person_for_ptp_salesboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branch.agrees_treat_as_us_personboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branch.has_provide_withholding_statementboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branch.not_nominee_for_ptp_distributionsboolean

Certifies the entity is NOT acting as a nominee for distributions from publicly traded partnerships and is providing withholding statements (Line 19f).

beneficiary_tax_profile.profile_details.w8_imy_certification.us_branch.us_branchboolean

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).

beneficiary_tax_profile.profile_details.w8_imy_certification.withholding_foreign_entityobject

Certifications for a Withholding Foreign Partnership or Withholding Foreign Trust. Applicable when entity_type is WITHHOLDING_FOREIGN_PARTNERSHIP or WITHHOLDING_FOREIGN_TRUST.

beneficiary_tax_profile.profile_details.w8_imy_certification.withholding_foreign_entity.compliance_with_agreementboolean

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).

beneficiary_tax_profile.requirementsobject

Further information required in order to proceed with this tax profile. Present when status is ACTION_REQUIRED.

beneficiary_tax_profile.requirements.payer_info_requiredarray

Details about what payer information is incomplete.

beneficiary_tax_profile.requirements.payer_info_required.descriptionstring

A detailed message describing the missing information.

beneficiary_tax_profile.requirements.payer_info_required.typestring

Type of information that is missing or incorrect.

TAX_IDENTIFIER

The payer's tax identifier is missing or incorrect

STATE

The payer's state is missing or incorrect

CITY

The payer's city is missing or incorrect

COUNTRY_CODE

The payer's country code is missing or incorrect

BUSINESS_NAME

The payer's business name is missing or incorrect

PHONE_NUMBER

The payer's phone number is missing or incorrect

beneficiary_tax_profile.signature_namestring

Full legal name of the individual who provided the electronic signature.

beneficiary_tax_profile.supporting_documentsarray

Additional files uploaded for different supporting purposes.

beneficiary_tax_profile.supporting_documents.file_idstring

The file ID returned when the document was uploaded to the file service.

beneficiary_tax_profile.supporting_documents.tagstring

Purpose of the supporting document. The applicable values depend on the tax form type.

RESIDENCY_PROOF

Supporting document if the address is not in the US. Applicable when the form type is W_9

NON_US_TAX_PROOF

Supporting 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_STATEMENT

Statement of taxable income items. Applicable when the form type is W_8_ECI

WITHHOLDING_CERTIFICATION

Certification 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_STATEMENT

Statement 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_STATEMENT

Statement 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_CONCLUSION

Opinion 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

AFFIDAVIT

Affidavit 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_ATTACHMENT

Statement required for the tax treaty exemption procedure for foreign scholars. Applicable when the form type is 8233 and foreign_scholar is true

beneficiary_tax_profile.supporting_documents.descriptionstring

Additional description of the file.

beneficiary_tax_profile.updated_atstring

Time when the tax profile was last updated, in ISO 8601 format.

created_atstring

Time when the amendment was created, in ISO 8601 format.

idstring

Unique ID of the amendment.

statusstring

Status of the amendment.

PENDING

The amendment is pending review

APPROVED

The amendment is approved

REJECTED

The amendment is rejected

updated_atstring

Time when the amendment was last updated, in ISO 8601 format.

Errors
Error statusDescription
400

Possible errors: invalid_argument, bad_request

404

Possible errors: not_found

GET /api/v1/beneficiary_tax_profiles/{id}/amendments/{amendment_id}
$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'
Response (200 OK)
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": true
41 },
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}
Was this section helpful?