Skip to main content

Get W-9s

GET 

/api/v8/partner/w9s

Get W-9s

Request

Query Parameters

    meta.tags array

    Return documents containing these tags.

    Example: a
    meta.external_id string

    Return documents with this meta.external_id.

    Example: 123f-2aa-33cc
    created_date__gt string

    Return documents created after this date and time in ISO 8601 format.

    Example: 2022-05-03 00:00:00
    created_date__lt string

    Return documents created before this date and time in ISO 8601 format.

    Example: 2023-03-23 00:00:00
    created_date__gte string

    Return documents created beginning at this date and time in ISO 8601 format.

    Example: 2022-04-24 00:00:00
    created_date__lte string

    Return documents created on and before this date and time in ISO 8601 format.

    Example: 2020-10-15 00:00:00
    updated_date__gt string

    Return documents updated after this date and time in ISO 8601 format.

    Example: 2023-07-25 00:00:00
    updated_date__lt string

    Return documents updated before this date and time in ISO 8601 format.

    Example: 2019-03-18 00:00:00
    updated_date__gte string

    Return documents updated beginning at this date and time in ISO 8601 format.

    Example: 2020-02-03 00:00:00
    updated_date__lte string

    Return documents updated on and before this date and time in ISO 8601 format.

    Example: 2023-01-03 00:00:00
    page integer

    Default value: 1

    The page number. The response is capped to maximum of 50 results per page.

    page_size integer

    Default value: 50

    The number of Documents per page.

    Example: 10
    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.

    q string

    Case sensitive. Return documents with this text or any extracted fields matching the value. Use asterisk for partial matches, e.g. q=Walmart* will return documents with either Walmart in ocr text or any extracted field containing Walmart.

    Example: Starbucks
    track_total_results boolean

    Whether to always return accurate count of results, true makes it slower.

Responses

A list of W-9s

