Module veryfi.w9s
View Source
import os
import base64
from typing import Dict, Optional
from veryfi.client_base import Client
class W9s:
def __init__(self, client: Client):
self.client = client
def process_w9_document_url(
self, file_url: str, file_name: Optional[str] = None, **kwargs
) -> Dict:
"""
Process W9 Document from url and extract all the fields from it.
https://docs.veryfi.com/api/w9s/process-a-w-9/
:param file_url: Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
:param file_name: Optional name of file, eg. receipt.jpg
:param kwargs: Additional request parameters
:return: Data extracted from the document.
"""
if file_name is None:
file_name = os.path.basename(file_url)
endpoint_name = "/w9s/"
request_arguments = {
"file_name": file_name,
"file_url": file_url,
}
request_arguments.update(kwargs)
return self.client._request("POST", endpoint_name, request_arguments)
def process_w9_document(
self, file_path: str, file_name: Optional[str] = None, **kwargs
) -> Dict:
"""
Process W9 Document from url and extract all the fields from it.
https://docs.veryfi.com/api/w9s/process-a-w-9/
:param file_path: Path on disk to a file to submit for data extraction
:param file_name: Optional name of file, eg. receipt.jpg
:param kwargs: Additional request parameters
:return: Data extracted from the document.
"""
endpoint_name = "/w9s/"
if file_name is None:
file_name = os.path.basename(file_path)
with open(file_path, "rb") as image_file:
base64_encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
request_arguments = {
"file_name": file_name,
"file_data": base64_encoded_string,
}
request_arguments.update(kwargs)
return self.client._request("POST", endpoint_name, request_arguments)
def get_w9(self, document_id: int, **kwargs) -> Dict:
"""
Get a W-9 endpoint allows you to retrieve a previously processed W-9
https://docs.veryfi.com/api/w9s/get-a-w-9/
:param document_id: The unique identifier of the document.
:param bounding_boxes: A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
:param confidence_details: A field used to determine whether or not to return the score and ocr_score fields in the Document response.
:return: Document Data
"""
endpoint_name = f"/w9s/{document_id}/"
return self.client._request("GET", endpoint_name, {}, kwargs)
def get_w9s(
self,
created_date_gt: Optional[str] = None,
created_date_gte: Optional[str] = None,
created_date_lt: Optional[str] = None,
created_date_lte: Optional[str] = None,
**kwargs,
):
"""
Get list of w9s documents
https://docs.veryfi.com/api/w9s/get-w-9-s/
:param created_date__gt: Search for w9s documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__gt and created_date__gte in a single request.
:param created_date__gte: Search for w9s documents with a created date greater than or equal to this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__gt and created_date__gte in a single request.
:param created_date__lt: Search for w9s documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__lt and created_date__lte in a single request.
:param created_date__lte: Search for w9s documents with a created date less than or equal to this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__lt and created_date__lte in a single request.
:param kwargs: Additional request parameters
:return: List of previously processed documents
"""
query_params = {}
if created_date_gt:
query_params["created_date__gt"] = created_date_gt
if created_date_gte:
query_params["created_date__gte"] = created_date_gte
if created_date_lt:
query_params["created_date__lt"] = created_date_lt
if created_date_lte:
query_params["created_date__lte"] = created_date_lte
query_params.update(kwargs)
endpoint_name = "/w9s/"
return self.client._request("GET", endpoint_name, {}, query_params)
def delete_w9(self, document_id: int):
"""
Delete a W-9 document.
https://docs.veryfi.com/api/w9s/delete-a-w-9/
:param document_id: The unique identifier of the document.
"""
endpoint_name = f"/w9s/{document_id}/"
self.client._request("DELETE", endpoint_name, {})
Classes
W9s
class W9s(
client: veryfi.client_base.Client
)
View Source
class W9s:
def __init__(self, client: Client):
self.client = client
def process_w9_document_url(
self, file_url: str, file_name: Optional[str] = None, **kwargs
) -> Dict:
"""
Process W9 Document from url and extract all the fields from it.
https://docs.veryfi.com/api/w9s/process-a-w-9/
:param file_url: Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
:param file_name: Optional name of file, eg. receipt.jpg
:param kwargs: Additional request parameters
:return: Data extracted from the document.
"""
if file_name is None:
file_name = os.path.basename(file_url)
endpoint_name = "/w9s/"
request_arguments = {
"file_name": file_name,
"file_url": file_url,
}
request_arguments.update(kwargs)
return self.client._request("POST", endpoint_name, request_arguments)
def process_w9_document(
self, file_path: str, file_name: Optional[str] = None, **kwargs
) -> Dict:
"""
Process W9 Document from url and extract all the fields from it.
https://docs.veryfi.com/api/w9s/process-a-w-9/
:param file_path: Path on disk to a file to submit for data extraction
:param file_name: Optional name of file, eg. receipt.jpg
:param kwargs: Additional request parameters
:return: Data extracted from the document.
"""
endpoint_name = "/w9s/"
if file_name is None:
file_name = os.path.basename(file_path)
with open(file_path, "rb") as image_file:
base64_encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
request_arguments = {
"file_name": file_name,
"file_data": base64_encoded_string,
}
request_arguments.update(kwargs)
return self.client._request("POST", endpoint_name, request_arguments)
def get_w9(self, document_id: int, **kwargs) -> Dict:
"""
Get a W-9 endpoint allows you to retrieve a previously processed W-9
https://docs.veryfi.com/api/w9s/get-a-w-9/
:param document_id: The unique identifier of the document.
:param bounding_boxes: A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
:param confidence_details: A field used to determine whether or not to return the score and ocr_score fields in the Document response.
:return: Document Data
"""
endpoint_name = f"/w9s/{document_id}/"
return self.client._request("GET", endpoint_name, {}, kwargs)
def get_w9s(
self,
created_date_gt: Optional[str] = None,
created_date_gte: Optional[str] = None,
created_date_lt: Optional[str] = None,
created_date_lte: Optional[str] = None,
**kwargs,
):
"""
Get list of w9s documents
https://docs.veryfi.com/api/w9s/get-w-9-s/
:param created_date__gt: Search for w9s documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__gt and created_date__gte in a single request.
:param created_date__gte: Search for w9s documents with a created date greater than or equal to this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__gt and created_date__gte in a single request.
:param created_date__lt: Search for w9s documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__lt and created_date__lte in a single request.
:param created_date__lte: Search for w9s documents with a created date less than or equal to this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__lt and created_date__lte in a single request.
:param kwargs: Additional request parameters
:return: List of previously processed documents
"""
query_params = {}
if created_date_gt:
query_params["created_date__gt"] = created_date_gt
if created_date_gte:
query_params["created_date__gte"] = created_date_gte
if created_date_lt:
query_params["created_date__lt"] = created_date_lt
if created_date_lte:
query_params["created_date__lte"] = created_date_lte
query_params.update(kwargs)
endpoint_name = "/w9s/"
return self.client._request("GET", endpoint_name, {}, query_params)
def delete_w9(self, document_id: int):
"""
Delete a W-9 document.
https://docs.veryfi.com/api/w9s/delete-a-w-9/
:param document_id: The unique identifier of the document.
"""
endpoint_name = f"/w9s/{document_id}/"
self.client._request("DELETE", endpoint_name, {})
Descendants
- veryfi.client.Client
Methods
delete_w9
def delete_w9(
self,
document_id: int
)
Delete a W-9 document.
https://docs.veryfi.com/api/w9s/delete-a-w-9/
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| document_id | None | The unique identifier of the document. | None |
View Source
def delete_w9(self, document_id: int):
"""
Delete a W-9 document.
https://docs.veryfi.com/api/w9s/delete-a-w-9/
:param document_id: The unique identifier of the document.
"""
endpoint_name = f"/w9s/{document_id}/"
self.client._request("DELETE", endpoint_name, {})
get_w9
def get_w9(
self,
document_id: int,
**kwargs
) -> Dict
Get a W-9 endpoint allows you to retrieve a previously processed W-9
https://docs.veryfi.com/api/w9s/get-a-w-9/
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| document_id | None | The unique identifier of the document. | None |
| bounding_boxes | None | A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response. | None |
| confidence_details | None | A field used to determine whether or not to return the score and ocr_score fields in the Document response. | None |
Returns:
| Type | Description |
|---|---|
| None | Document Data |
View Source
def get_w9(self, document_id: int, **kwargs) -> Dict:
"""
Get a W-9 endpoint allows you to retrieve a previously processed W-9
https://docs.veryfi.com/api/w9s/get-a-w-9/
:param document_id: The unique identifier of the document.
:param bounding_boxes: A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
:param confidence_details: A field used to determine whether or not to return the score and ocr_score fields in the Document response.
:return: Document Data
"""
endpoint_name = f"/w9s/{document_id}/"
return self.client._request("GET", endpoint_name, {}, kwargs)
get_w9s
def get_w9s(
self,
created_date_gt: Optional[str] = None,
created_date_gte: Optional[str] = None,
created_date_lt: Optional[str] = None,
created_date_lte: Optional[str] = None,
**kwargs
)
Get list of w9s documents
https://docs.veryfi.com/api/w9s/get-w-9-s/
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| created_date__gt | None | Search for w9s documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__gt and created_date__gte in a single request. | None |
| created_date__gte | None | Search for w9s documents with a created date greater than or equal to this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__gt and created_date__gte in a single request. | None |
| created_date__lt | None | Search for w9s documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__lt and created_date__lte in a single request. | None |
| created_date__lte | None | Search for w9s documents with a created date less than or equal to this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__lt and created_date__lte in a single request. | None |
| kwargs | None | Additional request parameters | None |
Returns:
| Type | Description |
|---|---|
| None | List of previously processed documents |
View Source
def get_w9s(
self,
created_date_gt: Optional[str] = None,
created_date_gte: Optional[str] = None,
created_date_lt: Optional[str] = None,
created_date_lte: Optional[str] = None,
**kwargs,
):
"""
Get list of w9s documents
https://docs.veryfi.com/api/w9s/get-w-9-s/
:param created_date__gt: Search for w9s documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__gt and created_date__gte in a single request.
:param created_date__gte: Search for w9s documents with a created date greater than or equal to this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__gt and created_date__gte in a single request.
:param created_date__lt: Search for w9s documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__lt and created_date__lte in a single request.
:param created_date__lte: Search for w9s documents with a created date less than or equal to this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created_date__lt and created_date__lte in a single request.
:param kwargs: Additional request parameters
:return: List of previously processed documents
"""
query_params = {}
if created_date_gt:
query_params["created_date__gt"] = created_date_gt
if created_date_gte:
query_params["created_date__gte"] = created_date_gte
if created_date_lt:
query_params["created_date__lt"] = created_date_lt
if created_date_lte:
query_params["created_date__lte"] = created_date_lte
query_params.update(kwargs)
endpoint_name = "/w9s/"
return self.client._request("GET", endpoint_name, {}, query_params)
process_w9_document
def process_w9_document(
self,
file_path: str,
file_name: Optional[str] = None,
**kwargs
) -> Dict
Process W9 Document from url and extract all the fields from it.
https://docs.veryfi.com/api/w9s/process-a-w-9/
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| file_path | None | Path on disk to a file to submit for data extraction | None |
| file_name | None | Optional name of file, eg. receipt.jpg | None |
| kwargs | None | Additional request parameters | None |
Returns:
| Type | Description |
|---|---|
| None | Data extracted from the document. |
View Source
def process_w9_document(
self, file_path: str, file_name: Optional[str] = None, **kwargs
) -> Dict:
"""
Process W9 Document from url and extract all the fields from it.
https://docs.veryfi.com/api/w9s/process-a-w-9/
:param file_path: Path on disk to a file to submit for data extraction
:param file_name: Optional name of file, eg. receipt.jpg
:param kwargs: Additional request parameters
:return: Data extracted from the document.
"""
endpoint_name = "/w9s/"
if file_name is None:
file_name = os.path.basename(file_path)
with open(file_path, "rb") as image_file:
base64_encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
request_arguments = {
"file_name": file_name,
"file_data": base64_encoded_string,
}
request_arguments.update(kwargs)
return self.client._request("POST", endpoint_name, request_arguments)
process_w9_document_url
def process_w9_document_url(
self,
file_url: str,
file_name: Optional[str] = None,
**kwargs
) -> Dict
Process W9 Document from url and extract all the fields from it.
https://docs.veryfi.com/api/w9s/process-a-w-9/
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| file_url | None | Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg". | None |
| file_name | None | Optional name of file, eg. receipt.jpg | None |
| kwargs | None | Additional request parameters | None |
Returns:
| Type | Description |
|---|---|
| None | Data extracted from the document. |
View Source
def process_w9_document_url(
self, file_url: str, file_name: Optional[str] = None, **kwargs
) -> Dict:
"""
Process W9 Document from url and extract all the fields from it.
https://docs.veryfi.com/api/w9s/process-a-w-9/
:param file_url: Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
:param file_name: Optional name of file, eg. receipt.jpg
:param kwargs: Additional request parameters
:return: Data extracted from the document.
"""
if file_name is None:
file_name = os.path.basename(file_url)
endpoint_name = "/w9s/"
request_arguments = {
"file_name": file_name,
"file_url": file_url,
}
request_arguments.update(kwargs)
return self.client._request("POST", endpoint_name, request_arguments)