Process a W-9

POST 
/api/v8/partner/w9s

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

Request

application/json

Body

file_data string

Used to upload a document via base64 encoded string, could be raw or data URI scheme. This is the least effective way to upload a document for processing. See file_urls or uploading zip files.

file_url string

A URL to a publicly accessible document to be sent to Veryfi for processing.

file_urls string[]

An array of URLs to publicly accessible documents to be sent to Veryfi for processing.

package_path string

A path to a file in an S3 bucket, e.g. 'some/receipt.jpg

bucket string

An S3 bucket for 'package_path', e.g. 'documents'.

file_name string

An optional filename. Useful to determine file type.

detailed booleandeprecated

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.

multipart/form-data

Body

file_data string

Used to upload a document via base64 encoded string, could be raw or data URI scheme. This is the least effective way to upload a document for processing. See file_urls or uploading zip files.

file_url string

A URL to a publicly accessible document to be sent to Veryfi for processing.

file_urls string[]

An array of URLs to publicly accessible documents to be sent to Veryfi for processing.

package_path string

A path to a file in an S3 bucket, e.g. 'some/receipt.jpg

bucket string

An S3 bucket for 'package_path', e.g. 'documents'.

file_name string

An optional filename. Useful to determine file type.

file binary

A binary file. Submitting zipped documents through this parameter is the fastest way to process any document.

detailed booleandeprecated

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

201

Returns a processed W-9.

application/json

Schema

Schema

anyOf
W9_V8
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.
text stringrequired
The text returned from converting the document into a machine-readable text format.
account_numbers string
The account numbers to a bank or brokerage account on Line 7 of the W-9.
address1 string
The address (number, street, and apt. or suite no.) on Line 5 of the W-9.
address2 string
The city, state, and zip on Line 6 of the W-9.
business_name string
The business name on Line 2 of the W-9.
c_corp boolean
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
The Employer Identification Number (EIN) in Part I - Taxpayer Identification Number (TIN) on the W-9.
exempt_payee_code string
The exemption payee code in Box 4 of the W-9.
exemption string
The exemption in Box 4 of the W-9.
individual boolean
A boolean indicating whether or not Individual was checked in Box 3 of the W-9.
llc boolean
A boolean indicating whether or not Limited Liability Company was checked in Box 3 of the W-9.
llc_type stringrequired
Possible values: [C, S, P]
The tax classification found in Box 3 of the W-9.
name string
The full name found on Line 1 of the W-9.
other_description string
The comments or description found on the Other line in Box 3 of the W-9.
other boolean
A boolean indicating whether or not the Other box was checked in Box 3 of the W-9.
partnership boolean
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
The requestor's name and address in the Box to the right of Line 5 of the W-9
s_corp boolean
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
The date found on the Sign Here line under Part II - Certification of the W-9.
signature boolean
The signature found on the Sign Here line under Part II - Certification of the W-9
ssn string
The number found on Part I Taxpayer Identification Number (TIN) under Social Security Number of the W-9.
trust_estate boolean
A boolean indicating whether or not Trust/estate was checked in Box 3 of the W-9.
DetailedW9_V8
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.
text stringrequired
The text returned from converting the document into a machine-readable text format.
account_numbers object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: non-empty
The extracted value.
address1 objectrequired
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: non-empty
The extracted value.
address2 object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: non-empty
The extracted value.
business_name object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: non-empty
The extracted value.
c_corp object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value booleanrequired
ein object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: non-empty
The extracted value.
exempt_payee_code object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: non-empty
The extracted value.
exemption object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: non-empty
The extracted value.
individual object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value booleanrequired
llc object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value booleanrequired
llc_type object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: [C, S, P]
The tax classification found in Box 3 of the W-9.
name object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: non-empty
The extracted value.
other_description object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: non-empty
The extracted value.
other object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value booleanrequired
partnership object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value booleanrequired
requester object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: non-empty
The extracted value.
s_corp object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value booleanrequired
signature_date object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: non-empty
The extracted value.
signature object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value booleanrequired
ssn object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value stringrequired
Possible values: non-empty
The extracted value.
trust_estate object
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
]
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.
ocr_score number
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
score number
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.
rotation integer
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value booleanrequired

Example (from schema)

{}

400

User error

application/json

Schema

Schema

oneOf

COULDNT_DOWNLOAD_FILE_FROM_PROVIDED_URL

status string

Default value: fail

error string

Default value: Couldn't download file from provided url.

details undefined[]

Default value: [object Object]

RECEIVED_EMPTY_OR_MISSING_DATA

status string

Default value: fail

error string

Default value: Received empty or missing data

Example (from schema)

{}

404

Not found

application/json

Schema

Schema

oneOf

NOT_FOUND

status string

Default value: fail

error string

Default value: Not found.

DOCUMENT_NOT_FOUND

status string

Default value: fail

error string

Default value: Document Not Found

Example (from schema)

{}

429

Rate limit

application/json

Schema

Schema

oneOf

YOU_HAVE_BEEN_RATE_LIMITED

status string

Default value: fail

error string

Default value: You have been rate limited

details undefined[]

Default value: [object Object]

Example (from schema)

{}

499

User error

application/json

Schema

Schema

oneOf

CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION

status string

Default value: fail

error string

Default value: Client closed request or lost connection

Example (from schema)

{}

503

Service is temporaly unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

Default value: Service is temporaly unavailable. Please try again later

Example (from schema)

{}

default

OperationStatus

application/json

Schema

Schema

error stringrequired
details object[]
status string

Default value: fail

Example (from schema)

{
  "error": "string",
  "details": [
    {}
  ],
  "status": "fail"
}

Loading...