@veryfi/veryfi-sdk 1.3.2 → 1.4.1

package/lib/anydocs/getAnyDocuments.js

@@ -0,0 +1,30 @@
+const Client = require('../client/constructor');
+/**
+ * Get all any documents. https://docs.veryfi.com/api/anydocs/get-%E2%88%80-docs/
+ * @memberof Client
+ * @param {number} page The page number. The response is capped to maximum of 50 results per page.
+ * @param {number} page_size The number of Documents per page.
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Object of previously processed any documents
+ */
+Client.prototype.get_any_documents = async function (
+    page = 1,
+    page_size = 50,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}) {
+    let endpoint_name = "/any-documents/";
+    let request_arguments = {
+        "page": page,
+        "page_size": page_size,
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details
+    };
+    let documents = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    if ("data" in documents) {
+        documents = documents["data"];
+    }
+    return documents;
+}

package/lib/anydocs/processAnyDocument.js

@@ -0,0 +1,33 @@
+const Client = require('../client/constructor');
+const path = require('path');
+const fs = require('fs');
+/**
+ * Process any document and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-%E2%88%80-doc/
+ * @example
+ * veryfi_client.process_any_document('file/path','blue_print')
+ *
+ * @memberof Client
+ * @param {String} file_path Path on disk to a file to submit for data extraction
+ * @param {String} blueprint_name The name of the extraction blueprints to use.
+ * @param {number} max_pages_to_process The number of pages to process for the document. The limit is 50 pages per document.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_any_document = async function (
+    file_path,
+    blueprint_name,
+    max_pages_to_process = 20,
+    {...kwargs} = {}
+) {
+
+    let file = fs.createReadStream(file_path);
+    let file_name = path.basename(file_path);
+
+    return this.process_any_document_from_stream(
+        file,
+        file_name,
+        blueprint_name,
+        max_pages_to_process,
+        kwargs
+    );
+}

package/lib/anydocs/processAnyDocumentBase64.js

@@ -0,0 +1,31 @@
+const Client = require('../client/constructor');
+/**
+ * Process any document and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-%E2%88%80-doc/
+ *
+ * @memberof Client
+ * @param {String} file_name The file name including the extension
+ * @param {String} file_base64_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}
+ * @param {String} blueprint_name The name of the extraction blueprints to use.
+ * @param {number} max_pages_to_process The number of pages to process for the document. The limit is 50 pages per document.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_any_document_from_base64 = async function (
+    file_name,
+    file_base64_string,
+    blueprint_name,
+    max_pages_to_process = 20,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/any-documents/";
+    let request_arguments = {
+        "file_name": file_name,
+        "file_data": file_base64_string,
+        "blueprint_name": blueprint_name,
+        "max_pages_to_process": max_pages_to_process,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments, null, false);
+    return document['data'];
+}

package/lib/anydocs/processAnyDocumentStream.js

@@ -0,0 +1,33 @@
+const Client = require('../client/constructor');
+/**
+ * Process any document and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-%E2%88%80-doc/
+ * @example
+ * veryfi_client.process_any_document('file/path','blue_print')
+ *
+ * @memberof Client
+ * @param {ReadStream} file ReadStream of a file to submit for data extraction
+ * @param {String} file_name The file name including the extension
+ * @param {String} blueprint_name The name of the extraction blueprints to use.
+ * @param {number} max_pages_to_process The number of pages to process for the document. The limit is 50 pages per document.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_any_document_from_stream = async function (
+    file,
+    file_name,
+    blueprint_name,
+    max_pages_to_process = 20,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/any-documents/";
+    let request_arguments = {
+        "file_name": file_name,
+        "file": file,
+        "blueprint_name": blueprint_name,
+        "max_pages_to_process": max_pages_to_process,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments, null, true);
+    return document['data'];
+}

package/lib/anydocs/processAnyDocumentUrl.js

@@ -0,0 +1,30 @@
+const Client = require('../client/constructor');
+/**
+ * Process any document and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-%E2%88%80-doc/
+ * @example
+ * veryfi_client.process_any_document_from_url('file_url','blue_print')
+ *
+ * @memberof Client
+ * @param {String} file_url url file to submit for data extraction
+ * @param {String} blueprint_name The name of the extraction blueprints to use.
+ * @param {number} max_pages_to_process The number of pages to process for the document. The limit is 50 pages per document.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_any_document_from_url = async function (
+    file_url,
+    blueprint_name,
+    max_pages_to_process = 20,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/any-documents/";
+    let request_arguments = {
+        "file_url": file_url,
+        "blueprint_name": blueprint_name,
+        "max_pages_to_process": max_pages_to_process,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments, null, false);
+    return document['data'];
+}

package/lib/bankstatements/deleteBankStatement.js

@@ -0,0 +1,12 @@
+const Client = require('../client/constructor');
+/**
+ * Delete a Bank Statement from Veryfi. https://docs.veryfi.com/api/bank-statements/delete-a-bank-statement/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document you'd like to delete
+ */
+Client.prototype.delete_bank_statement = async function (document_id) {
+    let endpoint_name = `/bank-statements/${document_id}/`;
+    let request_arguments = {"id": document_id};
+    return this._request("DELETE", endpoint_name, request_arguments);
+}

