Package veryfi.services

Class ClientImpl

java.lang.Object
veryfi.services.ClientImpl
All Implemented Interfaces:
Client
public class ClientImpl extends Object implements Client
Veryfi API client for Java.

  • Constructor Details

    • ClientImpl

      public ClientImpl(String clientId, String clientSecret, String username, String apiKey, int apiVersion)
      Creates an instance of ClientImpl.
      Parameters:
      clientId - the String provided by Veryfi.
      clientSecret - the String provided by Veryfi.
      username - the String provided by Veryfi.
      apiKey - the String provided by Veryfi.
      apiVersion - the int api version to use Veryfi.

    • ClientImpl

      public ClientImpl(String clientId, String clientSecret, String username, String apiKey, int apiVersion, HttpClient httpClient)
      Creates an instance of ClientImpl.
      Parameters:
      clientId - the String provided by Veryfi.
      clientSecret - the String provided by Veryfi.
      username - the String provided by Veryfi.
      apiKey - the String provided by Veryfi.
      apiVersion - the int api version to use Veryfi.
      httpClient - HttpClient for the Veryfi API

  • Method Details

    • getDocuments

      public String getDocuments(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string String with the list of documents. https://docs.veryfi.com/api/receipts-invoices/search-documents/
      Specified by:
      getDocuments in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the url String

    • getDocumentsAsync

      public CompletableFuture<String> getDocumentsAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string CompletableFuture<String> list of documents. https://docs.veryfi.com/api/receipts-invoices/search-documents/
      Specified by:
      getDocumentsAsync in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the list of previously processed documents String

    • getDocument

      public String getDocument(String documentId)
      Returns a json string String document information. https://docs.veryfi.com/api/receipts-invoices/get-a-document/
      Specified by:
      getDocument in interface Client
      Parameters:
      documentId - ID of the document you'd like to retrieve.
      Returns:
      the data extracted from the Document String

    • getDocumentAsync

      public CompletableFuture<String> getDocumentAsync(String documentId)
      Returns a json string CompletableFuture<String> document information. https://docs.veryfi.com/api/receipts-invoices/get-a-document/
      Specified by:
      getDocumentAsync in interface Client
      Parameters:
      documentId - ID of the document you'd like to retrieve.
      Returns:
      the data extracted from the Document String

    • processDocument

      public String processDocument(String filePath, List<String> categories, boolean deleteAfterProcessing, org.json.JSONObject parameters)
      Process a document and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/
      Specified by:
      processDocument in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction
      categories - List of categories Veryfi can use to categorize the document
      deleteAfterProcessing - Delete this document from Veryfi after data has been extracted
      parameters - Additional request parameters
      Returns:
      the data extracted from the Document String

    • processDocumentAsync

      public CompletableFuture<String> processDocumentAsync(String filePath, List<String> categories, boolean deleteAfterProcessing, org.json.JSONObject parameters)
      Process a document and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/
      Specified by:
      processDocumentAsync in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction
      categories - List of categories Veryfi can use to categorize the document
      deleteAfterProcessing - Delete this document from Veryfi after data has been extracted
      parameters - Additional request parameters
      Returns:
      the data extracted from the Document CompletableFuture<String>

    • processDocumentUrl

      public String processDocumentUrl(String fileUrl, List<String> fileUrls, List<String> categories, boolean deleteAfterProcessing, int maxPagesToProcess, boolean boostMode, String externalId, org.json.JSONObject parameters)
      Process Document from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/
      Specified by:
      processDocumentUrl in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      categories - List of categories to use when categorizing the document
      deleteAfterProcessing - Delete this document from Veryfi after data has been extracted
      maxPagesToProcess - 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.
      boostMode - 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
      externalId - Optional custom document identifier. Use this if you would like to assign your own ID to documents
      parameters - Additional request parameters
      Returns:
      the data extracted from the Document String

    • processDocumentUrlAsync

      public CompletableFuture<String> processDocumentUrlAsync(String fileUrl, List<String> fileUrls, List<String> categories, boolean deleteAfterProcessing, int maxPagesToProcess, boolean boostMode, String externalId, org.json.JSONObject parameters)
      Process Document from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/
      Specified by:
      processDocumentUrlAsync in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      categories - List of categories to use when categorizing the document
      deleteAfterProcessing - Delete this document from Veryfi after data has been extracted
      maxPagesToProcess - 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.
      boostMode - 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
      externalId - Optional custom document identifier. Use this if you would like to assign your own ID to documents
      parameters - Additional request parameters
      Returns:
      the data extracted from the Document CompletableFuture<String>

    • deleteDocument

      public String deleteDocument(String documentId)
      Delete Document from Veryfi. https://docs.veryfi.com/api/receipts-invoices/delete-a-document/
      Specified by:
      deleteDocument in interface Client
      Parameters:
      documentId - ID of the document you'd like to delete.
      Returns:
      the response data. String

    • deleteDocumentAsync

      public CompletableFuture<String> deleteDocumentAsync(String documentId)
      Delete Document from Veryfi. https://docs.veryfi.com/api/receipts-invoices/delete-a-document/
      Specified by:
      deleteDocumentAsync in interface Client
      Parameters:
      documentId - ID of the document you'd like to delete.
      Returns:
      the response data. CompletableFuture<String>

    • updateDocument

      public String updateDocument(String documentId, org.json.JSONObject parameters)
      Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` etc. https://docs.veryfi.com/api/receipts-invoices/update-a-document/
      Specified by:
      updateDocument in interface Client
      Parameters:
      documentId - ID of the document you'd like to update.
      parameters - Additional request parameters
      Returns:
      A document json with updated fields, if fields are writable. Otherwise, a document with unchanged fields. String

    • updateDocumentAsync

      public CompletableFuture<String> updateDocumentAsync(String documentId, org.json.JSONObject parameters)
      Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` etc. https://docs.veryfi.com/api/receipts-invoices/update-a-document/
      Specified by:
      updateDocumentAsync in interface Client
      Parameters:
      documentId - ID of the document you'd like to update.
      parameters - Additional request parameters
      Returns:
      A document json with updated fields, if fields are writable. Otherwise, a document with unchanged fields. CompletableFuture<String>

    • getLineItems

      public String getLineItems(String documentId)
      Retrieve all line items for a document. https://docs.veryfi.com/api/receipts-invoices/get-document-line-items/
      Specified by:
      getLineItems in interface Client
      Parameters:
      documentId - ID of the document you'd like to retrieve.
      Returns:
      List of line items extracted from the document. String

    • getLineItemsAsync

      public CompletableFuture<String> getLineItemsAsync(String documentId)
      Retrieve all line items for a document. https://docs.veryfi.com/api/receipts-invoices/get-document-line-items/
      Specified by:
      getLineItemsAsync in interface Client
      Parameters:
      documentId - ID of the document you'd like to retrieve.
      Returns:
      List of line items extracted from the document. CompletableFuture<String>

    • getLineItem

      public String getLineItem(String documentId, String lineItemId)
      Retrieve a line item for existing document by ID. https://docs.veryfi.com/api/receipts-invoices/get-a-line-item/
      Specified by:
      getLineItem in interface Client
      Parameters:
      documentId - ID of the document you'd like to retrieve.
      lineItemId - ID of the line item you'd like to retrieve.
      Returns:
      Line item extracted from the document. String

    • getLineItemAsync

      public CompletableFuture<String> getLineItemAsync(String documentId, String lineItemId)
      Retrieve a line item for existing document by ID. https://docs.veryfi.com/api/receipts-invoices/get-a-line-item/
      Specified by:
      getLineItemAsync in interface Client
      Parameters:
      documentId - ID of the document you'd like to retrieve.
      lineItemId - ID of the line item you'd like to retrieve.
      Returns:
      Line item extracted from the document. CompletableFuture<String>

    • addLineItem

      public String addLineItem(String documentId, AddLineItem payload) throws NotValidModelException
      Add a new line item on an existing document. https://docs.veryfi.com/api/receipts-invoices/create-a-line-item/
      Specified by:
      addLineItem in interface Client
      Parameters:
      documentId - ID of the document you'd like to update.
      payload - line item object to add.
      Returns:
      Added line item data. String
      Throws:
      NotValidModelException - when the model is not valid it throws this exception.

    • addLineItemAsync

      public CompletableFuture<String> addLineItemAsync(String documentId, AddLineItem payload) throws NotValidModelException
      Add a new line item on an existing document. https://docs.veryfi.com/api/receipts-invoices/create-a-line-item/
      Specified by:
      addLineItemAsync in interface Client
      Parameters:
      documentId - ID of the document you'd like to update.
      payload - line item object to add.
      Returns:
      Added line item data. CompletableFuture<String>
      Throws:
      NotValidModelException - when the model is not valid it throws this exception.

    • updateLineItem

      public String updateLineItem(String documentId, String lineItemId, UpdateLineItem payload) throws NotValidModelException
      Update an existing line item on an existing document. https://docs.veryfi.com/api/receipts-invoices/update-a-line-item/
      Specified by:
      updateLineItem in interface Client
      Parameters:
      documentId - ID of the document you'd like to update.
      lineItemId - ID of the line item you'd like to update.
      payload - line item object to update.
      Returns:
      Line item data with updated fields, if fields are writable. Otherwise line item data with unchanged fields. String
      Throws:
      NotValidModelException - when the model is not valid it throws this exception.

    • updateLineItemAsync

      public CompletableFuture<String> updateLineItemAsync(String documentId, String lineItemId, UpdateLineItem payload) throws NotValidModelException
      Update an existing line item on an existing document. https://docs.veryfi.com/api/receipts-invoices/update-a-line-item/
      Specified by:
      updateLineItemAsync in interface Client
      Parameters:
      documentId - ID of the document you'd like to update.
      lineItemId - ID of the line item you'd like to update.
      payload - line item object to update.
      Returns:
      Line item data with updated fields, if fields are writable. Otherwise line item data with unchanged fields. CompletableFuture<String>
      Throws:
      NotValidModelException - when the model is not valid it throws this exception.

    • deleteLineItems

      public String deleteLineItems(String documentId)
      Delete all line items on an existing document. https://docs.veryfi.com/api/receipts-invoices/delete-all-document-line-items/
      Specified by:
      deleteLineItems in interface Client
      Parameters:
      documentId - ID of the document you'd like to delete.
      Returns:
      the response data. String

    • deleteLineItemsAsync

      public CompletableFuture<String> deleteLineItemsAsync(String documentId)
      Delete all line items on an existing document. https://docs.veryfi.com/api/receipts-invoices/delete-all-document-line-items/
      Specified by:
      deleteLineItemsAsync in interface Client
      Parameters:
      documentId - ID of the document you'd like to delete.
      Returns:

    • deleteLineItem

      public String deleteLineItem(String documentId, String lineItemId)
      Delete an existing line item on an existing document. https://docs.veryfi.com/api/receipts-invoices/delete-a-line-item/
      Specified by:
      deleteLineItem in interface Client
      Parameters:
      documentId - ID of the document you'd like to delete.
      lineItemId - ID of the line item you'd like to delete.
      Returns:
      the response data. String

    • deleteLineItemAsync

      public CompletableFuture<String> deleteLineItemAsync(String documentId, String lineItemId)
      Delete an existing line item on an existing document. https://docs.veryfi.com/api/receipts-invoices/delete-a-line-item/
      Specified by:
      deleteLineItemAsync in interface Client
      Parameters:
      documentId - ID of the document you'd like to delete.
      lineItemId - ID of the line item you'd like to delete.
      Returns:
      the response data. CompletableFuture<String>

    • replaceTags

      public String replaceTags(String documentId, List<String> tags)
      Replace multiple tags on an existing document. https://docs.veryfi.com/api/receipts-invoices/add-tags-to-a-document/
      Specified by:
      replaceTags in interface Client
      Parameters:
      documentId - ID of the document you'd like to update.
      tags - tags array of tags to be added.
      Returns:
      the response data. CompletableFuture<String>

    • replaceTagsAsync

      public CompletableFuture<String> replaceTagsAsync(String documentId, List<String> tags)
      Replace multiple tags on an existing document. https://docs.veryfi.com/api/receipts-invoices/add-tags-to-a-document/
      Specified by:
      replaceTagsAsync in interface Client
      Parameters:
      documentId - ID of the document you'd like to update.
      tags - tags array of tags to be added.
      Returns:
      the response data. CompletableFuture<String>

    • addTags

      public String addTags(String documentId, List<String> tags)
      Add multiple tags on an existing document. https://docs.veryfi.com/api/receipts-invoices/add-tags-to-a-document/
      Specified by:
      addTags in interface Client
      Parameters:
      documentId - ID of the document you'd like to update.
      tags - tags array of tags to be added.
      Returns:
      the response data. CompletableFuture<String>

    • addTagsAsync

      public CompletableFuture<String> addTagsAsync(String documentId, List<String> tags)
      Add multiple tags on an existing document. https://docs.veryfi.com/api/receipts-invoices/add-tags-to-a-document/
      Specified by:
      addTagsAsync in interface Client
      Parameters:
      documentId - ID of the document you'd like to update.
      tags - tags array of tags to be added.
      Returns:
      the response data. CompletableFuture<String>

    • getAnyDocuments

      public String getAnyDocuments(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string String with the list of Any Documents. https://docs.veryfi.com/api/anydocs/get-A-docs/
      Specified by:
      getAnyDocuments in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the url String

    • getAnyDocumentsAsync

      public CompletableFuture<String> getAnyDocumentsAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string CompletableFuture<String> list of AnyDocuments. https://docs.veryfi.com/api/anydocs/get-A-docs/
      Specified by:
      getAnyDocumentsAsync in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the list of previously processed AnyDocuments String

    • getAnyDocument

      public String getAnyDocument(String documentId)
      Returns a json string String AnyDocument information. https://docs.veryfi.com/api/anydocs/get-a-A-doc/
      Specified by:
      getAnyDocument in interface Client
      Parameters:
      documentId - ID of the AnyDocument you'd like to retrieve.
      Returns:
      the data extracted from the AnyDocument String

    • getAnyDocumentAsync

      public CompletableFuture<String> getAnyDocumentAsync(String documentId)
      Returns a json string CompletableFuture<String> AnyDocument information. https://docs.veryfi.com/api/anydocs/get-a-A-doc/
      Specified by:
      getAnyDocumentAsync in interface Client
      Parameters:
      documentId - ID of the AnyDocument you'd like to retrieve.
      Returns:
      the data extracted from the AnyDocument String

    • processAnyDocument

      public String processAnyDocument(String filePath, String blueprintName, org.json.JSONObject parameters)
      Process a AnyDocument and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-A-doc/
      Specified by:
      processAnyDocument in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      blueprintName - The name of the extraction blueprints.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the AnyDocument String

    • processAnyDocumentAsync

      public CompletableFuture<String> processAnyDocumentAsync(String filePath, String blueprintName, org.json.JSONObject parameters)
      Process a AnyDocument and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-A-doc/
      Specified by:
      processAnyDocumentAsync in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      blueprintName - The name of the extraction blueprints.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the AnyDocument CompletableFuture<String>

    • processAnyDocumentUrl

      public String processAnyDocumentUrl(String fileUrl, List<String> fileUrls, String blueprintName, org.json.JSONObject parameters)
      Process AnyDocument from url and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-A-doc/
      Specified by:
      processAnyDocumentUrl in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      blueprintName - The name of the extraction blueprints.
      parameters - Additional request parameters
      Returns:
      the data extracted from the AnyDocument String

    • processAnyDocumentUrlAsync

      public CompletableFuture<String> processAnyDocumentUrlAsync(String fileUrl, List<String> fileUrls, String blueprintName, org.json.JSONObject parameters)
      Process AnyDocument from url and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-A-doc/
      Specified by:
      processAnyDocumentUrlAsync in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      blueprintName - The name of the extraction blueprints.
      parameters - Additional request parameters
      Returns:
      the data extracted from the AnyDocument CompletableFuture<String>

    • deleteAnyDocument

      public String deleteAnyDocument(String documentId)
      Delete AnyDocument from Veryfi. https://docs.veryfi.com/api/anydocs/delete-a-A-doc/
      Specified by:
      deleteAnyDocument in interface Client
      Parameters:
      documentId - ID of the AnyDocument you'd like to delete.
      Returns:
      the response data. String

    • deleteAnyDocumentAsync

      public CompletableFuture<String> deleteAnyDocumentAsync(String documentId)
      Delete AnyDocument from Veryfi. https://docs.veryfi.com/api/anydocs/delete-a-A-doc/
      Specified by:
      deleteAnyDocumentAsync in interface Client
      Parameters:
      documentId - ID of the AnyDocument you'd like to delete.
      Returns:
      the response data. CompletableFuture<String>

    • getBankStatements

      public String getBankStatements(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string String with the list of Bank Statements. https://docs.veryfi.com/api/bank-statements/get-bank-statements/
      Specified by:
      getBankStatements in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the url String

    • getBankStatementsAsync

      public CompletableFuture<String> getBankStatementsAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string CompletableFuture<String> list of BankStatements. https://docs.veryfi.com/api/bank-statements/get-bank-statements/
      Specified by:
      getBankStatementsAsync in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the list of previously processed BankStatements String

    • getBankStatement

      public String getBankStatement(String documentId)
      Returns a json string String BankStatement information. https://docs.veryfi.com/api/bank-statements/get-a-bank-statement/
      Specified by:
      getBankStatement in interface Client
      Parameters:
      documentId - ID of the BankStatement you'd like to retrieve.
      Returns:
      the data extracted from the BankStatement String

    • getBankStatementAsync

      public CompletableFuture<String> getBankStatementAsync(String documentId)
      Returns a json string CompletableFuture<String> BankStatement information. https://docs.veryfi.com/api/bank-statements/get-a-bank-statement/
      Specified by:
      getBankStatementAsync in interface Client
      Parameters:
      documentId - ID of the BankStatement you'd like to retrieve.
      Returns:
      the data extracted from the BankStatement String

    • processBankStatement

      public String processBankStatement(String filePath, org.json.JSONObject parameters)
      Process a BankStatement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
      Specified by:
      processBankStatement in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the BankStatement String

    • processBankStatementAsync

      public CompletableFuture<String> processBankStatementAsync(String filePath, org.json.JSONObject parameters)
      Process a BankStatement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
      Specified by:
      processBankStatementAsync in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the BankStatement CompletableFuture<String>

    • processBankStatementUrl

      public String processBankStatementUrl(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters)
      Process BankStatement from url and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
      Specified by:
      processBankStatementUrl in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      parameters - Additional request parameters
      Returns:
      the data extracted from the BankStatement String

    • processBankStatementUrlAsync

      public CompletableFuture<String> processBankStatementUrlAsync(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters)
      Process BankStatement from url and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
      Specified by:
      processBankStatementUrlAsync in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      parameters - Additional request parameters
      Returns:
      the data extracted from the BankStatement CompletableFuture<String>

    • deleteBankStatement

      public String deleteBankStatement(String documentId)
      Delete BankStatement from Veryfi. https://docs.veryfi.com/api/bank-statements/delete-a-bank-statement/
      Specified by:
      deleteBankStatement in interface Client
      Parameters:
      documentId - ID of the BankStatement you'd like to delete.
      Returns:
      the response data. String

    • deleteBankStatementAsync

      public CompletableFuture<String> deleteBankStatementAsync(String documentId)
      Delete BankStatement from Veryfi. https://docs.veryfi.com/api/bank-statements/delete-a-bank-statement/
      Specified by:
      deleteBankStatementAsync in interface Client
      Parameters:
      documentId - ID of the BankStatement you'd like to delete.
      Returns:
      the response data. CompletableFuture<String>

    • getBusinessCards

      public String getBusinessCards(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string String with the list of Business Cards. https://docs.veryfi.com/api/business-cards/get-business-cards/
      Specified by:
      getBusinessCards in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the url String

    • getBusinessCardsAsync

      public CompletableFuture<String> getBusinessCardsAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string CompletableFuture<String> list of Business Cards. https://docs.veryfi.com/api/business-cards/get-business-cards/
      Specified by:
      getBusinessCardsAsync in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the list of previously processed Business Cards String

    • getBusinessCard

      public String getBusinessCard(String documentId)
      Returns a json string String Business Card information. https://docs.veryfi.com/api/business-cards/get-a-business-card/
      Specified by:
      getBusinessCard in interface Client
      Parameters:
      documentId - ID of the Business Card you'd like to retrieve.
      Returns:
      the data extracted from the Business Card String

    • getBusinessCardAsync

      public CompletableFuture<String> getBusinessCardAsync(String documentId)
      Returns a json string CompletableFuture<String> Business Card information. https://docs.veryfi.com/api/business-cards/get-a-business-card/
      Specified by:
      getBusinessCardAsync in interface Client
      Parameters:
      documentId - ID of the Business Card you'd like to retrieve.
      Returns:
      the data extracted from the Business Card String

    • processBusinessCard

      public String processBusinessCard(String filePath, org.json.JSONObject parameters)
      Process a Business Card and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/
      Specified by:
      processBusinessCard in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the Business Card String

    • processBusinessCardAsync

      public CompletableFuture<String> processBusinessCardAsync(String filePath, org.json.JSONObject parameters)
      Process a Business Card and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/
      Specified by:
      processBusinessCardAsync in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the Business Card CompletableFuture<String>

    • processBusinessCardUrl

      public String processBusinessCardUrl(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters)
      Process Business Card from url and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/
      Specified by:
      processBusinessCardUrl in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      parameters - Additional request parameters
      Returns:
      the data extracted from the Business Card String

    • processBusinessCardUrlAsync

      public CompletableFuture<String> processBusinessCardUrlAsync(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters)
      Process Business Card from url and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/
      Specified by:
      processBusinessCardUrlAsync in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      parameters - Additional request parameters
      Returns:
      the data extracted from the Business Card CompletableFuture<String>

    • deleteBusinessCard

      public String deleteBusinessCard(String documentId)
      Delete Business Card from Veryfi. https://docs.veryfi.com/api/business-cards/delete-a-business-card/
      Specified by:
      deleteBusinessCard in interface Client
      Parameters:
      documentId - ID of the Business Card you'd like to delete.
      Returns:
      the response data. String

    • deleteBusinessCardAsync

      public CompletableFuture<String> deleteBusinessCardAsync(String documentId)
      Delete Business Card from Veryfi. https://docs.veryfi.com/api/business-cards/delete-a-business-card/
      Specified by:
      deleteBusinessCardAsync in interface Client
      Parameters:
      documentId - ID of the Business Card you'd like to delete.
      Returns:
      the response data. CompletableFuture<String>

    • getChecks

      public String getChecks(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string String with the list of Checks. https://docs.veryfi.com/api/checks/get-checks/
      Specified by:
      getChecks in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the url String

    • getChecksAsync

      public CompletableFuture<String> getChecksAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string CompletableFuture<String> list of Checks. https://docs.veryfi.com/api/checks/get-checks/
      Specified by:
      getChecksAsync in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the list of previously processed checks String

    • getCheck

      public String getCheck(String documentId)
      Returns a json string String Check information. https://docs.veryfi.com/api/checks/get-a-check/
      Specified by:
      getCheck in interface Client
      Parameters:
      documentId - ID of the Check you'd like to retrieve.
      Returns:
      the data extracted from the Check String

    • getCheckAsync

      public CompletableFuture<String> getCheckAsync(String documentId)
      Returns a json string CompletableFuture<String> Check information. https://docs.veryfi.com/api/checks/get-a-check/
      Specified by:
      getCheckAsync in interface Client
      Parameters:
      documentId - ID of the Check you'd like to retrieve.
      Returns:
      the data extracted from the Check String

    • processCheck

      public String processCheck(String filePath, org.json.JSONObject parameters)
      Process a Check and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/
      Specified by:
      processCheck in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the Check String

    • processCheckAsync

      public CompletableFuture<String> processCheckAsync(String filePath, org.json.JSONObject parameters)
      Process a Check and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/
      Specified by:
      processCheckAsync in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the Check CompletableFuture<String>

    • processCheckUrl

      public String processCheckUrl(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters)
      Process Check from url and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/
      Specified by:
      processCheckUrl in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      parameters - Additional request parameters
      Returns:
      the data extracted from the Check String

    • processCheckUrlAsync

      public CompletableFuture<String> processCheckUrlAsync(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters)
      Process Check from url and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/
      Specified by:
      processCheckUrlAsync in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      parameters - Additional request parameters
      Returns:
      the data extracted from the Check CompletableFuture<String>

    • deleteCheck

      public String deleteCheck(String documentId)
      Delete Check from Veryfi. https://docs.veryfi.com/api/checks/delete-a-check/
      Specified by:
      deleteCheck in interface Client
      Parameters:
      documentId - ID of the Check you'd like to delete.
      Returns:
      the response data. String

    • deleteCheckAsync

      public CompletableFuture<String> deleteCheckAsync(String documentId)
      Delete Check from Veryfi. https://docs.veryfi.com/api/checks/delete-a-check/
      Specified by:
      deleteCheckAsync in interface Client
      Parameters:
      documentId - ID of the Check you'd like to delete.
      Returns:
      the response data. CompletableFuture<String>

    • getW2s

      public String getW2s(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string String with the list of W2s. https://docs.veryfi.com/api/w2s/get-w-2-s/
      Specified by:
      getW2s in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the url String

    • getW2sAsync

      public CompletableFuture<String> getW2sAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string CompletableFuture<String> list of W2s. https://docs.veryfi.com/api/w2s/get-w-2-s/
      Specified by:
      getW2sAsync in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the list of previously processed W2s String

    • getW2

      public String getW2(String documentId)
      Returns a json string String W2 information. https://docs.veryfi.com/api/w2s/get-a-w-2/
      Specified by:
      getW2 in interface Client
      Parameters:
      documentId - ID of the W2 you'd like to retrieve.
      Returns:
      the data extracted from the W2 String

    • getW2Async

      public CompletableFuture<String> getW2Async(String documentId)
      Returns a json string CompletableFuture<String> W2 information. https://docs.veryfi.com/api/w2s/get-a-w-2/
      Specified by:
      getW2Async in interface Client
      Parameters:
      documentId - ID of the W2 you'd like to retrieve.
      Returns:
      the data extracted from the W2 String

    • processW2

      public String processW2(String filePath, org.json.JSONObject parameters)
      Process a W2 and extract all the fields from it. https://docs.veryfi.com/api/w2s/process-a-w-2/
      Specified by:
      processW2 in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the W2 String

    • processW2Async

      public CompletableFuture<String> processW2Async(String filePath, org.json.JSONObject parameters)
      Process a W2 and extract all the fields from it. https://docs.veryfi.com/api/w2s/process-a-w-2/
      Specified by:
      processW2Async in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the W2 CompletableFuture<String>

    • processW2Url

      public String processW2Url(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters)
      Process W2 from url and extract all the fields from it. https://docs.veryfi.com/api/w2s/process-a-w-2/
      Specified by:
      processW2Url in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      parameters - Additional request parameters
      Returns:
      the data extracted from the W2 String

    • processW2UrlAsync

      public CompletableFuture<String> processW2UrlAsync(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters)
      Process W2 from url and extract all the fields from it. https://docs.veryfi.com/api/w2s/process-a-w-2/
      Specified by:
      processW2UrlAsync in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      parameters - Additional request parameters
      Returns:
      the data extracted from the W2 CompletableFuture<String>

    • deleteW2

      public String deleteW2(String documentId)
      Delete W2 from Veryfi. https://docs.veryfi.com/api/w2s/delete-a-w-2/
      Specified by:
      deleteW2 in interface Client
      Parameters:
      documentId - ID of the W2 you'd like to delete.
      Returns:
      the response data. String

    • deleteW2Async

      public CompletableFuture<String> deleteW2Async(String documentId)
      Delete W2 from Veryfi. https://docs.veryfi.com/api/w2s/delete-a-w-2/
      Specified by:
      deleteW2Async in interface Client
      Parameters:
      documentId - ID of the W2 you'd like to delete.
      Returns:
      the response data. CompletableFuture<String>

    • getW8BenEs

      public String getW8BenEs(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string String with the list of W-8BEN-E. https://docs.veryfi.com/api/w-8ben-e/get-w-8-ben-es/
      Specified by:
      getW8BenEs in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the url String

    • getW8BenEsAsync

      public CompletableFuture<String> getW8BenEsAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string CompletableFuture<String> list of W-8BEN-E. https://docs.veryfi.com/api/w-8ben-e/get-w-8-ben-es/
      Specified by:
      getW8BenEsAsync in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the list of previously processed W-8BEN-E String

    • getW8BenE

      public String getW8BenE(String documentId)
      Returns a json string String W-8BEN-E information. https://docs.veryfi.com/api/w-8ben-e/get-a-w-8-ben-e/
      Specified by:
      getW8BenE in interface Client
      Parameters:
      documentId - ID of the W-8BEN-E you'd like to retrieve.
      Returns:
      the data extracted from the W-8BEN-E String

    • getW8BenEAsync

      public CompletableFuture<String> getW8BenEAsync(String documentId)
      Returns a json string CompletableFuture<String> W-8BEN-E information. https://docs.veryfi.com/api/w-8ben-e/get-a-w-8-ben-e/
      Specified by:
      getW8BenEAsync in interface Client
      Parameters:
      documentId - ID of the W-8BEN-E you'd like to retrieve.
      Returns:
      the data extracted from the W-8BEN-E String

    • processW8BenE

      public String processW8BenE(String filePath, org.json.JSONObject parameters)
      Process a W-8BEN-E and extract all the fields from it. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/
      Specified by:
      processW8BenE in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the W-8BEN-E String

    • processW8BenEAsync

      public CompletableFuture<String> processW8BenEAsync(String filePath, org.json.JSONObject parameters)
      Process a W-8BEN-E and extract all the fields from it. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/
      Specified by:
      processW8BenEAsync in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the W-8BEN-E CompletableFuture<String>

    • processW8BenEUrl

      public String processW8BenEUrl(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters)
      Process W-8BEN-E from url and extract all the fields from it. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/
      Specified by:
      processW8BenEUrl in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      parameters - Additional request parameters
      Returns:
      the data extracted from the W-8BEN-E String

    • processW8BenEUrlAsync

      public CompletableFuture<String> processW8BenEUrlAsync(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters)
      Process W-8BEN-E from url and extract all the fields from it. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/
      Specified by:
      processW8BenEUrlAsync in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      parameters - Additional request parameters
      Returns:
      the data extracted from the W-8BEN-E CompletableFuture<String>

    • deleteW8BenE

      public String deleteW8BenE(String documentId)
      Delete W-8BEN-E from Veryfi. https://docs.veryfi.com/api/w-8ben-e/delete-a-w-8-ben-e/
      Specified by:
      deleteW8BenE in interface Client
      Parameters:
      documentId - ID of the W-8BEN-E you'd like to delete.
      Returns:
      the response data. String

    • deleteW8BenEAsync

      public CompletableFuture<String> deleteW8BenEAsync(String documentId)
      Delete W-8BEN-E from Veryfi. https://docs.veryfi.com/api/w-8ben-e/delete-a-w-8-ben-e/
      Specified by:
      deleteW8BenEAsync in interface Client
      Parameters:
      documentId - ID of the W-8BEN-E you'd like to delete.
      Returns:
      the response data. CompletableFuture<String>

    • getW9s

      public String getW9s(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string String with the list of W9s. https://docs.veryfi.com/api/w9s/get-w-9-s/
      Specified by:
      getW9s in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the url String

    • getW9sAsync

      public CompletableFuture<String> getW9sAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters)
      Returns a json string CompletableFuture<String> list of W9s. https://docs.veryfi.com/api/w9s/get-w-9-s/
      Specified by:
      getW9sAsync in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      boundingBoxes - A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
      confidenceDetails - A field used to determine whether or not to return the score and ocr_score fields in the Document response.
      parameters - Additional request parameters.
      Returns:
      the list of previously processed W9s String

    • getW9

      public String getW9(String documentId)
      Returns a json string String W9 information. https://docs.veryfi.com/api/w9s/get-a-w-9/
      Specified by:
      getW9 in interface Client
      Parameters:
      documentId - ID of the W9 you'd like to retrieve.
      Returns:
      the data extracted from the W9 String

    • getW9Async

      public CompletableFuture<String> getW9Async(String documentId)
      Returns a json string CompletableFuture<String> W9 information. https://docs.veryfi.com/api/w9s/get-a-w-9/
      Specified by:
      getW9Async in interface Client
      Parameters:
      documentId - ID of the W9 you'd like to retrieve.
      Returns:
      the data extracted from the W9 String

    • processW9

      public String processW9(String filePath, org.json.JSONObject parameters)
      Process a W9 and extract all the fields from it. https://docs.veryfi.com/api/w9s/process-a-w-9/
      Specified by:
      processW9 in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the W9 String

    • processW9Async

      public CompletableFuture<String> processW9Async(String filePath, org.json.JSONObject parameters)
      Process a W9 and extract all the fields from it. https://docs.veryfi.com/api/w9s/process-a-w-9/
      Specified by:
      processW9Async in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the W9 CompletableFuture<String>

    • processW9Url

      public String processW9Url(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters)
      Process W9 from url and extract all the fields from it. https://docs.veryfi.com/api/w9s/process-a-w-9/
      Specified by:
      processW9Url in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      parameters - Additional request parameters
      Returns:
      the data extracted from the W9 String

    • processW9UrlAsync

      public CompletableFuture<String> processW9UrlAsync(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters)
      Process W9 from url and extract all the fields from it. https://docs.veryfi.com/api/w9s/process-a-w-9/
      Specified by:
      processW9UrlAsync in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      fileUrls - Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
      parameters - Additional request parameters
      Returns:
      the data extracted from the W9 CompletableFuture<String>

    • deleteW9

      public String deleteW9(String documentId)
      Delete W9 from Veryfi. https://docs.veryfi.com/api/w9s/delete-a-w-9/
      Specified by:
      deleteW9 in interface Client
      Parameters:
      documentId - ID of the W9 you'd like to delete.
      Returns:
      the response data. String

    • deleteW9Async

      public CompletableFuture<String> deleteW9Async(String documentId)
      Delete W9 from Veryfi. https://docs.veryfi.com/api/w9s/delete-a-w-9/
      Specified by:
      deleteW9Async in interface Client
      Parameters:
      documentId - ID of the W9 you'd like to delete.
      Returns:
      the response data. CompletableFuture<String>

    • getContracts

      public String getContracts(int page, int pageSize, org.json.JSONObject parameters)
      Returns a json string String with the list of Contracts.
      Specified by:
      getContracts in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      parameters - Additional request parameters.
      Returns:
      the url String

    • getContractsAsync

      public CompletableFuture<String> getContractsAsync(int page, int pageSize, org.json.JSONObject parameters)
      Returns a json string CompletableFuture<String> list of Contracts.
      Specified by:
      getContractsAsync in interface Client
      Parameters:
      page - The page number. The response is capped to maximum of 50 results per page.
      pageSize - The number of Documents per page.
      parameters - Additional request parameters.
      Returns:
      the list of previously processed Contracts String

    • getContract

      public String getContract(String documentId)
      Returns a json string String with the Contract information.
      Specified by:
      getContract in interface Client
      Parameters:
      documentId - ID of the Contract you'd like to retrieve.
      Returns:
      the data extracted from the Contract String

    • getContractAsync

      public CompletableFuture<String> getContractAsync(String documentId)
      Returns a json string CompletableFuture<String> with the Contract information.
      Specified by:
      getContractAsync in interface Client
      Parameters:
      documentId - ID of the Contract you'd like to retrieve.
      Returns:
      the data extracted from the Contract String

    • processContract

      public String processContract(String filePath, org.json.JSONObject parameters)
      Process a Contract and extract all the fields from it.
      Specified by:
      processContract in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the Contract String

    • processContractAsync

      public CompletableFuture<String> processContractAsync(String filePath, org.json.JSONObject parameters)
      Process a Contract and extract all the fields from it.
      Specified by:
      processContractAsync in interface Client
      Parameters:
      filePath - Path on disk to a file to submit for data extraction.
      parameters - Additional request parameters.
      Returns:
      the data extracted from the Contract CompletableFuture<String>

    • processContractUrl

      public String processContractUrl(String fileUrl, org.json.JSONObject parameters)
      Process Contract from url and extract all the fields from it.
      Specified by:
      processContractUrl in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      parameters - Additional request parameters
      Returns:
      the data extracted from the Contract String

    • processContractUrlAsync

      public CompletableFuture<String> processContractUrlAsync(String fileUrl, org.json.JSONObject parameters)
      Process Contract from url and extract all the fields from it.
      Specified by:
      processContractUrlAsync in interface Client
      Parameters:
      fileUrl - Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
      parameters - Additional request parameters
      Returns:
      the data extracted from the Contract CompletableFuture<String>

    • deleteContract

      public String deleteContract(String documentId)
      Delete a Contract from Veryfi.
      Specified by:
      deleteContract in interface Client
      Parameters:
      documentId - ID of the Contract you'd like to delete.
      Returns:
      the response data. String

    • deleteContractAsync

      public CompletableFuture<String> deleteContractAsync(String documentId)
      Delete a Contract from Veryfi.
      Specified by:
      deleteContractAsync in interface Client
      Parameters:
      documentId - ID of the Contract you'd like to delete.
      Returns:
      the response data. CompletableFuture<String>