Merge pull request #33 from HassankSalim/add_w9_sdk_functions

Add sdk functions to extract w9 documents

Author: manycoding

tests/test_client.py

@@ -194,3 +194,79 @@ def test_process_document_url():
         boost_mode=True,
     )
     assert d == mock
+
+
+@responses.activate
+def test_process_w9_document_url():
+    mock = {
+        "account_numbers": "",
+        "address1": "28 E 3rd Ave, Suite 201",
+        "address2": "San Mateo, California, 94401",
+        "business_name": "",
+        "c_corp": 0,
+        "ein": "",
+        "exempt_payee_code": "",
+        "exemption": "",
+        "individual": 0,
+        "llc": 0,
+        "name": "Veryfi, Inc.",
+        "other": 0,
+        "other_description": "",
+        "partnership": 0,
+        "pdf_url": "https://scdn.veryfi.com/w9s/ec278ba0-31d6-4bd4-9d18-cb6a1232788e/output-1.pdf?Expires=1653031170&Signature=bftl34pf~Yni3ysaauqwL4BkfzgMPdAwMpw-SkjKZaxkgSt2~EYmX7NK~BGZ5IFUNdUIGBxTIsBsVWrP8LDQ3fME3kFM6qSn-udZp9Y8WJ-HbqQrIf1DwZQp-A2NSBCkRWgqAtYJo5dQW~UJJdCJx19ZIaYQZzYVQvuHmornzBStTV6D2qXQKUZpv9d5BrvTExZDnIxKy-ibyy09CfUPMc-lsVQLQEb-uQvud-JTf9Guy6k9Y4oT32HSvKcL0pMLvJqYC6mJUM2-5MJiBsYQSNs2e6s8xXcSBotiChMQwBg3RhGv5y-o8Aih1GNmBcvPHJIEyKOuiHeC9TUSELvp~w__&Key-Pair-Id=APKAJCILBXEJFZF4DCHQ",
+        "requester": "AcMe Corporation 1010 Elm Str,\nMountain View, CA 94043",
+        "s_corp": 1,
+        "signature": 1,
+        "signature_date": "June 19, 2020",
+        "ssn": "",
+        "trust_estate": 0,
+    }
+
+    client = Client(client_id="v", client_secret="w", username="o", api_key="c")
+    responses.add(
+        responses.POST,
+        f"{client.versioned_url}/partner/w9s/",
+        json=mock,
+        status=200,
+    )
+    d = client.process_w9_document_url(
+        file_url="http://cdn-dev.veryfi.com/testing/veryfi-python/receipt_public.jpg",
+    )
+    assert d == mock
+
+
+@responses.activate
+def test_process_w9_document():
+    mock = {
+        "account_numbers": "",
+        "address1": "28 E 3rd Ave, Suite 201",
+        "address2": "San Mateo, California, 94401",
+        "business_name": "",
+        "c_corp": 0,
+        "ein": "",
+        "exempt_payee_code": "",
+        "exemption": "",
+        "individual": 0,
+        "llc": 0,
+        "name": "Veryfi, Inc.",
+        "other": 0,
+        "other_description": "",
+        "partnership": 0,
+        "pdf_url": "https://scdn.veryfi.com/w9s/ec278ba0-31d6-4bd4-9d18-cb6a1232788e/output-1.pdf?Expires=1653031170&Signature=bftl34pf~Yni3ysaauqwL4BkfzgMPdAwMpw-SkjKZaxkgSt2~EYmX7NK~BGZ5IFUNdUIGBxTIsBsVWrP8LDQ3fME3kFM6qSn-udZp9Y8WJ-HbqQrIf1DwZQp-A2NSBCkRWgqAtYJo5dQW~UJJdCJx19ZIaYQZzYVQvuHmornzBStTV6D2qXQKUZpv9d5BrvTExZDnIxKy-ibyy09CfUPMc-lsVQLQEb-uQvud-JTf9Guy6k9Y4oT32HSvKcL0pMLvJqYC6mJUM2-5MJiBsYQSNs2e6s8xXcSBotiChMQwBg3RhGv5y-o8Aih1GNmBcvPHJIEyKOuiHeC9TUSELvp~w__&Key-Pair-Id=APKAJCILBXEJFZF4DCHQ",
+        "requester": "AcMe Corporation 1010 Elm Str,\nMountain View, CA 94043",
+        "s_corp": 1,
+        "signature": 1,
+        "signature_date": "June 19, 2020",
+        "ssn": "",
+        "trust_estate": 0,
+    }
+
+    client = Client(client_id="v", client_secret="w", username="o", api_key="c")
+    responses.add(
+        responses.POST,
+        f"{client.versioned_url}/partner/w9s/",
+        json=mock,
+        status=200,
+    )
+    d = client.process_w9_document(file_path="tests/assets/receipt_public.jpg")
+    assert d == mock

veryfi/client.py

@@ -215,6 +215,51 @@ def process_document_url(
         request_arguments.update(kwargs)
         return self._request("POST", endpoint_name, request_arguments)
 
+    def process_w9_document_url(
+        self, file_url: str, file_name: Optional[str] = None, **kwargs: Dict
+    ) -> Dict:
+        """
+        Process W9 Document from url and extract all the fields from it.
+
+        :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._request("POST", endpoint_name, request_arguments)
+
+    def process_w9_document(self, file_path: str, file_name: Optional[str] = None, **kwargs):
+        """
+        Process W9 Document from url and extract all the fields from it.
+
+        :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)
+        document = self._request("POST", endpoint_name, request_arguments)
+        return document
+
     def delete_document(self, document_id):
         """
         Delete Document from Veryfi