package/lib/bankstatements/getBankStatement.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Get a specific bank statement. https://docs.veryfi.com/api/bank-statements/get-a-bank-statement/
+ * @memberof Client
+ * @param {number} document_id The unique identifier of the document.
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Object of a previously processed blueprinted document.
+ */
+Client.prototype.get_bank_statement = async function (
+    document_id,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/bank-statements/${document_id}/`;
+    let request_arguments = {
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details
+    };
+    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    return document['data'];
+}

package/lib/bankstatements/getBankStatements.js

@@ -0,0 +1,28 @@
+const Client = require('../client/constructor');
+/**
+ * Get all bank statements. https://docs.veryfi.com/api/bank-statements/get-bank-statements/
+ * @memberof Client
+ * @param {number} page The page number. The response is capped to maximum of 50 results per page.
+ * @param {number} page_size The number of Documents per page.
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Object of previously processed any documents
+ */
+Client.prototype.get_bank_statements = async function (
+    page = 1,
+    page_size = 50,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/bank-statements/`;
+    let request_arguments = {
+        "page": page,
+        "page_size": page_size,
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details
+    };
+    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    return document['data'];
+}

package/lib/bankstatements/processBankStatement.js

@@ -0,0 +1,33 @@
+const Client = require('../client/constructor');
+const path = require('path');
+const fs = require('fs');
+/**
+ * Process bank statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
+ * @example
+ * veryfi_client.process_bank_statement('file_path')
+ *
+ * @memberof Client
+ * @param {String} file_path Path on disk to a file to submit for data extraction
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_bank_statement = async function (
+    file_path,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let file = fs.createReadStream(file_path);
+    let file_name = path.basename(file_path);
+
+    return this.process_bank_statement_from_stream(
+        file,
+        file_name,
+        bounding_boxes,
+        confidence_details,
+        kwargs
+    );
+}

package/lib/bankstatements/processBankStatementBase64.js

@@ -0,0 +1,31 @@
+const Client = require('../client/constructor');
+/**
+ * Process bank statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
+ *
+ * @memberof Client
+ * @param {String} file_name The file name including the extension
+ * @param {String} file_base64_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}
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_bank_statement_from_base64 = async function (
+    file_name,
+    file_base64_string,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/bank-statements/";
+    let request_arguments = {
+        "file_name": file_name,
+        "file_data": file_base64_string,
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments, null, false);
+    return document['data'];
+}

package/lib/bankstatements/processBankStatementStream.js

@@ -0,0 +1,31 @@
+const Client = require('../client/constructor');
+/**
+ * Process bank statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
+ *
+ * @memberof Client
+ * @param {fs.ReadStream} file file to submit for data extraction
+ * @param {String} file_name The file name including the extension
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_bank_statement_from_stream = async function (
+    file,
+    file_name,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/bank-statements/";
+    let request_arguments = {
+        "file": file,
+        "file_name": file_name,
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments, null, true);
+    return document['data'];
+}

package/lib/bankstatements/processBankStatementUrl.js

@@ -0,0 +1,30 @@
+const Client = require('../client/constructor');
+/**
+ * Process bank statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
+ * @example
+ * veryfi_client.process_bank_statement_from_url('file_url')
+ *
+ * @memberof Client
+ * @param {String} file_url url file to submit for data extraction
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_bank_statement_from_url = async function (
+    file_url,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/bank-statements/";
+    let request_arguments = {
+        "file_url": file_url,
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments, null, false);
+    return document['data'];
+}

package/lib/businesscards/deleteBusinessCard.js

@@ -0,0 +1,12 @@
+const Client = require('../client/constructor');
+/**
+ * Delete a Business Card from Veryfi. https://docs.veryfi.com/api/business-cards/delete-a-business-card/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document you'd like to delete
+ */
+Client.prototype.delete_business_card = async function (document_id) {
+    let endpoint_name = `/business-cards/${document_id}/`;
+    let request_arguments = {"id": document_id};
+    return this._request("DELETE", endpoint_name, request_arguments);
+}

package/lib/businesscards/getBusinessCard.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Get a specific Business card. https://docs.veryfi.com/api/business-cards/get-a-business-card/
+ * @memberof Client
+ * @param {number} document_id The unique identifier of the document.
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Object of a previously processed blueprinted document.
+ */
+Client.prototype.get_business_card = async function (
+    document_id,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/business-cards/${document_id}/`;
+    let request_arguments = {
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details
+    };
+    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    return document['data'];
+}

package/lib/businesscards/getBusinessCards.js

@@ -0,0 +1,28 @@
+const Client = require('../client/constructor');
+/**
+ * Get all Business cards. https://docs.veryfi.com/api/business-cards/get-business-cards/
+ * @memberof Client
+ * @param {number} page The page number. The response is capped to maximum of 50 results per page.
+ * @param {number} page_size The number of Documents per page.
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Object of previously processed any documents
+ */
+Client.prototype.get_business_cards = async function (
+    page = 1,
+    page_size = 50,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/business-cards/`;
+    let request_arguments = {
+        "page": page,
+        "page_size": page_size,
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details
+    };
+    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    return document['data'];
+}