Schema
    anyOf
    count integerrequired

    The total number of results retrieved across all pages.

    next (string | null)

    The URL to the next page of results.

    previous (string | null)

    The URL to the previous page of results.

    results object[]required

    The collection of processed W-9 documents

  • Array [
  • external_id (string | null)

    Possible values: non-empty

    A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.

    meta object
    external_id (string | null)

    Possible values: non-empty

    A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.

    pages object[]
  • Array [
  • ocr_score (number | null)

    Possible values: <= 1

    The average OCR score of the page.

    width (integer | null)

    The width of the page.

    height (integer | null)

    The height of the page.

  • ]
  • tags string[]

    Possible values: non-empty

    Default value: ``

    Tags associated with the document.

    ocr_score (number | null)

    Possible values: <= 1

    The average OCR score of the whole document.

    model (string | null)

    Possible values: non-empty

    The version of the model used to process the document.

    pdf_url uri

    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.

    created_date date-timerequired
    updated_date date-timerequired
    img_thumbnail_url uri

    Possible values: non-empty and <= 2083 characters

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

    text (string | null)

    The text returned from converting the document into a machine-readable text format.

    account_numbers (string | null)

    The account numbers to a bank or brokerage account on Line 7 of the W-9.

    address1 (string | null)

    The address (number, street, and apt. or suite no.) on Line 5 of the W-9.

    address2 (string | null)

    The city, state, and zip on Line 6 of the W-9.

    parsed_address object

    An object representing detailed address-related information on the document, such as the city, state, street address, unit number, etc. Filled in the original POST request had the parameter parse_address set to true and the corresponding address is found on the document.

    building (string | null)

    Possible values: non-empty

    The building name e.g. 'Project 8' or 'Empire State Building'

    city (string | null)

    Possible values: non-empty

    The settlement including cities, towns, villages, hamlets, localities, etc.

    country (string | null)

    Possible values: non-empty

    The sovereign nations and their dependent territories, anything with an ISO-3166 code.

    country_alpha_2 (string | null)

    Possible values: non-empty

    The detected ISO 3166-1 alpha-2 code for a given country.

    postcode (string | null)

    Possible values: non-empty

    The postal code used for mail sorting

    state (string | null)

    Possible values: non-empty

    A first-level administrative division. Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well

    street_address (string | null)

    Possible values: non-empty

    A sum of house_number road, building, unit.

    house (string | null)

    Possible values: non-empty

    The venue name e.g. "Brooklyn Academy of Music", and building names e.g. "Empire State Building".

    house_number (string | null)

    Possible values: non-empty

    Usually refers to the external (street-facing) building number. In some countries this may be a compound, hyphenated number, which also includes an apartment number, or a block number (a la Japan).

    road (string | null)

    Possible values: non-empty

    Street name(s)

    unit (string | null)

    Possible values: non-empty

    An apartment, unit, office, lot, or other secondary unit designator.

    level (string | null)

    Possible values: non-empty

    The expressions indicating a floor number e.g. "3rd Floor", "Ground Floor", etc.

    staircase (string | null)

    Possible values: non-empty

    Numbered/lettered staircase

    entrance (string | null)

    Possible values: non-empty

    Numbered/lettered entrance

    po_box (string | null)

    Possible values: non-empty

    The post office box, typically found in non-physical (mail-only) addresses.

    suburb (string | null)

    Possible values: non-empty

    An unofficial neighborhood name like "Harlem", "South Bronx", or "Crown Heights".

    city_district (string | null)

    Possible values: non-empty

    The boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV".

    island (string | null)

    Possible values: non-empty

    Named islands e.g. "Maui"

    state_district (string | null)

    Possible values: non-empty

    Usually a second-level administrative division or county.

    country_region (string | null)

    Possible values: non-empty

    Informal subdivision of a country without any political status.

    world_region (string | null)

    Possible values: non-empty

    Only used for appending "West Indies" after the country name, a pattern frequently used in the English-speaking Caribbean e.g. "Jamaica, West Indies".

    business_name (string | null)

    The business name on Line 2 of the W-9.

    c_corp (boolean | null)

    A boolean indicating whether or not the LLC is identified as a C Corp and was checked in Box 3 of the W-9.

    ein (string | null)

    The Employer Identification Number (EIN) in Part I - Taxpayer Identification Number (TIN) on the W-9.

    exempt_payee_code (string | null)

    The exemption payee code in Box 4 of the W-9.

    exemption (string | null)

    The exemption in Box 4 of the W-9.

    individual (boolean | null)

    A boolean indicating whether or not Individual was checked in Box 3 of the W-9.

    llc (boolean | null)

    A boolean indicating whether or not Limited Liability Company was checked in Box 3 of the W-9.

    llc_type (string | null)required

    Possible values: [C, S, P]

    The tax classification found in Box 3 of the W-9.

    name (string | null)

    The full name found on Line 1 of the W-9.

    other_description (string | null)

    The comments or description found on the Other line in Box 3 of the W-9.

    other (boolean | null)

    A boolean indicating whether or not the Other box was checked in Box 3 of the W-9.

    partnership (boolean | null)

    A boolean indicating whether or not the LLC is identified as a Partnership and was checked in Box 3 of the W-9.

    requester (string | null)

    The requestor's name and address in the Box to the right of Line 5 of the W-9

    s_corp (boolean | null)

    A boolean indicating whether or not the LLC is identified as a S Corp and was checked in Box 3 of the W-9.

    signature_date (string | null)

    The date found on the Sign Here line under Part II - Certification of the W-9.

    signature (boolean | null)

    The signature found on the Sign Here line under Part II - Certification of the W-9

    ssn (string | null)

    The number found on Part I Taxpayer Identification Number (TIN) under Social Security Number of the W-9.

    trust_estate (boolean | null)

    A boolean indicating whether or not Trust/estate was checked in Box 3 of the W-9.

    3b_foreign (boolean | null)

    Foreign ownership interest. Returns null if the field did not appear on the document.

  • ]
Loading...