Tax

Submit W-8BEN-E tax form

Changed on

This POST endpoint is used to submit a W-8BEN-E tax form (for foreign entities) for a specific user identified by their user_token. Basic information (name, address, phone) is retrieved from the user's existing profile.

post/payout/{user_token}/tax/interview/w8bene

Request

Request body

organization_namestring required

Name of the organization

country_of_organizationstring required

Two-letter country code of organization

disregarded_entity_namestring

Disregarded entity name (if applicable)

chapter_3_status'SIMPLE TRUST' | 'CENTRAL BANK OF ISSUE' | 'GRANTOR TRUST' | 'TAX EXEMPT ORGANIZATION' | 'PRIVATE FOUNDATION' | 'DISREGARDED ENTITY' | 'CORPORATION' | 'COMPLEX TRUST' | 'ESTATE' | 'INTERNATIONAL ORGANIZATION' | 'PARTNERSHIP' | 'FOREIGN CONTROLLED ENTITY' | 'FOREIGN INTERGRAL PART' required

Chapter 3 status. FOREIGN CONTROLLED ENTITY and FOREIGN INTERGRAL PART are the IRS 'Foreign government - controlled entity' and 'Foreign government - integral part' statuses. DISREGARDED ENTITY requires disregarded_entity_branch.

chapter_4_status'NONPARTICIPATING FFI' | 'PARTICIPATING FFI' | 'REPORTING MODEL1 FFI' | 'REPORTING MODEL2 FFI' | 'REGISTERED FFI' | 'SPONSORED FFI' | 'NONREGISTERING LOCALBANK' | 'FFI LOWVALUE ACCOUNT' | 'SPONSORED INVESTMENT VEHICLE' | 'LIMITED LIFEDEBT INVESTMENT' | 'NO FINANCIAL ACCOUNT' | 'OWNER DOCUMENTED FFI' | 'RESTRICTED DISTRIBUTOR' | 'NONREPORTING IGA FFI' | 'FOREIGN GOVERNMENT' | 'INTERNATIONAL ORGANIZATION' | 'EXEMPT RETIREMENT PLANS' | 'EXEMPT BENEFICIAL OWNERS' | 'TERRITORY FINANCIAL INSTITUTION' | 'EXCEPTED NONFINANCIAL GROUP' | 'EXCEPTED NONFINANCIAL STARTUP' | 'EXCEPTED NONFINANCIAL LIQUIDATION BANKRUPTCY' | '501C ORGANIZATION' | 'NONPROFIT ORGANIZATION' | 'PUBLICLY TRADED NFFE' | 'EXCEPTED TERRITORY NFFE' | 'ACTIVE NFFE' | 'PASSIVE NFFE' | 'EXCEPTED INTER AFFILIATE FFI' | 'DIRECT REPORTING NFFE' | 'SPONSORED DIRECT REPORTING FFI' | 'NON FINANCIAL ACCOUNT' required

Chapter 4 (FATCA) status. The certification part the IRS form requires for the selected status is filled automatically; statuses that certify extra facts take them from chapter_4_certification: SPONSORED FFI (sponsoring_entity_name, sponsored_ffi_type), OWNER DOCUMENTED FFI (certification_line 24b-24d), RESTRICTED DISTRIBUTOR (certification_line 25b-25c), NONREPORTING IGA FFI (iga_country, iga_model, iga_treated_as), INTERNATIONAL ORGANIZATION (certification_line 28a-28b), EXEMPT RETIREMENT PLANS (certification_line 29a-29f), EXCEPTED NONFINANCIAL STARTUP (formed_on), 501C ORGANIZATION (irs_determination_letter_date), PUBLICLY TRADED NFFE (securities_market_name, or affiliate_entity_name + affiliate_securities_market_name), SPONSORED DIRECT REPORTING FFI (sponsoring_entity_name). DIRECT REPORTING NFFE and the participating / reporting / registered / sponsored FFI statuses require giin. The tax provider currently rejects NONREPORTING IGA FFI, NONREGISTERING LOCALBANK, FFI LOWVALUE ACCOUNT, SPONSORED INVESTMENT VEHICLE, LIMITED LIFEDEBT INVESTMENT, NO FINANCIAL ACCOUNT, FOREIGN GOVERNMENT and EXCEPTED NONFINANCIAL LIQUIDATION BANKRUPTCY; submissions with those values return 400 before reaching the provider.

us_tin_type'SSN' | 'ITIN'

Type of US TIN (if applicable)

us_tinstring

US Taxpayer Identification Number (if applicable)

giinstring

Global Intermediary Identification Number in the IRS format XXXXXX.XXXXX.XX.XXX: 6 alphanumerics (FATCA ID), 5 alphanumerics (financial institution type), a 2-letter category code (LE, SL, ME, BR, SP, SD, SF, SS or SB) and the 3-digit ISO numeric country code. Required for DIRECT REPORTING NFFE and the participating / reporting / registered / sponsored FFI statuses.

foreign_tinstring

Foreign Tax Identification Number

is_ftin_not_legally_requiredboolean

Check if FTIN is not legally required

reference_numberstring

Reference number for your records

is_hybrid_entity_treaty_claimboolean

Is entity a hybrid making a treaty claim

limitation_on_benefits'GOVERNMENT' | 'TAX-EXEMPT PENSION TRUST OR PENSION FUND' | 'OTHER TAX-EXEMPT ORGANIZATION' | 'PUBLICLY TRADED CORPORATION' | 'SUBSIDIARY OF A PUBLICLY TRADED CORPORATION' | 'COMPANY THAT MEETS THE OWNERSHIP AND BASE EROSION TEST' | 'COMPANY THAT MEETS THE DERIVATIVE BENEFITS TEST' | 'COMPANY WITH AN ITEM OF INCOME THAT MEETS ACTIVE TRADE OR BUSINESS TEST' | 'FAVORABLE DISCRETIONARY DETERMINATION BY THE U.S. COMPETENT AUTHORITY RECEIVED' | 'NO LOB ARTICLE IN TREATY' | 'OTHER'

Limitation on benefits provision (Part III line 14b). Accepted here or inside tax_treaty_benefits. OTHER requires limitation_on_benefits_other_detail.

limitation_on_benefits_other_detailstring

Article and paragraph relied on when limitation_on_benefits is OTHER

Example request

{
  "giin": "98Q96B.00000.LE.724",
  "chapter_4_certification": {
    "certification_line": "24b"
  }
}

Response

OK

submission_idstring uuid

Unique identifier for the submission

form_type'W9' | 'W8BEN' | 'W8BENE' | 'W8ECI' | 'W8IMY'

Type of form submitted

status'Submitted' | 'Pending' | 'Validated' | 'Error'

Current status of the submission

submitted_atstring date-time

Timestamp of submission

pdf_contentstring

Base64 encoded byte representing the content of the file

Changes

    • breaking

      added the pattern ^[A-Z0-9]{6}\.[A-Z0-9]{5}\.[A-Z]{2}\.[0-9]{3}$ to the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new optional request property /