Client

Client

new Client(client_id, client_secret, username, api_key, base_url, timeout)

Create instance of a Client

Source:
Parameters:
Name Type Default Description
client_id string

Your Veryfi client id
client_secret string | undefined

Your Veryfi client secret
username string

Your Veryfi username
api_key string

Your Veryfi API key
base_url string https://api.veryfi.com/
timeout Number 120

Methods

add_tag(document_id, tag) → {JSON}

Add a new tag on an existing document. https://docs.veryfi.com/api/receipts-invoices/add-a-tag-to-a-document/

Source:
Parameters:
Name Type Description
document_id number

ID of the document you'd like to add a Tag
tag string

name to add
Returns:
Type:
JSON

response about tag added.

add_tags(document_id, tags) → {JSON}

Add multiple tags on an existing document. https://docs.veryfi.com/api/receipts-invoices/add-tags-to-a-document/

Source:
Parameters:
Name Type Description
document_id number

ID of the document you'd like to add a Tag
tags Array.<string>

array of tags to be added
Returns:
Type:
JSON

response about tag added.

delete_bank_statement(document_id)

Delete a Bank Statement from Veryfi. https://docs.veryfi.com/api/bank-statements/delete-a-bank-statement/

Source:
Parameters:
Name Type Description
document_id string

ID of the document you'd like to delete

delete_business_card(document_id)

Delete a Business Card from Veryfi. https://docs.veryfi.com/api/business-cards/delete-a-business-card/

Source:
Parameters:
Name Type Description
document_id string

ID of the document you'd like to delete

delete_check(document_id)

Delete a Check from Veryfi. https://docs.veryfi.com/api/checks/delete-a-check/

Source:
Parameters:
Name Type Description
document_id string

ID of the document you'd like to delete

delete_document(document_id)

Delete document from Veryfi. https://docs.veryfi.com/api/receipts-invoices/delete-a-document/

Source:
Parameters:
Name Type Description
document_id string

ID of the document you'd like to delete

delete_tags(document_id) → {JSON}

Delete all the tags on an existing document. https://docs.veryfi.com/api/receipts-invoices/unlink-all-tags-from-a-document/

Source:
Parameters:
Name Type Description
document_id number

ID of the document you'd like to delete tags
Returns:
Type:
JSON

response about deleted tags.

delete_w2(document_id)

Delete w2 document from Veryfi https://docs.veryfi.com/api/w2s/delete-a-w-2/

Source:
Parameters:
Name Type Description
document_id string

ID of the document you'd like to delete

delete_w8bene(document_id)

Delete a W-8BEN-E from Veryfi. https://docs.veryfi.com/api/w-8ben-e/delete-a-w-8-ben-e/

Source:
Parameters:
Name Type Description
document_id string

ID of the document you'd like to delete

delete_w9(document_id)

Delete w9 document from Veryfi. https://docs.veryfi.com/api/w9s/delete-a-w-9/

Source:
Parameters:
Name Type Description
document_id string

ID of the document you'd like to delete

get_bank_statement(document_id, bounding_boxes, confidence_details, kwargs) → {JSON}

Get a specific bank statement. https://docs.veryfi.com/api/bank-statements/get-a-bank-statement/

Source:
Parameters:
Name Type Description
document_id number

The unique identifier of the document.
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Object of a previously processed blueprinted document.

get_bank_statements(page, page_size, bounding_boxes, confidence_details, kwargs) → {JSON}

Get all bank statements. https://docs.veryfi.com/api/bank-statements/get-bank-statements/

Source:
Parameters:
Name Type Description
page number

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

The number of Documents per page.
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Object of previously processed any documents

get_business_card(document_id, bounding_boxes, confidence_details, kwargs) → {JSON}

Get a specific Business card. https://docs.veryfi.com/api/business-cards/get-a-business-card/

Source:
Parameters:
Name Type Description
document_id number

The unique identifier of the document.
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Object of a previously processed blueprinted document.

get_business_cards(page, page_size, bounding_boxes, confidence_details, kwargs) → {JSON}

Get all Business cards. https://docs.veryfi.com/api/business-cards/get-business-cards/

Source:
Parameters:
Name Type Description
page number

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

The number of Documents per page.
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Object of previously processed any documents

get_check(document_id, bounding_boxes, confidence_details, kwargs) → {JSON}

Get a specific check. https://docs.veryfi.com/api/checks/get-a-check/

Source:
Parameters:
Name Type Description
document_id number

The unique identifier of the document.
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Object of a previously processed blueprinted document.

get_checks(page, page_size, bounding_boxes, confidence_details, kwargs) → {JSON}

Get all checks. https://docs.veryfi.com/api/checks/get-checks/

Source:
Parameters:
Name Type Description
page number

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

The number of Documents per page.
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Object of previously processed any documents

