Get a W-9

GET 
/api/v8/partner/w9s/:document_id

Veryfi's Get a W-9 endpoint allows you to retrieve a previously processed W-9.

Request

Path Parameters

document_id int64required

The unique identifier of the document.

Query Parameters

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

200

Returns a processed W-9.

application/json

Schema

Schema

anyOf
API_V8_PARTNER_W9S_W9_V8
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.
API_V8_PARTNER_W9S_DETAILEDW9_V8
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 objectrequired
The account numbers to a bank or brokerage account on Line 7 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
address1 objectrequired
The address (number, street, and apt. or suite no.) on Line 5 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
address2 objectrequired
The city, state, and zip on Line 6 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
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 object
The building name e.g. 'Project 8' or 'Empire State Building'
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
city object
The settlement including cities, towns, villages, hamlets, localities, etc.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
country object
The sovereign nations and their dependent territories, anything with an ISO-3166 code.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
country_alpha_2 object
The detected ISO 3166-1 alpha-2 code for a given country.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
postcode object
The postal code used for mail sorting
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
state object
A first-level administrative division. Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
street_address object
A sum of house_number road, building, unit.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
house object
The venue name e.g. "Brooklyn Academy of Music", and building names e.g. "Empire State Building".
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
house_number object
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).
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
road object
Street name(s)
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
unit object
An apartment, unit, office, lot, or other secondary unit designator.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
level object
The expressions indicating a floor number e.g. "3rd Floor", "Ground Floor", etc.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
staircase object
Numbered/lettered staircase
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
entrance object
Numbered/lettered entrance
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
po_box object
The post office box, typically found in non-physical (mail-only) addresses.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
suburb object
An unofficial neighborhood name like "Harlem", "South Bronx", or "Crown Heights".
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
city_district object
The boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV".
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
island object
Named islands e.g. "Maui"
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
state_district object
Usually a second-level administrative division or county.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
country_region object
Informal subdivision of a country without any political status.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
world_region object
Only used for appending "West Indies" after the country name, a pattern frequently used in the English-speaking Caribbean e.g. "Jamaica, West Indies".
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
value (string | null)required
Possible values: non-empty
The extracted value.
business_name objectrequired
The business name on Line 2 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
c_corp objectrequired
A boolean indicating whether or not the LLC is identified as a C Corp and was checked in Box 3 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (boolean | null)required
ein objectrequired
The Employer Identification Number (EIN) in Part I - Taxpayer Identification Number (TIN) on the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
exempt_payee_code objectrequired
The exemption payee code in Box 4 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
exemption objectrequired
The exemption in Box 4 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
individual objectrequired
A boolean indicating whether or not Individual was checked in Box 3 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (boolean | null)required
llc objectrequired
A boolean indicating whether or not Limited Liability Company was checked in Box 3 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (boolean | null)required
llc_type objectrequired
The tax classification found in Box 3 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: [C, S, P]
The tax classification found in Box 3 of the W-9.
name objectrequired
The full name found on Line 1 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
other_description objectrequired
The comments or description found on the Other line in Box 3 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
other objectrequired
A boolean indicating whether or not the Other box was checked in Box 3 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (boolean | null)required
partnership objectrequired
A boolean indicating whether or not the LLC is identified as a Partnership and was checked in Box 3 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (boolean | null)required
requester objectrequired
The requestor's name and address in the Box to the right of Line 5 of the W-9
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
s_corp objectrequired
A boolean indicating whether or not the LLC is identified as a S Corp and was checked in Box 3 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (boolean | null)required
signature_date objectrequired
The date found on the Sign Here line under Part II - Certification of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
signature objectrequired
The signature found on the Sign Here line under Part II - Certification of the W-9
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (boolean | null)required
ssn objectrequired
The number found on Part I Taxpayer Identification Number (TIN) under Social Security Number of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
trust_estate objectrequired
A boolean indicating whether or not Trust/estate was checked in Box 3 of the W-9.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (boolean | null)required
3b_foreign objectrequired
Foreign ownership interest. Returns null if the field did not appear on the document.
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (boolean | null)required

Example (from schema)

{}

Loading...