package/lib/businesscards/processBusinessCard.js

@@ -0,0 +1,27 @@
+const Client = require('../client/constructor');
+const path = require('path');
+const fs = require('fs');
+/**
+ * Process Business card and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/
+ * @example
+ * veryfi_client.process_business_card('file_path')
+ *
+ * @memberof Client
+ * @param {String} file_path Path on disk to a file to submit for data extraction
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_business_card = async function (
+    file_path,
+    {...kwargs} = {}
+) {
+
+    let file = fs.createReadStream(file_path);
+    let file_name = path.basename(file_path);
+
+    return this.process_business_card_from_stream(
+        file,
+        file_name,
+        kwargs
+    );
+}

package/lib/businesscards/processBusinessCardBase64.js

@@ -0,0 +1,25 @@
+const Client = require('../client/constructor');
+/**
+ * Process Business card and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/
+ *
+ * @memberof Client
+ * @param {String} file_name The file name including the extension
+ * @param {String} file_base64_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}
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_business_card_from_base64 = async function (
+    file_name,
+    file_base64_string,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/business-cards/";
+    let request_arguments = {
+        "file_name": file_name,
+        "file_data": file_base64_string,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments, null, false);
+    return document['data'];
+}

package/lib/businesscards/processBusinessCardStream.js

@@ -0,0 +1,25 @@
+const Client = require('../client/constructor');
+/**
+ * Process Business card and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/
+ *
+ * @memberof Client
+ * @param {fs.ReadStream} file file to submit for data extraction
+ * @param {String} file_name The file name including the extension
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_business_card_from_stream = async function (
+    file,
+    file_name,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/business-cards/";
+    let request_arguments = {
+        "file": file,
+        "file_name": file_name,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments, null, true);
+    return document['data'];
+}

package/lib/businesscards/processBusinessCardUrl.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Process Check and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/
+ * @example
+ * veryfi_client.process_business_card_from_url('file_url')
+ *
+ * @memberof Client
+ * @param {String} file_url url file to submit for data extraction
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_business_card_from_url = async function (
+    file_url,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/business-cards/";
+    let request_arguments = {
+        "file_url": file_url,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments, null, false);
+    return document['data'];
+}

package/lib/checks/deleteCheck.js

@@ -0,0 +1,12 @@
+const Client = require('../client/constructor');
+/**
+ * Delete a Check from Veryfi. https://docs.veryfi.com/api/checks/delete-a-check/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document you'd like to delete
+ */
+Client.prototype.delete_check = async function (document_id) {
+    let endpoint_name = `/checks/${document_id}/`;
+    let request_arguments = {"id": document_id};
+    return this._request("DELETE", endpoint_name, request_arguments);
+}

package/lib/checks/getCheck.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Get a specific check. https://docs.veryfi.com/api/checks/get-a-check/
+ * @memberof Client
+ * @param {number} document_id The unique identifier of the document.
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Object of a previously processed blueprinted document.
+ */
+Client.prototype.get_check = async function (
+    document_id,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/checks/${document_id}/`;
+    let request_arguments = {
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details
+    };
+    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    return document['data'];
+}

package/lib/checks/getChecks.js

@@ -0,0 +1,28 @@
+const Client = require('../client/constructor');
+/**
+ * Get all checks. https://docs.veryfi.com/api/checks/get-checks/
+ * @memberof Client
+ * @param {number} page The page number. The response is capped to maximum of 50 results per page.
+ * @param {number} page_size The number of Documents per page.
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Object of previously processed any documents
+ */
+Client.prototype.get_checks = async function (
+    page = 1,
+    page_size = 50,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/checks/`;
+    let request_arguments = {
+        "page": page,
+        "page_size": page_size,
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details
+    };
+    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    return document['data'];
+}

package/lib/checks/processCheck.js

@@ -0,0 +1,33 @@
+const Client = require('../client/constructor');
+const path = require('path');
+const fs = require('fs');
+/**
+ * Process Check and extract all the fields from it.https://docs.veryfi.com/api/checks/process-a-check/
+ * @example
+ * veryfi_client.process_check('file_path')
+ *
+ * @memberof Client
+ * @param {String} file_path Path on disk to a file to submit for data extraction
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_check = async function (
+    file_path,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let file = fs.createReadStream(file_path);
+    let file_name = path.basename(file_path);
+
+    return this.process_check_from_stream(
+        file,
+        file_name,
+        bounding_boxes,
+        confidence_details,
+        kwargs
+    );
+}