get_document(document_id, kwargs) → {JSON}

Retrieve document by ID. https://docs.veryfi.com/api/receipts-invoices/get-a-document/

Source:
Parameters:
Name Type Description
document_id string

ID of the document you'd like to retrieve
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the Document

get_documents(page, page_size, bounding_boxes, confidence_details, kwargs) → {JSON}

Get JSON of documents. https://docs.veryfi.com/api/receipts-invoices/search-documents/

Source:
Parameters:
Name Type Description
page number

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

The number of Documents per page.
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

JSON object of previously processed documents

get_w2(document_id, kwargs) → {JSON}

Get a w2 document https://docs.veryfi.com/api/w2s/get-a-w-2/

Source:
Parameters:
Name Type Description
document_id string

ID of the document you'd like to retrieve
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the Document

get_w2s(kwargs) → {Array}

Get all w2 documents. https://docs.veryfi.com/api/w2s/get-w-2-s/

Source:
Parameters:
Name Type Description
kwargs Object

Additional request parameters
Returns:
Type:
Array

An array of JSON with all w2 documents.

get_w8bene(document_id, bounding_boxes, confidence_details, kwargs) → {JSON}

Get a specific W-8BEN-E. https://docs.veryfi.com/api/w-8ben-e/get-a-w-8-ben-e/

Source:
Parameters:
Name Type Description
document_id number

The unique identifier of the document.
bounding_boxes boolean

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

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

Additional request parameters.
Returns:
Type:
JSON

Object of a previously processed blueprinted document.

get_w8benes(page, page_size, bounding_boxes, confidence_details, kwargs) → {JSON}

Get all W-8BEN-E. https://docs.veryfi.com/api/w-8ben-e/get-w-8-ben-es/

Source:
Parameters:
Name Type Description
page number

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

The number of Documents per page.
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Object of previously processed any documents

get_w9(document_id, bounding_boxes, confidence_details, kwargs) → {JSON}

Get a w9 document https://docs.veryfi.com/api/w9s/get-a-w-9/

Source:
Parameters:
Name Type Description
document_id number

The unique identifier of the document.
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Object of a previously processed blueprinted document.

get_w9s(page, page_size, bounding_boxes, confidence_details, kwargs) → {JSON}

Get all w9 documents. https://docs.veryfi.com/api/w9s/get-w-9-s/

Source:
Parameters:
Name Type Description
page number

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

The number of Documents per page.
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Object of previously processed any documents

process_bank_statement(file_path, bounding_boxes, confidence_details, kwargs) → {JSON}

Process bank statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/

Source:
Parameters:
Name Type Description
file_path String

Path on disk to a file to submit for data extraction
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

Example
veryfi_client.process_bank_statement('file_path')

process_bank_statement_from_base64(file_name, file_base64_string, bounding_boxes, confidence_details, kwargs) → {JSON}

Process bank statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/

Source:
Parameters:
Name Type Description
file_name String

The file name including the extension
file_base64_string String

To submit a file for data extraction, encode the file in Base64 format and ensure it includes the MIME type. The Base64 string should follow this structure: data:${mimeType};base64,${base64String}
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

process_bank_statement_from_stream(file, file_name, bounding_boxes, confidence_details, kwargs) → {JSON}

Process bank statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/

Source:
Parameters:
Name Type Description
file stream.Readable

file to submit for data extraction
file_name String

The file name including the extension
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

process_bank_statement_from_url(file_url, bounding_boxes, confidence_details, kwargs) → {JSON}

Process bank statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/

Source:
Parameters:
Name Type Description
file_url String

url file to submit for data extraction
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

Example
veryfi_client.process_bank_statement_from_url('file_url')

process_business_card(file_path, kwargs) → {JSON}

Process Business card and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/

Source:
Parameters:
Name Type Description
file_path String

Path on disk to a file to submit for data extraction
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

Example
veryfi_client.process_business_card('file_path')

process_business_card_from_base64(file_name, file_base64_string, kwargs) → {JSON}

Process Business card and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/

Source:
Parameters:
Name Type Description
file_name String

The file name including the extension
file_base64_string String

To submit a file for data extraction, encode the file in Base64 format and ensure it includes the MIME type. The Base64 string should follow this structure: data:${mimeType};base64,${base64String}
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

process_business_card_from_stream(file, file_name, kwargs) → {JSON}

Process Business card and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/

Source:
Parameters:
Name Type Description
file stream.Readable

file to submit for data extraction
file_name String

The file name including the extension
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

process_business_card_from_url(file_url, kwargs) → {JSON}

Process Check and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/

Source:
Parameters:
Name Type Description
file_url String

url file to submit for data extraction
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

Example
veryfi_client.process_business_card_from_url('file_url')

process_check(file_path, bounding_boxes, confidence_details, kwargs) → {JSON}

