Skip to main content

Get a W-8BEN-E

GET 

/api/v8/partner/w-8ben-e/:document_id

Veryfi's Get a W-8BEN-E endpoint allows you to retrieve a previously processed W-8BEN-E.

Request

Path Parameters

    document_id int64required

    The unique identifier of the document.

Query Parameters

    detailed boolean

    This field was deprecated on 2023-08-20. Use bounding_boxes and confidence_details.

    bounding_boxes boolean

    A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.

    confidence_details boolean

    A field used to determine whether or not to return the score and ocr_score fields in the Document response.

Responses

Returns a processed W-8BEN-E.

Schema
    anyOf
    pdf_url urirequired

    Possible values: non-empty and <= 2083 characters

    A signed URL to access the auto-generated PDF created from the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.

    id integerrequired

    The unique number created to identify the document.

    certify_checkbox booleanrequired
    field_1_name stringrequired

    Possible values: non-empty

    field_2_country stringrequired

    Possible values: non-empty

    field_3_disregarded_entity_name stringrequired

    Possible values: non-empty

    field_4_checkbox_central_issue_bank booleanrequired
    field_4_checkbox_complex_trust booleanrequired
    field_4_checkbox_corporation booleanrequired
    field_4_checkbox_disregarded_entity booleanrequired
    field_4_checkbox_estate booleanrequired
    field_4_checkbox_foreign_government_controlled_entity booleanrequired
    field_4_checkbox_foreign_government_integral_part booleanrequired
    field_4_checkbox_grantor_trust booleanrequired
    field_4_checkbox_hybrid_no booleanrequired
    field_4_checkbox_hybrid_yes booleanrequired
    field_4_checkbox_international_organization booleanrequired
    field_4_checkbox_partnership booleanrequired
    field_4_checkbox_private_foundation booleanrequired
    field_4_checkbox_simple_trust booleanrequired
    field_4_checkbox_tax_exempt_organization booleanrequired
    field_5_checkbox_active_nffe booleanrequired
    field_5_checkbox_certain_investment_entities_that_do_not_maintain_financial_accounts booleanrequired
    field_5_checkbox_certified_deemed_compliant_ffi_low_value_accounts booleanrequired
    field_5_checkbox_certified_deemed_compliant_limited_life_debt_investment_entity booleanrequired
    field_5_checkbox_certified_deemed_compliant_nonregistering_local_bank booleanrequired
    field_5_checkbox_certified_deemed_compliant_sponsored_closely_held_investment_vehicle booleanrequired
    field_5_checkbox_direct_reporting_nffe booleanrequired
    field_5_checkbox_entity_wholly_owned_exempt booleanrequired
    field_5_checkbox_excepted_inter_affiliate_ffi booleanrequired
    field_5_checkbox_excepted_nonfiancial_entity_bankruptcy booleanrequired
    field_5_checkbox_excepted_nonfiancial_group_entity booleanrequired
    field_5_checkbox_excepted_nonfiancial_start_up booleanrequired
    field_5_checkbox_excepted_territory_nffe booleanrequired
    field_5_checkbox_exempt_retirement_plans booleanrequired
    field_5_checkbox_foreign_government booleanrequired
    field_5_checkbox_international_organization booleanrequired
    field_5_checkbox_nonparticipating_ffi booleanrequired
    field_5_checkbox_nonprofit booleanrequired
    field_5_checkbox_nonreporting_iga_ffi booleanrequired
    field_5_checkbox_not_financial_account booleanrequired
    field_5_checkbox_organization_501c booleanrequired
    field_5_checkbox_owner_documented_ffi booleanrequired
    field_5_checkbox_participating_ffi booleanrequired
    field_5_checkbox_passive_nffe booleanrequired
    field_5_checkbox_publicly_traded_nffe booleanrequired
    field_5_checkbox_registered_deemed_compliant_ffi booleanrequired
    field_5_checkbox_reporting_model_one_ffi booleanrequired
    field_5_checkbox_reporting_model_two_ffi booleanrequired
    field_5_checkbox_restricted_distributor booleanrequired
    field_5_checkbox_sponsored_direct_reporting_nffe booleanrequired
    field_5_checkbox_sponsored_ffi booleanrequired
    field_5_checkbox_territory_financial_institutions booleanrequired
    field_6_address stringrequired

    Possible values: non-empty

    field_6_city stringrequired

    Possible values: non-empty

    field_6_country stringrequired

    Possible values: non-empty

    field_7_mailing_city stringrequired

    Possible values: non-empty

    field_7_mailing_country stringrequired

    Possible values: non-empty

    field_7_mailing_street stringrequired

    Possible values: non-empty

    field_8_tin stringrequired

    Possible values: non-empty

    field_9a_giin stringrequired

    Possible values: non-empty

    field_9b_foreign_tin stringrequired

    Possible values: non-empty

    field_9c_checkbox_tin_not_required booleanrequired
    field_10_reference_number stringrequired

    Possible values: non-empty

    field_11_checkbox_branch_nonparticipating_ffi booleanrequired
    field_11_checkbox_participating_ffi booleanrequired
    field_11_checkbox_reporting_model_one_ffi booleanrequired
    field_11_checkbox_reporting_model_two_ffi booleanrequired
    field_11_checkbox_us_branch booleanrequired
    field_12_disregarded_entity_city stringrequired

    Possible values: non-empty

    field_12_disregarded_entity_country stringrequired

    Possible values: non-empty

    field_12_disregarded_entity_street stringrequired

    Possible values: non-empty

    field_13_disregarded_entity_giin stringrequired

    Possible values: non-empty

    field_14a_checkbox booleanrequired
    field_14a_resident_of stringrequired

    Possible values: non-empty

    field_14b_checkbox_active_trade_or_business_test booleanrequired
    field_14b_checkbox_benefit_items booleanrequired
    field_14b_checkbox_derivative_benefits_test booleanrequired
    field_14b_checkbox_favorable booleanrequired
    field_14b_checkbox_government booleanrequired
    field_14b_checkbox_no_lob_article_in_treaty booleanrequired
    field_14b_checkbox_other_tax_exempt booleanrequired
    field_14b_checkbox_other booleanrequired
    field_14b_checkbox_ownership_and_base_erosion_test booleanrequired
    field_14b_checkbox_publicly_traded_corporation booleanrequired
    field_14b_checkbox_subsidiary_of_publicly_traded_corporation booleanrequired
    field_14b_checkbox_tax_exempt_pension booleanrequired
    field_14b_other_article stringrequired

    Possible values: non-empty

    field_14c_checkbox_dividends booleanrequired
    field_15_special_rates_article stringrequired

    Possible values: non-empty

    field_15_special_rates_explanation stringrequired

    Possible values: non-empty

    field_15_special_rates_income_type stringrequired

    Possible values: non-empty

    field_15_special_rates_percentage stringrequired

    Possible values: non-empty

    field_16_name stringrequired

    Possible values: non-empty

    field_17a_checkbox booleanrequired
    field_17b_checkbox booleanrequired
    field_18_checkbox booleanrequired
    field_19_checkbox booleanrequired
    field_20_name stringrequired

    Possible values: non-empty

    field_21_checkbox booleanrequired
    field_22_checkbox booleanrequired
    field_23_checkbox booleanrequired
    field_24a_checkbox booleanrequired
    field_24b_checkbox booleanrequired
    field_24c_checkbox booleanrequired
    field_24d_checkbox booleanrequired
    field_25a_checkbox booleanrequired
    field_25b_checkbox booleanrequired
    field_25c_checkbox booleanrequired
    field_26_checkbox_model_one booleanrequired
    field_26_checkbox_model_two booleanrequired
    field_26_checkbox_trustee_foreign booleanrequired
    field_26_checkbox_trustee_us booleanrequired
    field_26_checkbox booleanrequired
    field_26_country stringrequired

    Possible values: non-empty

    field_26_treated_as stringrequired

    Possible values: non-empty

    field_26_trustee_name stringrequired

    Possible values: non-empty

    field_27_checkbox booleanrequired
    field_28a_checkbox booleanrequired
    field_28b_checkbox booleanrequired
    field_29a_checkbox booleanrequired
    field_29b_checkbox booleanrequired
    field_29c_checkbox booleanrequired
    field_29d_checkbox booleanrequired
    field_29e_checkbox booleanrequired
    field_29f_checkbox booleanrequired
    field_30_checkbox booleanrequired
    field_31_checkbox booleanrequired
    field_32_checkbox booleanrequired
    field_33_checkbox booleanrequired
    field_33_date daterequired
    field_34_checkbox booleanrequired
    field_34_date daterequired
    field_35_checkbox booleanrequired
    field_35_date daterequired
    field_36_checkbox booleanrequired
    field_37a_checkbox booleanrequired
    field_37a_name stringrequired

    Possible values: non-empty

    field_37b_checkbox booleanrequired
    field_37b_market_name stringrequired

    Possible values: non-empty

    field_37b_name stringrequired

    Possible values: non-empty

    field_38_checkbox booleanrequired
    field_39_checkbox booleanrequired
    field_40a_checkbox booleanrequired
    field_40b_checkbox booleanrequired
    field_40c_checkbox booleanrequired
    field_41_checkbox booleanrequired
    field_42_name stringrequired

    Possible values: non-empty

    field_43_checkbox booleanrequired
    passive_nffe_owners object[]required
  • Array [
  • name string

    Possible values: non-empty

    address string

    Possible values: non-empty

    tin string

    Possible values: non-empty

  • ]
  • signature_date daterequired
    signature_name stringrequired

    Possible values: non-empty

    signed booleanrequired
Loading...