Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB
Tax

Submit W-8BEN-E tax form

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 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 for withholding

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

us_tin_type'SSN' | 'ITIN'

Type of US TIN (if applicable)

us_tinstring

US Taxpayer Identification Number (if applicable)

giinstring

Global Intermediary Identification Number

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

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