Process Check and extract all the fields from it.https://docs.veryfi.com/api/checks/process-a-check/

Source:
Parameters:
Name Type Description
file_path String

Path on disk to a file to submit for data extraction
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

Example
veryfi_client.process_check('file_path')

process_check_from_base64(file_name, file_base64_string, bounding_boxes, confidence_details, kwargs) → {JSON}

Process Check and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/

Source:
Parameters:
Name Type Description
file_name String

The file name including the extension
file_base64_string String

To submit a file for data extraction, encode the file in Base64 format and ensure it includes the MIME type. The Base64 string should follow this structure: data:${mimeType};base64,${base64String}
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

process_check_from_stream(file, file_name, bounding_boxes, confidence_details, kwargs) → {JSON}

Process Check and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/

Source:
Parameters:
Name Type Description
file stream.Readable

file to submit for data extraction
file_name String

The file name including the extension
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

process_check_from_url(file_url, bounding_boxes, confidence_details, kwargs) → {JSON}

Process Check and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/

Source:
Parameters:
Name Type Description
file_url String

url file to submit for data extraction
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

Example
veryfi_client.process_check_from_url('file_url')

process_document(file_path, categories, auto_delete, kwargs) → {JSON}

Process a document and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/

Source:
Parameters:
Name Type Description
file_path String

Path on disk to a file to submit for data extraction
categories Array

List of categories Veryfi can use to categorize the document
auto_delete Boolean

Delete this document from Veryfi after data has been extracted
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

Example
veryfi_client.process_document('file/path',
                               ['Entertainment','Food'],
                               true,
                               {"extra":"parameters"})

process_document_from_base64(base64_encoded_string, file_name, categories, auto_delete, kwargs) → {JSON}

Process a document and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/

Source:
Parameters:
Name Type Description
base64_encoded_string String

Buffer string of a file to submit for data extraction
file_name String

The file name including the extension
categories Array

List of categories Veryfi can use to categorize the document
auto_delete Boolean

Delete this document from Veryfi after data has been extracted
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

Example
veryfi_client.process_document_from_base64('base64_encoded_string',
                               'receipt.png',
                               ['Entertainment','Food'],
                               true,
                               {'extra': 'parameters'})

process_document_from_stream(file, file_name, auto_delete, kwargs) → {JSON}

Process a document and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/

Source:
Parameters:
Name Type Description
file stream.Readable

ReadStream of a file to submit for data extraction
file_name String

The file name including the extension
auto_delete Boolean

Delete this document from Veryfi after data has been extracted
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

Example
veryfi_client.process_document_stream('ReadStream',
                               'receipt.png',
                               ['Entertainment','Food'],
                               true,
                               {'extra': 'parameters'})

process_document_from_url(file_url, file_urls, categories, auto_delete, boost_mode, external_id, max_pages_to_process, kwargs) → {JSON}

Process document from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/

Source:
Parameters:
Name Type Description
file_url string | null

Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
file_urls Array

Required if file_url isn't specified. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
categories Array

List of categories to use when categorizing the document
auto_delete boolean

Delete this document from Veryfi after data has been extracted
boost_mode boolean

Flag that tells Veryfi whether boost mode should be enabled. When set to 1, Veryfi will skip data enrichment steps, but will process the document faster. Default value for this flag is 0
external_id string | null

Optional custom document identifier. Use this if you would like to assign your own ID to documents
max_pages_to_process int

When sending a long document to Veryfi for processing, this parameter controls how many pages of the document will be read and processed, starting from page 1.
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document.

Example
veryfi_client.process_document_from_url('https://cdn.example.com/receipt.jpg')

process_w2(file_path, auto_delete, max_pages_to_process, kwargs) → {JSON}

Upload a document from a file path https://docs.veryfi.com/api/w2s/process-a-w-2/

Source:
Parameters:
Name Type Description
file_path String

Path on disk to a file to submit for data extraction
auto_delete boolean

Delete this document from Veryfi after data has been extracted
max_pages_to_process int

When sending a long document to Veryfi for processing, this parameter controls how many pages of the document will be read and processed, starting from page 1.
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document.

process_w2_from_base64(file_name, file_base64_string, auto_delete, max_pages_to_process, kwargs) → {JSON}

Upload a w2 document from a buffer. https://docs.veryfi.com/api/w2s/process-a-w-2/

Source:
Parameters:
Name Type Description
file_name String

The file name including the extension
file_base64_string String

To submit a file for data extraction, encode the file in Base64 format and ensure it includes the MIME type. The Base64 string should follow this structure: data:${mimeType};base64,${base64String}
auto_delete boolean

Delete this document from Veryfi after data has been extracted
max_pages_to_process int

When sending a long document to Veryfi for processing, this parameter controls how many pages of the document will be read and processed, starting from page 1.
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document.

