Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB
Tax

Submit W-8IMY tax form

This POST endpoint is used to submit a W-8IMY tax form (for foreign intermediaries, foreign flow-through entities, or certain U.S. branches) 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/w8imy

Request body

disregarded_entity_namestring

Disregarded entity name (if applicable)

chapter_3_status'QI_INCLUDING_A_QDD' | 'NONQUALIFIED_INTERMEDIARY' | 'TERRITORY_FINANCIAL_INSTITUTION' | 'US_BRANCH' | 'WITHHOLDING_FOREIGN_PARTNERSHIP' | 'WITHHOLDING_FOREIGN_TRUST' | 'NONWITHHOLDING_FOREIGN_PARTNERSHIP' | 'NONWITHHOLDING_FOREIGN_SIMPLE_TRUST' | 'NONWITHHOLDING_FOREIGN_GRANTOR_TRUST' required

Chapter 3 status for withholding

chapter_4_status'NONPARTICIPATING_FFI' | 'PARTICIPATING_FFI' | 'REPORTING_MODEL1_FFI' | 'REPORTING_MODEL2_FFI' | 'REGISTERED_DEEMED_COMPLIANT_FFI' | 'TERRITORY_FINANCIAL_INSTITUTION' | 'SPONSORED_FFI' | 'CERTIFIED_DEEMED_COMPLIANT_NONREGISTERING_LOCAL_BANK' | 'CERTIFIED_DEEMED_COMPLIANT_FFI_WITH_ONLY_LOW_VALUE_ACCOUNTS' | 'CERTIFIED_DEEMED_COMPLIANT_SPONSORED_CLOSELY_HELD_INVESTMENT_VEHICLE' | 'CERTIFIED_DEEMED_COMPLIANT_LIMITED_LIFE_DEBT_INVESTMENT_ENTITY' | 'CERTAIN_INVESTMENT_ENTITIES_THAT_DO_NOT_MAINTAIN_FINANCIAL_ACCOUNTS' | 'OWNER_DOCUMENTED_FFI' | 'RESTRICTED_DISTRIBUTOR' | 'FOREIGN_CENTRAL_BANK_OF_ISSUE' | 'NONREPORTING_IGA_FFI' | 'EXEMPT_RETIREMENT_PLANS' | 'EXCEPTED_NONFINANCIAL_GROUP_ENTITY' | 'EXCEPTED_NONFINANCIAL_START_UP_COMPANY' | 'EXCEPTED_NONFINANCIAL_ENTITY_IN_LIQUIDATION_OR_BANKRUPTCY' | 'PUBLICLY_TRADED_NFFE_OR_NFFE_AFFILIATE_OF_A_PUBLICLY_TRADED_CORPORATION' | 'EXCEPTED_TERRITORY_NFFE' | 'ACTIVE_NFFE' | 'PASSIVE_NFFE' | 'DIRECT_REPORTING_NFFE' | 'SPONSORED_DIRECT_REPORTING_NFFE' required

Chapter 4 (FATCA) status

us_tin_type'QI-EIN' | 'WP-EIN' | 'WT-EIN' | 'EIN'

Type of US TIN

us_tinstring

US Taxpayer Identification Number

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

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