process_w2_from_stream(file, file_name, auto_delete, max_pages_to_process, kwargs) → {JSON}

Upload a w2 document from a buffer. https://docs.veryfi.com/api/w2s/process-a-w-2/

Source:
Parameters:
Name Type Description
file stream.Readable

file to submit for data extraction
file_name String

The file name including the extension
auto_delete boolean

Delete this document from Veryfi after data has been extracted
max_pages_to_process int

When sending a long document to Veryfi for processing, this parameter controls how many pages of the document will be read and processed, starting from page 1.
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document.

process_w2_from_url(file_name, file_url, file_urls, auto_delete, max_pages_to_process, kwargs) → {JSON}

Process a w2 document from an url. https://docs.veryfi.com/api/w2s/process-a-w-2/

Source:
Parameters:
Name Type Description
file_name String

The file name including the extension
file_url string

Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
file_urls Array

Required if file_url isn't specified. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
auto_delete boolean

Delete this document from Veryfi after data has been extracted
max_pages_to_process int

When sending a long document to Veryfi for processing, this parameter controls how many pages of the document will be read and processed, starting from page 1.
kwargs Object

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document.

process_w8bene(file_path, bounding_boxes, confidence_details, kwargs) → {JSON}

Process a W-8BEN-E document. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/

Source:
Parameters:
Name Type Description
file_path String

Path on disk to a file to submit for data extraction
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

Example
veryfi_client.process_w8bene('file_path')

process_w8bene_from_base64(file_name, file_base64_string, bounding_boxes, confidence_details, kwargs) → {JSON}

Upload a W-8BEN-E document from a buffer. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/

Source:
Parameters:
Name Type Description
file_name String

The file name including the extension
file_base64_string String

To submit a file for data extraction, encode the file in Base64 format and ensure it includes the MIME type. The Base64 string should follow this structure: data:${mimeType};base64,${base64String}
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

process_w8bene_from_stream(file, file_name, bounding_boxes, confidence_details, kwargs) → {JSON}

Upload a W-8BEN-E document from a buffer. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/

Source:
Parameters:
Name Type Description
file stream.Readable

file to submit for data extraction
file_name String

The file name including the extension
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

process_w8bene_from_url(file_url, bounding_boxes, confidence_details, kwargs) → {JSON}

Process W-8BEN-E and extract all the fields from it. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/

Source:
Parameters:
Name Type Description
file_url String

url file to submit for data extraction
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

Example
veryfi_client.process_w8bene_from_url('file_url')

process_w9(file_path, bounding_boxes, confidence_details, kwargs) → {JSON}

Upload a w9 document from a file path. https://docs.veryfi.com/api/w9s/process-a-w-9/

Source:
Parameters:
Name Type Description
file_path String

Path on disk to a file to submit for data extraction
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

process_w9_from_base64(file_name, file_base64_string, bounding_boxes, confidence_details, kwargs) → {JSON}

Upload a w9 document from a buffer. https://docs.veryfi.com/api/w9s/process-a-w-9/

Source:
Parameters:
Name Type Description
file_name String

The file name including the extension
file_base64_string String

To submit a file for data extraction, encode the file in Base64 format and ensure it includes the MIME type. The Base64 string should follow this structure: data:${mimeType};base64,${base64String}
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

process_w9_from_stream(file, file_name, bounding_boxes, confidence_details, kwargs) → {JSON}

Upload a w9 document from a buffer. https://docs.veryfi.com/api/w9s/process-a-w-9/

Source:
Parameters:
Name Type Description
file stream.Readable

file to submit for data extraction
file_name String

The file name including the extension
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

process_w9_from_url(file_url, bounding_boxes, confidence_details, kwargs) → {JSON}

Process a w9 document from an url. https://docs.veryfi.com/api/w9s/process-a-w-9/

Source:
Parameters:
Name Type Description
file_url String

url file to submit for data extraction
bounding_boxes boolean

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

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

Additional request parameters
Returns:
Type:
JSON

Data extracted from the document

replace_tags(document_id, tags) → {JSON}

Replace multiple tags on an existing document. https://docs.veryfi.com/api/receipts-invoices/add-tags-to-a-document/

Source:
Parameters:
Name Type Description
document_id number

ID of the document you'd like to add a Tag
tags Array.<string>

array of tags to be added
Returns:
Type:
JSON

response about tag added.

update_document(document_id, kwargs) → {JSON}

https://docs.veryfi.com/api/receipts-invoices/update-a-document/ Update data for a previously processed document, including almost any field like vendor, date, notes and etc.

Source:
Parameters:
Name Type Description
document_id string

ID of the document you'd like to update
kwargs Object

fields to update
Returns:
Type:
JSON

A document json with updated fields, if fields are writable. Otherwise a document with unchanged fields.

Example
veryfi_client.update_document(id, {date:"2021-01-01", notes:"look what I did"})