-
veryfi-java 2.0.0 API
+veryfi-java 2.1.0 API
Packages
@@ -69,7 +69,7 @@ Client."User-Agent"public static final String"Java Veryfi-Java/2.0.0""Java Veryfi-Java/2.1.0"public static final String"X-Veryfi-Request-Signature"Client.CompletableFuture<String> AnyDocument information.CompletableFuture<String> AnyDocument information.CompletableFuture<String> AnyDocument information.CompletableFuture<String> AnyDocument information.CompletableFuture<String> list of AnyDocuments.CompletableFuture<String> list of AnyDocuments.CompletableFuture<String> list of AnyDocuments.CompletableFuture<String> list of AnyDocuments.CompletableFuture<String> BankStatement information.CompletableFuture<String> BankStatement information.CompletableFuture<String> BankStatement information.CompletableFuture<String> BankStatement information.CompletableFuture<String> list of BankStatements.CompletableFuture<String> list of BankStatements.CompletableFuture<String> list of BankStatements.CompletableFuture<String> list of BankStatements.CompletableFuture<String> Business Card information.CompletableFuture<String> Business Card information.CompletableFuture<String> Business Card information.CompletableFuture<String> Business Card information.CompletableFuture<String> list of Business Cards.CompletableFuture<String> list of Business Cards.CompletableFuture<String> list of Business Cards.CompletableFuture<String> list of Business Cards.CompletableFuture<String> Check information.CompletableFuture<String> Check information.CompletableFuture<String> Check information.CompletableFuture<String> Check information.CompletableFuture<String> list of Checks.CompletableFuture<String> list of Checks.CompletableFuture<String> list of Checks.CompletableFuture<String> list of Checks.CompletableFuture<String> with the Contract information.CompletableFuture<String> with the Contract information.CompletableFuture<String> with the Contract information.CompletableFuture<String> with the Contract information.CompletableFuture<String> list of Contracts.CompletableFuture<String> list of Contracts.CompletableFuture<String> list of Contracts.CompletableFuture<String> list of Contracts.CompletableFuture<String> document information.CompletableFuture<String> document information.CompletableFuture<String> document information.CompletableFuture<String> document information.CompletableFuture<String> list of documents.CompletableFuture<String> list of documents.CompletableFuture<String> list of documents.CompletableFuture<String> list of documents.String W2 information.CompletableFuture<String> W2 information.CompletableFuture<String> W2 information.CompletableFuture<String> W2 information.CompletableFuture<String> W2 information.CompletableFuture<String> list of W2s.CompletableFuture<String> list of W2s.CompletableFuture<String> list of W2s.CompletableFuture<String> list of W2s.CompletableFuture<String> W-8BEN-E information.CompletableFuture<String> W-8BEN-E information.CompletableFuture<String> W-8BEN-E information.CompletableFuture<String> W-8BEN-E information.CompletableFuture<String> list of W-8BEN-E.CompletableFuture<String> list of W-8BEN-E.CompletableFuture<String> list of W-8BEN-E.CompletableFuture<String> list of W-8BEN-E.CompletableFuture<String> W9 information.CompletableFuture<String> W9 information.CompletableFuture<String> W9 information.CompletableFuture<String> W9 information.CompletableFuture<String> list of W9s.CompletableFuture<String> list of W9s.CompletableFuture<String> list of W9s.CompletableFuture<String> list of W9s.SplitServices.SplitServices.Copyright © 2024. All rights reserved.
+Copyright © 2025. All rights reserved.
diff --git a/docs/type-search-index.js b/docs/type-search-index.js index ebfaff5..dc8058b 100644 --- a/docs/type-search-index.js +++ b/docs/type-search-index.js @@ -1 +1 @@ -typeSearchIndex = [{"p":"veryfi.models","l":"AddLineItem"},{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"veryfi","l":"Client"},{"p":"veryfi.services","l":"ClientImpl"},{"p":"veryfi","l":"Constants"},{"p":"veryfi","l":"Credentials"},{"p":"veryfi.enums","l":"Endpoint"},{"p":"veryfi.enums","l":"HttpMethod"},{"p":"veryfi","l":"NetworkClient"},{"p":"veryfi.models","l":"NotValidModelException"},{"p":"veryfi.models","l":"SharedLineItem"},{"p":"veryfi.models","l":"UpdateLineItem"},{"p":"veryfi","l":"VeryfiClientFactory"}];updateSearchResults(); \ No newline at end of file +typeSearchIndex = [{"p":"veryfi.models","l":"AddLineItem"},{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"veryfi","l":"Base64Helper"},{"p":"veryfi","l":"Client"},{"p":"veryfi.services","l":"ClientImpl"},{"p":"veryfi","l":"Constants"},{"p":"veryfi","l":"Credentials"},{"p":"veryfi.enums","l":"Endpoint"},{"p":"veryfi.enums","l":"HttpMethod"},{"p":"veryfi","l":"NetworkClient"},{"p":"veryfi.models","l":"NotValidModelException"},{"p":"veryfi.models","l":"SharedLineItem"},{"p":"veryfi.services","l":"SplitServices"},{"p":"veryfi.models","l":"UpdateLineItem"},{"p":"veryfi","l":"VeryfiClientFactory"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/veryfi/Base64Helper.html b/docs/veryfi/Base64Helper.html new file mode 100644 index 0000000..fcc8aa2 --- /dev/null +++ b/docs/veryfi/Base64Helper.html @@ -0,0 +1,256 @@ + + + + ++ This class provides helper methods for converting files to Base64 encoded strings + that can be used with the Veryfi API. It handles both file paths and File objects, + and automatically generates the appropriate data URI prefix based on file extension. +
static StringgetBase64FileContent(File file) static StringgetBase64FileContent(String filePath) protected static StringgetFileExtension(File file) static StringgetUriPrefix(File file) + This method reads the file from the specified path, encodes it to Base64, + and prepends the appropriate data URI prefix based on the file extension. +
filePath - The path to the file to encodeIOException - if the file cannot be read+ This method reads the file content, encodes it to Base64, and prepends + the appropriate data URI prefix based on the file extension. +
file - The file to encodeIOException - if the file cannot be read+ This method determines the MIME type based on the file extension and + returns the appropriate data URI prefix. If no extension is found, + it defaults to "image/png". +
file - The file to generate the prefix for+ This method parses the filename to extract the extension (everything after + the last dot). If no extension is found or the file has no name, an empty + string is returned. +
file - The file to extract the extension fromclassifyDocument(String fileName,
+ String fileData,
+ org.json.JSONObject parameters) classifyDocument(String filePath,
+ org.json.JSONObject parameters) classifyDocumentAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters) classifyDocumentAsync(String filePath,
+ org.json.JSONObject parameters) classifyDocumentUrl(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters) classifyDocumentUrlAsync(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters) deleteAnyDocument(String documentId) deleteBankStatement(String documentId) deleteBankStatementAsync(String documentId) deleteBusinessCard(String documentId) getAnyDocumentAsync(String documentId) CompletableFuture<String> AnyDocument information.CompletableFuture<String> AnyDocument information.getAnyDocuments(int page,
@@ -258,7 +298,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of AnyDocuments.CompletableFuture<String> list of AnyDocuments.getBankStatement(String documentId) getBankStatementAsync(String documentId) CompletableFuture<String> BankStatement information.CompletableFuture<String> BankStatement information.getBankStatements(int page,
@@ -286,7 +326,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of BankStatements.CompletableFuture<String> list of BankStatements.getBusinessCard(String documentId) getBusinessCardAsync(String documentId) CompletableFuture<String> Business Card information.CompletableFuture<String> Business Card information.getBusinessCards(int page,
@@ -314,7 +354,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of Business Cards.CompletableFuture<String> list of Business Cards.getCheckAsync(String documentId) CompletableFuture<String> Check information.CompletableFuture<String> Check information.getChecks(int page,
@@ -342,7 +382,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of Checks.CompletableFuture<String> list of Checks.getContract(String documentId) getContractAsync(String documentId) CompletableFuture<String> with the Contract information.CompletableFuture<String> with the Contract information.getContracts(int page,
@@ -366,7 +406,7 @@ Method Summary
int pageSize,
org.json.JSONObject parameters) CompletableFuture<String> list of Contracts.CompletableFuture<String> list of Contracts.getDocument(String documentId) getDocumentAsync(String documentId) CompletableFuture<String> document information.CompletableFuture<String> document information.getDocuments(int page,
@@ -394,7 +434,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of documents.CompletableFuture<String> list of documents.getLineItem(String documentId,
@@ -419,6 +459,34 @@ Method Summary
Retrieve all line items for a document.
getSplitDocument(String documentId) getSplitDocumentAsync(String documentId) getSplitDocuments(int page,
+ int pageSize,
+ boolean boundingBoxes,
+ boolean confidenceDetails,
+ org.json.JSONObject parameters) getSplitDocumentsAsync(int page,
+ int pageSize,
+ boolean boundingBoxes,
+ boolean confidenceDetails,
+ org.json.JSONObject parameters) String W2 information.getW2Async(String documentId) CompletableFuture<String> W2 information.CompletableFuture<String> W2 information.getW2s(int page,
@@ -444,7 +512,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of W2s.CompletableFuture<String> list of W2s.getW8BenEAsync(String documentId) CompletableFuture<String> W-8BEN-E information.CompletableFuture<String> W-8BEN-E information.getW8BenEs(int page,
@@ -472,7 +540,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of W-8BEN-E.CompletableFuture<String> list of W-8BEN-E.getW9Async(String documentId) CompletableFuture<String> W9 information.CompletableFuture<String> W9 information.getW9s(int page,
@@ -500,10 +568,26 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of W9s.CompletableFuture<String> list of W9s.processAnyDocument(String filePath,
+processAnyDocument(String fileName,
+ String fileData,
+ String blueprintName,
+ org.json.JSONObject parameters)
+
+Process a AnyDocument and extract all the fields from it.
+
+
+processAnyDocument(String filePath,
+ String blueprintName,
+ org.json.JSONObject parameters)
+
+Process a AnyDocument and extract all the fields from it.
+
+
+processAnyDocumentAsync(String fileName,
+ String fileData,
String blueprintName,
org.json.JSONObject parameters)
@@ -533,33 +617,61 @@ Method Summary
Process AnyDocument from url and extract all the fields from it.
-processBankStatement(String filePath,
+processBankStatement(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Process a Bank Statement and extract all the fields from it.
+
+
+processBankStatement(String filePath,
+ org.json.JSONObject parameters)
+
+Process a Bank Statement and extract all the fields from it.
+
+
+processBankStatementAsync(String fileName,
+ String fileData,
org.json.JSONObject parameters)
-Process a BankStatement and extract all the fields from it.
+Process a Bank Statement and extract all the fields from it.
processBankStatementAsync(String filePath,
org.json.JSONObject parameters)
-Process a BankStatement and extract all the fields from it.
+Process a Bank Statement and extract all the fields from it.
processBankStatementUrl(String fileUrl,
List<String> fileUrls,
org.json.JSONObject parameters)
-Process BankStatement from url and extract all the fields from it.
+Process Bank Statement from url and extract all the fields from it.
processBankStatementUrlAsync(String fileUrl,
List<String> fileUrls,
org.json.JSONObject parameters)
-Process BankStatement from url and extract all the fields from it.
+Process Bank Statement from url and extract all the fields from it.
-processBusinessCard(String filePath,
+processBusinessCard(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Process a Business Card and extract all the fields from it.
+
+
+processBusinessCard(String filePath,
+ org.json.JSONObject parameters)
+
+Process a Business Card and extract all the fields from it.
+
+
+processBusinessCardAsync(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Process a Business Card and extract all the fields from it.
@@ -585,7 +697,21 @@ Method Summary
Process Business Card from url and extract all the fields from it.
-processCheck(String filePath,
+processCheck(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Process a Check and extract all the fields from it.
+
+
+processCheck(String filePath,
+ org.json.JSONObject parameters)
+
+Process a Check and extract all the fields from it.
+
+
+processCheckAsync(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Process a Check and extract all the fields from it.
@@ -611,7 +737,21 @@ Method Summary
Process Check from url and extract all the fields from it.
-processContract(String filePath,
+processContract(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Process a Contract and extract all the fields from it.
+
+
+processContract(String filePath,
+ org.json.JSONObject parameters)
+
+Process a Contract and extract all the fields from it.
+
+
+processContractAsync(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Process a Contract and extract all the fields from it.
@@ -635,7 +775,25 @@ Method Summary
Process Contract from url and extract all the fields from it.
-processDocument(String filePath,
+processDocument(String fileName,
+ String fileData,
+ List<String> categories,
+ boolean deleteAfterProcessing,
+ org.json.JSONObject parameters)
+
+Process a document and extract all the fields from it.
+
+
+processDocument(String filePath,
+ List<String> categories,
+ boolean deleteAfterProcessing,
+ org.json.JSONObject parameters)
+
+Process a document and extract all the fields from it.
+
+
+processDocumentAsync(String fileName,
+ String fileData,
List<String> categories,
boolean deleteAfterProcessing,
org.json.JSONObject parameters)
@@ -675,7 +833,21 @@ Method Summary
Process Document from url and extract all the fields from it.
-processW2(String filePath,
+
+
+Process a W2 and extract all the fields from it.
+
+
+
+
+Process a W2 and extract all the fields from it.
+
+
+processW2Async(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Process a W2 and extract all the fields from it.
@@ -701,7 +873,21 @@ Method Summary
Process W2 from url and extract all the fields from it.
-processW8BenE(String filePath,
+processW8BenE(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Process a W-8BEN-E and extract all the fields from it.
+
+
+processW8BenE(String filePath,
+ org.json.JSONObject parameters)
+
+Process a W-8BEN-E and extract all the fields from it.
+
+
+processW8BenEAsync(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Process a W-8BEN-E and extract all the fields from it.
@@ -727,7 +913,21 @@ Method Summary
Process W-8BEN-E from url and extract all the fields from it.
-processW9(String filePath,
+
+
+Process a W9 and extract all the fields from it.
+
+
+
+
+Process a W9 and extract all the fields from it.
+
+
+processW9Async(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Process a W9 and extract all the fields from it.
@@ -765,6 +965,46 @@ Method Summary
Replace multiple tags on an existing document.
+splitDocument(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Split document PDF from url and extract all the fields from it.
+
+
+splitDocument(String filePath,
+ org.json.JSONObject parameters)
+
+Split document PDF from url and extract all the fields from it.
+
+
+splitDocumentAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Split document PDF from url and extract all the fields from it.
+
+
+splitDocumentAsync(String filePath,
+ org.json.JSONObject parameters)
+
+Split document PDF from url and extract all the fields from it.
+
+
+splitDocumentUrl(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters)
+
+Split document PDF from url and extract all the fields from it.
+
+
+splitDocumentUrlAsync(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters)
+
+Split document PDF from url and extract all the fields from it.
+
+
updateDocument(String documentId,
org.json.JSONObject parameters)
@@ -833,7 +1073,7 @@ getDocumentsAsync
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/
+Returns a json string CompletableFuture<String> list of documents. https://docs.veryfi.com/api/receipts-invoices/search-documents/
- Parameters:
page - The page number. The response is capped to maximum of 50 results per page.getDocument
getDocumentAsync
-Returns a json string CompletableFuture<String> document information. https://docs.veryfi.com/api/receipts-invoices/get-a-document/
+Returns a json string CompletableFuture<String> document information. https://docs.veryfi.com/api/receipts-invoices/get-a-document/
- Parameters:
documentId - ID of the document you'd like to retrieve.- Returns:
-- the data extracted from the Document
CompletableFuture<String>
+- the data extracted from the Document
CompletableFuture<String>
@@ -906,7 +1146,49 @@ processDocumentAsync
deleteAfterProcessing - Delete this document from Veryfi after data has been extractedparameters - Additional request parameters- Returns:
-- the data extracted from the Document
CompletableFuture<String>
+- the data extracted from the Document
CompletableFuture<String>
+
+
+
+-
+
+processDocument
+String processDocument(String fileName,
+ String fileData,
+ 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/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file datacategories - List of categories Veryfi can use to categorize the documentdeleteAfterProcessing - Delete this document from Veryfi after data has been extractedparameters - Additional request parameters- Returns:
+- the data extracted from the Document
String
+
+
+
+-
+
+processDocumentAsync
+CompletableFuture<String> processDocumentAsync(String fileName,
+ String fileData,
+ 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/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file datacategories - List of categories Veryfi can use to categorize the documentdeleteAfterProcessing - Delete this document from Veryfi after data has been extractedparameters - Additional request parameters- Returns:
+- the data extracted from the Document
CompletableFuture<String>
@@ -960,7 +1242,7 @@ processDocumentUrlAsync
externalId - Optional custom document identifier. Use this if you would like to assign your own ID to documentsparameters - Additional request parameters- Returns:
-- the data extracted from the Document
CompletableFuture<String>
+- the data extracted from the Document
CompletableFuture<String>
@@ -986,7 +1268,7 @@ deleteDocumentAsync
- Parameters:
documentId - ID of the document you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1018,7 +1300,7 @@ updateDocumentAsync
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>
+- A document json with updated fields, if fields are writable. Otherwise a document with unchanged fields.
CompletableFuture<String>
@@ -1044,7 +1326,7 @@ getLineItemsAsync
- Parameters:
documentId - ID of the document you'd like to retrieve.- Returns:
-- List of line items extracted from the document.
CompletableFuture<String>
+- List of line items extracted from the document.
CompletableFuture<String>
@@ -1074,7 +1356,7 @@ getLineItemAsync
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>
+- Line item extracted from the document.
CompletableFuture<String>
@@ -1108,7 +1390,7 @@ addLineItemAsync
documentId - ID of the document you'd like to update.payload - line item object to add.- Returns:
-- Added line item data.
CompletableFuture<String>
+- Added line item data.
CompletableFuture<String>
- Throws:
NotValidModelException - when the model is not valid it throws this exception.updateLineItemAsync
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>
+- 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.deleteLineItemsAsync
- Parameters:
documentId - ID of the document you'd like to delete.- Returns:
+- return the response data.
CompletableFuture<String>
@@ -1205,7 +1488,7 @@ deleteLineItemAsync
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>
+- the response data.
CompletableFuture<String>
@@ -1235,7 +1518,7 @@ replaceTagsAsync
documentId - ID of the document you'd like to update.tags - tags array of tags to be added.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1265,7 +1548,7 @@ addTagsAsync
documentId - ID of the document you'd like to update.tags - tags array of tags to be added.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1298,7 +1581,7 @@ getAnyDocumentsAsync
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/
+Returns a json string CompletableFuture<String> list of AnyDocuments. https://docs.veryfi.com/api/anydocs/get-A-docs/
- Parameters:
page - The page number. The response is capped to maximum of 50 results per page.getAnyDocument
getAnyDocumentAsync
-Returns a json string CompletableFuture<String> AnyDocument information. https://docs.veryfi.com/api/anydocs/get-a-A-doc/
+Returns a json string CompletableFuture<String> AnyDocument information. https://docs.veryfi.com/api/anydocs/get-a-A-doc/
- Parameters:
documentId - ID of the AnyDocument you'd like to retrieve.processAnyDocumentAsync
blueprintName - The name of the extraction blueprints.parameters - Additional request parameters.- Returns:
-- the data extracted from the AnyDocument
CompletableFuture<String>
+- the data extracted from the AnyDocument
CompletableFuture<String>
+
+
+
+
-
+
+processAnyDocument
+String processAnyDocument(String fileName,
+ String fileData,
+ 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/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file datablueprintName - The name of the extraction blueprints.parameters - Additional request parameters.- Returns:
+- the data extracted from the AnyDocument
String
+
+
+
+-
+
+processAnyDocumentAsync
+CompletableFuture<String> processAnyDocumentAsync(String fileName,
+ String fileData,
+ 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/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file datablueprintName - The name of the extraction blueprints.parameters - Additional request parameters.- Returns:
+- the data extracted from the AnyDocument
CompletableFuture<String>
@@ -1405,7 +1726,7 @@ processAnyDocumentUrlAsync
blueprintName - The name of the extraction blueprints.parameters - Additional request parameters- Returns:
-- the data extracted from the AnyDocument
CompletableFuture<String>
+- the data extracted from the AnyDocument
CompletableFuture<String>
@@ -1431,7 +1752,7 @@ deleteAnyDocumentAsync
- Parameters:
documentId - ID of the AnyDocument you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1464,7 +1785,7 @@ getBankStatementsAsync
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/
+Returns a json string CompletableFuture<String> list of BankStatements. https://docs.veryfi.com/api/bank-statements/get-bank-statements/
- Parameters:
page - The page number. The response is capped to maximum of 50 results per page.getBankStatement
getBankStatementAsync
-Returns a json string CompletableFuture<String> BankStatement information. https://docs.veryfi.com/api/bank-statements/get-a-bank-statement/
+Returns a json string CompletableFuture<String> BankStatement information. https://docs.veryfi.com/api/bank-statements/get-a-bank-statement/
- Parameters:
documentId - ID of the BankStatement you'd like to retrieve.getBankStatementAsync
processBankStatement
-Process a BankStatement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
+Process a Bank Statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
@@ -1523,13 +1844,47 @@ processBankStatement
processBankStatementAsync
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/
+Process a Bank Statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
- 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>
+- the data extracted from the Bank Statement
CompletableFuture<String>
+
+
+
+
-
+
+processBankStatement
+
+Process a Bank Statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters- Returns:
+- the data extracted from the Bank Statement
String
+
+
+
+-
+
+processBankStatementAsync
+CompletableFuture<String> processBankStatementAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Process a Bank Statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters- Returns:
+- the data extracted from the Bank Statement
CompletableFuture<String>
@@ -1539,14 +1894,14 @@ processBankStatementUrl
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/
+Process Bank Statement from url and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
- 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
+- the data extracted from the Bank Statement
String
@@ -1556,14 +1911,14 @@ processBankStatementUrlAsync
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/
+Process Bank Statement from url and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
- 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>
+- the data extracted from the Bank Statement
CompletableFuture<String>
@@ -1571,10 +1926,10 @@ processBankStatementUrlAsync
deleteBankStatement
-Delete BankStatement from Veryfi. https://docs.veryfi.com/api/bank-statements/delete-a-bank-statement/
+Delete Bank Statement from Veryfi. https://docs.veryfi.com/api/bank-statements/delete-a-bank-statement/
- Parameters:
-documentId - ID of the BankStatement you'd like to delete.documentId - ID of the Bank Statement you'd like to delete.- Returns:
- the response data.
String
@@ -1584,12 +1939,12 @@ deleteBankStatement
deleteBankStatementAsync
-Delete BankStatement from Veryfi. https://docs.veryfi.com/api/bank-statements/delete-a-bank-statement/
+Delete Bank Statement from Veryfi. https://docs.veryfi.com/api/bank-statements/delete-a-bank-statement/
- Parameters:
-documentId - ID of the BankStatement you'd like to delete.documentId - ID of the Bank Statement you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1622,7 +1977,7 @@ getBusinessCardsAsync
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/
+Returns a json string CompletableFuture<String> list of Business Cards. https://docs.veryfi.com/api/business-cards/get-business-cards/
- Parameters:
page - The page number. The response is capped to maximum of 50 results per page.getBusinessCard
getBusinessCardAsync
-Returns a json string CompletableFuture<String> Business Card information. https://docs.veryfi.com/api/business-cards/get-a-business-card/
+Returns a json string CompletableFuture<String> Business Card information. https://docs.veryfi.com/api/business-cards/get-a-business-card/
- Parameters:
documentId - ID of the BusinessCard you'd like to retrieve.processBusinessCardAsync
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>
+- the data extracted from the Business Card
CompletableFuture<String>
+
+
+
+
-
+
+processBusinessCard
+
+Process a Business Card and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the Business Card
String
+
+
+
+-
+
+processBusinessCardAsync
+CompletableFuture<String> processBusinessCardAsync(String fileName,
+ String fileData,
+ 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/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the Business Card
CompletableFuture<String>
@@ -1721,7 +2110,7 @@ processBusinessCardUrlAsync
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>
+- the data extracted from the Business Card
CompletableFuture<String>
@@ -1747,7 +2136,7 @@ deleteBusinessCardAsync
- Parameters:
documentId - ID of the Business Card you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1780,7 +2169,7 @@ getChecksAsync
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/
+Returns a json string CompletableFuture<String> list of Checks. https://docs.veryfi.com/api/checks/get-checks/
- Parameters:
page - The page number. The response is capped to maximum of 50 results per page.getCheck
getCheckAsync
-Returns a json string CompletableFuture<String> Check information.
+Returns a json string CompletableFuture<String> Check information.
- Parameters:
documentId - ID of the Check you'd like to retrieve. https://docs.veryfi.com/api/checks/get-a-check/processCheckAsync
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>
+- the data extracted from the Check
CompletableFuture<String>
-
-
-processCheckUrl
-String processCheckUrl(String fileUrl,
- List<String> fileUrls,
+
+processCheck
+
-Process Check from url and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/
+Process a Check and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/
- 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"]fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters- Returns:
+- the data extracted from the Check
String
+
+
+
+-
+
+processCheckAsync
+CompletableFuture<String> processCheckAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Process a Check and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters- Returns:
+- the data extracted from the Check
CompletableFuture<String>
+
+
+
+-
+
+processCheckUrl
+
+Process Check from url and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/
+
+- 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
@@ -1879,7 +2302,7 @@ processCheckUrlAsync
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>
+- the data extracted from the Check
CompletableFuture<String>
@@ -1905,7 +2328,7 @@ deleteCheckAsync
- Parameters:
documentId - ID of the Check you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1938,7 +2361,7 @@ getW2sAsync
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/
+Returns a json string CompletableFuture<String> list of W2s. https://docs.veryfi.com/api/w2s/get-w-2-s/
- Parameters:
page - The page number. The response is capped to maximum of 50 results per page.getW2
getW2Async
-Returns a json string CompletableFuture<String> W2 information. https://docs.veryfi.com/api/w2s/get-a-w-2/
+Returns a json string CompletableFuture<String> W2 information. https://docs.veryfi.com/api/w2s/get-a-w-2/
- Parameters:
documentId - ID of the W2 you'd like to retrieve.processW2Async
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>
+- the data extracted from the W2
CompletableFuture<String>
+
+
+
+-
+
+processW2
+
+Process a W2 and extract all the fields from it. https://docs.veryfi.com/api/w2s/process-a-w-2/
+
+- Parameters:
+fileName - Name of the file to submit for data extraction.fileData - Base64 encoded file data.parameters - Additional request parameters.- Returns:
+- the data extracted from the W2
String
+
+
+
+-
+
+processW2Async
+CompletableFuture<String> processW2Async(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Process a W2 and extract all the fields from it. https://docs.veryfi.com/api/w2s/process-a-w-2/
+
+- Parameters:
+fileName - Name of the file to submit for data extraction.fileData - Base64 encoded file data.parameters - Additional request parameters.- Returns:
+- the data extracted from the W2
CompletableFuture<String>
@@ -2037,7 +2494,7 @@ processW2UrlAsync
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>
+- the data extracted from the W2
CompletableFuture<String>
@@ -2063,7 +2520,7 @@ deleteW2Async
- Parameters:
documentId - ID of the W2 you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -2096,7 +2553,7 @@ getW8BenEsAsync
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/
+Returns a json string CompletableFuture<String> list of W-8BEN-E. https://docs.veryfi.com/api/w-8ben-e/get-w-8-ben-es/
- Parameters:
page - The page number. The response is capped to maximum of 50 results per page.getW8BenE
getW8BenEAsync
-Returns a json string CompletableFuture<String> W-8BEN-E information.
+Returns a json string CompletableFuture<String> W-8BEN-E information.
- Parameters:
documentId - ID of the W-8BEN-E you'd like to retrieve. https://docs.veryfi.com/api/w-8ben-e/get-a-w-8-ben-e/processW8BenEAsync
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>
+- the data extracted from the W-8BEN-E
CompletableFuture<String>
@@ -2195,7 +2652,7 @@ processW8BenEUrlAsync
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>
+- the data extracted from the W-8BEN-E
CompletableFuture<String>
@@ -2221,7 +2678,7 @@ deleteW8BenEAsync
- Parameters:
documentId - ID of the W-8BEN-E you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -2254,7 +2711,7 @@ getW9sAsync
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/
+Returns a json string CompletableFuture<String> list of W9s. https://docs.veryfi.com/api/w9s/get-w-9-s/
- Parameters:
page - The page number. The response is capped to maximum of 50 results per page.getW9
getW9Async
-Returns a json string CompletableFuture<String> W9 information. https://docs.veryfi.com/api/w9s/get-a-w-9/
+Returns a json string CompletableFuture<String> W9 information. https://docs.veryfi.com/api/w9s/get-a-w-9/
- Parameters:
documentId - ID of the W9 you'd like to retrieve.processW9Async
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>
+- the data extracted from the W9
CompletableFuture<String>
+
+
+
+
-
+
+processW9
+
+Process a W9 and extract all the fields from it. https://docs.veryfi.com/api/w9s/process-a-w-9/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the W9
String
+
+
+
+-
+
+processW9Async
+CompletableFuture<String> processW9Async(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Process a W9 and extract all the fields from it. https://docs.veryfi.com/api/w9s/process-a-w-9/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the W9
CompletableFuture<String>
@@ -2353,7 +2844,7 @@ processW9UrlAsync
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>
+- the data extracted from the W9
CompletableFuture<String>
@@ -2379,7 +2870,7 @@ deleteW9Async
- Parameters:
documentId - ID of the W9 you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -2406,7 +2897,7 @@ getContractsAsync
-Returns a json string CompletableFuture<String> list of Contracts.
+Returns a json string CompletableFuture<String> list of Contracts.
- Parameters:
page - The page number. The response is capped to maximum of 50 results per page.getContract
getContractAsync
-Returns a json string CompletableFuture<String> with the Contract information.
+Returns a json string CompletableFuture<String> with the Contract information.
- Parameters:
documentId - ID of the Contract you'd like to retrieve.processContractAsync
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>
+- the data extracted from the Contract
CompletableFuture<String>
+
+
+
+
-
+
+processContract
+
+Process a Contract and extract all the fields from it.
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters- Returns:
+- the data extracted from the Contract
String
+
+
+
+-
+
+processContractAsync
+CompletableFuture<String> processContractAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Process a Contract and extract all the fields from it.
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters- Returns:
+- the data extracted from the Contract
CompletableFuture<String>
+
+
+
+-
+
+processW8BenE
+
+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/
+
+- Parameters:
+fileName - Name of the file to submit for data extraction.fileData - Base64 encoded file data.parameters - Additional request parameters.- Returns:
+- the data extracted from the W-8BEN-E
String
+
+
+
+-
+
+processW8BenEAsync
+CompletableFuture<String> processW8BenEAsync(String fileName,
+ String fileData,
+ 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/
+
+- Parameters:
+fileName - Name of the file to submit for data extraction.fileData - Base64 encoded file data.parameters - Additional request parameters.- Returns:
+- the data extracted from the W-8BEN-E
CompletableFuture<String>
@@ -2499,7 +3058,7 @@ processContractUrlAsync
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>
+- the data extracted from the Contract
CompletableFuture<String>
@@ -2525,7 +3084,271 @@ deleteContractAsync
- Parameters:
documentId - ID of the Contract you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
+
+
+
+-
+
+classifyDocument
+
+Classify a document and extract all the fields from it. https://docs.veryfi.com/api/classify/classify-a-document/
+
+- Parameters:
+filePath - Path on disk to a file to submit for data extraction.parameters - Additional request parameters.- Returns:
+- the data extracted from the document
String
+
+
+
+-
+
+classifyDocumentAsync
+
+Classify a document and extract all the fields from it. https://docs.veryfi.com/api/classify/classify-a-document/
+
+- Parameters:
+filePath - Path on disk to a file to submit for data extraction.parameters - Additional request parameters.- Returns:
+- the data extracted from the document
CompletableFuture<String>
+
+
+
+-
+
+classifyDocument
+
+Classify a document and extract all the fields from it. https://docs.veryfi.com/api/classify/classify-a-document/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the document
String
+
+
+
+-
+
+classifyDocumentAsync
+CompletableFuture<String> classifyDocumentAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Classify a document and extract all the fields from it. https://docs.veryfi.com/api/classify/classify-a-document/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the document
CompletableFuture<String>
+
+
+
+-
+
+classifyDocumentUrl
+String classifyDocumentUrl(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters)
+Classify a document and extract all the fields from it. https://docs.veryfi.com/api/classify/classify-a-document/
+
+- 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 document
String
+
+
+
+-
+
+classifyDocumentUrlAsync
+CompletableFuture<String> classifyDocumentUrlAsync(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters)
+Classify a document and extract all the fields from it. https://docs.veryfi.com/api/classify/classify-a-document/
+
+- 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 document
CompletableFuture<String>
+
+
+
+-
+
+splitDocument
+
+Split document PDF from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+- Parameters:
+filePath - Path on disk to a file to submit for data extraction.parameters - Additional request parameters.- Returns:
+- the data extracted from the document
String
+
+
+
+-
+
+splitDocumentAsync
+
+Split document PDF from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+- Parameters:
+filePath - Path on disk to a file to submit for data extraction.parameters - Additional request parameters.- Returns:
+- the data extracted from the document
CompletableFuture<String>
+
+
+
+-
+
+splitDocument
+
+Split document PDF from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the document
String
+
+
+
+-
+
+splitDocumentAsync
+CompletableFuture<String> splitDocumentAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Split document PDF from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the document
CompletableFuture<String>
+
+
+
+-
+
+splitDocumentUrl
+
+Split document PDF from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+- 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 document
String
+
+
+
+-
+
+splitDocumentUrlAsync
+CompletableFuture<String> splitDocumentUrlAsync(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters)
+Split document PDF from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+- 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 document
CompletableFuture<String>
+
+
+
+-
+
+getSplitDocuments
+String getSplitDocuments(int page,
+ int pageSize,
+ boolean boundingBoxes,
+ boolean confidenceDetails,
+ org.json.JSONObject parameters)
+Veryfi's Get a Submitted PDF endpoint allows you to retrieve a collection of previously processed documents. https://docs.veryfi.com/api/receipts-invoices/get-submitted-pdf/
+
+- 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:
+- JSON object of previously processed documents
String
+
+
+
+-
+
+getSplitDocumentsAsync
+CompletableFuture<String> getSplitDocumentsAsync(int page,
+ int pageSize,
+ boolean boundingBoxes,
+ boolean confidenceDetails,
+ org.json.JSONObject parameters)
+Veryfi's Get a Submitted PDF endpoint allows you to retrieve a collection of previously processed documents. https://docs.veryfi.com/api/receipts-invoices/get-submitted-pdf/
+
+- 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:
+- JSON object of previously processed documents
String
+
+
+
+-
+
+getSplitDocument
+
+Veryfi's Get a Documents from PDF endpoint allows you to retrieve a collection of previously processed documents. https://docs.veryfi.com/api/receipts-invoices/get-documents-from-pdf/
+
+- Parameters:
+documentId - ID of the document you'd like to retrieve.- Returns:
+- the data extracted from the document
String
+
+
+
+-
+
+getSplitDocumentAsync
+
+Veryfi's Get a Documents from PDF endpoint allows you to retrieve a collection of previously processed documents. https://docs.veryfi.com/api/receipts-invoices/get-documents-from-pdf/
+
+- Parameters:
+documentId - ID of the document you'd like to retrieve.- Returns:
+- the data extracted from the document
CompletableFuture<String>
@@ -2538,7 +3361,7 @@ deleteContractAsync
+ This class contains all the constant values used for HTTP headers, request parameters, + and default configurations when communicating with the Veryfi API. It includes + standard HTTP headers, Veryfi-specific headers, parameter names, and a default + list of document categories. +
SplitServicesprotected org.json.JSONObjectaddFileToParameters(String filePath,
+addFileToParameters(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Creates the JSON Object for the parameters of the request
protected org.json.JSONObject
-addUrlToParameters(String fileUrl,
- List<String> fileUrls,
+addFileToParameters(String filePath,
org.json.JSONObject parameters)
-Creates the JSON object of the parameters of the request
+Creates the JSON Object for the parameters of the request
-protected String
-request(HttpMethod httpVerb,
- String endpointName,
- org.json.JSONObject requestArguments)
+protected org.json.JSONObject
+addUrlToParameters(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters)
-Submit the HTTP request.
+Creates the JSON object of the parameters of the request
-protected CompletableFuture<String>
-requestAsync(HttpMethod httpVerb,
+protected String
+request(HttpMethod httpVerb,
String endpointName,
org.json.JSONObject requestArguments)
Submit the HTTP request.
-void
-setBaseUrl(String baseUrl)
+protected CompletableFuture<String>
+requestAsync(HttpMethod httpVerb,
+ String endpointName,
+ org.json.JSONObject requestArguments)
-By default, the base URL is https://api.veryfi.com/api/;
+Submit the HTTP request.
void
-setHttpClient(HttpClient httpClient)
+setBaseUrl(String baseUrl)
-By default is https://api.veryfi.com/api/;
+By default, the base URL is https://api.veryfi.com/api/;
void
-setTimeOut(int timeOut)
+setHttpClient(HttpClient httpClient)
+By default is https://api.veryfi.com/api/;
+
+void
+setTimeOut(int timeOut)
+
Define new time out for the requests in seconds
@@ -307,6 +318,23 @@ setHttpClient
-
+
+addFileToParameters
+protected org.json.JSONObject addFileToParameters(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Creates the JSON Object for the parameters of the request
+
+- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters- Returns:
+- the JSON object of the parameters of the request
+
+
+
+-
addFileToParameters
protected org.json.JSONObject addFileToParameters(String filePath,
@@ -347,7 +375,7 @@ addUrlToParameters
diff --git a/docs/veryfi/VeryfiClientFactory.html b/docs/veryfi/VeryfiClientFactory.html
index eca4b06..1012ceb 100644
--- a/docs/veryfi/VeryfiClientFactory.html
+++ b/docs/veryfi/VeryfiClientFactory.html
@@ -1,18 +1,18 @@
-
-VeryfiClientFactory (veryfi-java 2.0.0 API)
+
+VeryfiClientFactory (veryfi-java 2.1.0 API)
-
+
-
+
@@ -210,7 +210,7 @@ createClient
protected SplitServices(Credentials credentials,
+ int apiVersion) SplitServices.protected SplitServices(Credentials credentials,
+ int apiVersion,
+ HttpClient httpClient) SplitServices.class + This enum defines all the available API endpoints for different document types + and operations in the Veryfi API. Each endpoint represents a specific resource + or operation that can be performed. +
final String
+ This class extends SharedLineItem and provides the necessary fields
+ for creating new line items in Veryfi documents. The required fields are
+ order, description, and total, while all other fields are optional.
+
AddLineItem(Integer order,
String description,
Float total) final org.json.JSONObjectorder - The order/position of the line itemdescription - The description or name of the line itemtotal - The total amount for this line itemNotValidModelExceptionNotValidModelException - throws when the model is not valid.
+ This class contains all the common fields that are shared between
+ AddLineItem and UpdateLineItem. These fields represent
+ optional properties that can be set on line items in Veryfi documents.
+
+ This class extends SharedLineItem and provides the necessary fields
+ for updating existing line items in Veryfi documents. Unlike AddLineItem,
+ all fields in this class are optional since updates may only modify specific fields.
+
final org.json.JSONObjecttoJsonObject()final org.json.JSONObjecttoJsonObject()Copyright © 2024. All rights reserved.
+Copyright © 2025. All rights reserved.
class class classifyDocument(String fileName,
+ String fileData,
+ org.json.JSONObject parameters) classifyDocument(String filePath,
+ org.json.JSONObject parameters) classifyDocumentAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters) classifyDocumentAsync(String filePath,
+ org.json.JSONObject parameters) classifyDocumentUrl(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters) classifyDocumentUrlAsync(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters) deleteAnyDocument(String documentId) getAnyDocumentAsync(String documentId) CompletableFuture<String> AnyDocument information.CompletableFuture<String> AnyDocument information.getAnyDocuments(int page,
@@ -289,7 +329,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of AnyDocuments.CompletableFuture<String> list of AnyDocuments.getBankStatement(String documentId) getBankStatementAsync(String documentId) CompletableFuture<String> BankStatement information.CompletableFuture<String> BankStatement information.getBankStatements(int page,
@@ -317,7 +357,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of BankStatements.CompletableFuture<String> list of BankStatements.getBusinessCard(String documentId) getBusinessCardAsync(String documentId) CompletableFuture<String> Business Card information.CompletableFuture<String> Business Card information.getBusinessCards(int page,
@@ -345,7 +385,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of Business Cards.CompletableFuture<String> list of Business Cards.getCheckAsync(String documentId) CompletableFuture<String> Check information.CompletableFuture<String> Check information.getChecks(int page,
@@ -373,7 +413,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of Checks.CompletableFuture<String> list of Checks.getContract(String documentId) getContractAsync(String documentId) CompletableFuture<String> with the Contract information.CompletableFuture<String> with the Contract information.getContracts(int page,
@@ -397,7 +437,7 @@ Method Summary
int pageSize,
org.json.JSONObject parameters) CompletableFuture<String> list of Contracts.CompletableFuture<String> list of Contracts.getDocument(String documentId) getDocumentAsync(String documentId) CompletableFuture<String> document information.CompletableFuture<String> document information.getDocuments(int page,
@@ -425,7 +465,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of documents.CompletableFuture<String> list of documents.getLineItem(String documentId,
@@ -450,6 +490,34 @@ Method Summary
Retrieve all line items for a document.
getSplitDocument(String documentId) getSplitDocumentAsync(String documentId) getSplitDocuments(int page,
+ int pageSize,
+ boolean boundingBoxes,
+ boolean confidenceDetails,
+ org.json.JSONObject parameters) getSplitDocumentsAsync(int page,
+ int pageSize,
+ boolean boundingBoxes,
+ boolean confidenceDetails,
+ org.json.JSONObject parameters) String W2 information.getW2Async(String documentId) CompletableFuture<String> W2 information.CompletableFuture<String> W2 information.getW2s(int page,
@@ -475,7 +543,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of W2s.CompletableFuture<String> list of W2s.getW8BenEAsync(String documentId) CompletableFuture<String> W-8BEN-E information.CompletableFuture<String> W-8BEN-E information.getW8BenEs(int page,
@@ -503,7 +571,7 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of W-8BEN-E.CompletableFuture<String> list of W-8BEN-E.getW9Async(String documentId) CompletableFuture<String> W9 information.CompletableFuture<String> W9 information.getW9s(int page,
@@ -531,10 +599,26 @@ Method Summary
boolean confidenceDetails,
org.json.JSONObject parameters) CompletableFuture<String> list of W9s.CompletableFuture<String> list of W9s.processAnyDocument(String filePath,
+processAnyDocument(String fileName,
+ String fileData,
+ String blueprintName,
+ org.json.JSONObject parameters)
+
+Process a AnyDocument and extract all the fields from it.
+
+
+processAnyDocument(String filePath,
+ String blueprintName,
+ org.json.JSONObject parameters)
+
+Process a AnyDocument and extract all the fields from it.
+
+
+processAnyDocumentAsync(String fileName,
+ String fileData,
String blueprintName,
org.json.JSONObject parameters)
@@ -564,16 +648,30 @@ Method Summary
Process AnyDocument from url and extract all the fields from it.
-processBankStatement(String filePath,
+processBankStatement(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Process a Bank Statement and extract all the fields from it.
+
+
+processBankStatement(String filePath,
+ org.json.JSONObject parameters)
+
+Process a Bank Statement and extract all the fields from it.
+
+
+processBankStatementAsync(String fileName,
+ String fileData,
org.json.JSONObject parameters)
-Process a BankStatement and extract all the fields from it.
+Process a Bank Statement and extract all the fields from it.
processBankStatementAsync(String filePath,
org.json.JSONObject parameters)
-Process a BankStatement and extract all the fields from it.
+Process a Bank Statement and extract all the fields from it.
processBankStatementUrl(String fileUrl,
@@ -590,7 +688,21 @@ Method Summary
Process BankStatement from url and extract all the fields from it.
-processBusinessCard(String filePath,
+processBusinessCard(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Process a Business Card and extract all the fields from it.
+
+
+processBusinessCard(String filePath,
+ org.json.JSONObject parameters)
+
+Process a Business Card and extract all the fields from it.
+
+
+processBusinessCardAsync(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Process a Business Card and extract all the fields from it.
@@ -616,7 +728,21 @@ Method Summary
Process Business Card from url and extract all the fields from it.
-processCheck(String filePath,
+processCheck(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Process a Check and extract all the fields from it.
+
+
+processCheck(String filePath,
+ org.json.JSONObject parameters)
+
+Process a Check and extract all the fields from it.
+
+
+processCheckAsync(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Process a Check and extract all the fields from it.
@@ -642,7 +768,21 @@ Method Summary
Process Check from url and extract all the fields from it.
-processContract(String filePath,
+processContract(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Process a Contract and extract all the fields from it.
+
+
+processContract(String filePath,
+ org.json.JSONObject parameters)
+
+Process a Contract and extract all the fields from it.
+
+
+processContractAsync(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Process a Contract and extract all the fields from it.
@@ -666,7 +806,25 @@ Method Summary
Process Contract from url and extract all the fields from it.
-processDocument(String filePath,
+processDocument(String fileName,
+ String fileData,
+ List<String> categories,
+ boolean deleteAfterProcessing,
+ org.json.JSONObject parameters)
+
+Process a document and extract all the fields from it.
+
+
+processDocument(String filePath,
+ List<String> categories,
+ boolean deleteAfterProcessing,
+ org.json.JSONObject parameters)
+
+Process a document and extract all the fields from it.
+
+
+processDocumentAsync(String fileName,
+ String fileData,
List<String> categories,
boolean deleteAfterProcessing,
org.json.JSONObject parameters)
@@ -706,7 +864,21 @@ Method Summary
Process Document from url and extract all the fields from it.
-processW2(String filePath,
+
+
+Process a W2 and extract all the fields from it.
+
+
+
+
+Process a W2 and extract all the fields from it.
+
+
+processW2Async(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Process a W2 and extract all the fields from it.
@@ -732,7 +904,21 @@ Method Summary
Process W2 from url and extract all the fields from it.
-processW8BenE(String filePath,
+processW8BenE(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Process a W-8BEN-E and extract all the fields from it.
+
+
+processW8BenE(String filePath,
+ org.json.JSONObject parameters)
+
+Process a W-8BEN-E and extract all the fields from it.
+
+
+processW8BenEAsync(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Process a W-8BEN-E and extract all the fields from it.
@@ -758,7 +944,21 @@ Method Summary
Process W-8BEN-E from url and extract all the fields from it.
-processW9(String filePath,
+
+
+Process a W9 and extract all the fields from it.
+
+
+
+
+Process a W9 and extract all the fields from it.
+
+
+processW9Async(String fileName,
+ String fileData,
org.json.JSONObject parameters)
Process a W9 and extract all the fields from it.
@@ -796,6 +996,46 @@ Method Summary
Replace multiple tags on an existing document.
+splitDocument(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Split document PDF from url and extract all the fields from it.
+
+
+splitDocument(String filePath,
+ org.json.JSONObject parameters)
+
+Split document PDF from url and extract all the fields from it.
+
+
+splitDocumentAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+
+Split document PDF from url and extract all the fields from it.
+
+
+splitDocumentAsync(String filePath,
+ org.json.JSONObject parameters)
+
+Split document PDF from url and extract all the fields from it.
+
+
+splitDocumentUrl(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters)
+
+Split document PDF from url and extract all the fields from it.
+
+
+splitDocumentUrlAsync(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters)
+
+Split document PDF from url and extract all the fields from it.
+
+
updateDocument(String documentId,
org.json.JSONObject parameters)
@@ -917,7 +1157,7 @@ getDocumentsAsync
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/
+Returns a json string CompletableFuture<String> list of documents. https://docs.veryfi.com/api/receipts-invoices/search-documents/
- Specified by:
getDocumentsAsync in interface ClientgetDocument
getDocumentAsync
-Returns a json string CompletableFuture<String> document information. https://docs.veryfi.com/api/receipts-invoices/get-a-document/
+Returns a json string CompletableFuture<String> document information. https://docs.veryfi.com/api/receipts-invoices/get-a-document/
- Specified by:
getDocumentAsync in interface ClientprocessDocumentAsync
deleteAfterProcessing - Delete this document from Veryfi after data has been extractedparameters - Additional request parameters- Returns:
-- the data extracted from the Document
CompletableFuture<String>
+- the data extracted from the Document
CompletableFuture<String>
+
+
+
+
-
+
+processDocument
+public String processDocument(String fileName,
+ String fileData,
+ 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:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file datacategories - List of categories Veryfi can use to categorize the documentdeleteAfterProcessing - Delete this document from Veryfi after data has been extractedparameters - Additional request parameters- Returns:
+- the data extracted from the Document
String
+
+
+
+-
+
+processDocumentAsync
+public CompletableFuture<String> processDocumentAsync(String fileName,
+ String fileData,
+ 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:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file datacategories - List of categories Veryfi can use to categorize the documentdeleteAfterProcessing - Delete this document from Veryfi after data has been extractedparameters - Additional request parameters- Returns:
+- the data extracted from the Document
CompletableFuture<String>
@@ -1058,7 +1344,7 @@ processDocumentUrlAsync
externalId - Optional custom document identifier. Use this if you would like to assign your own ID to documentsparameters - Additional request parameters- Returns:
-- the data extracted from the Document
CompletableFuture<String>
+- the data extracted from the Document
CompletableFuture<String>
@@ -1088,7 +1374,7 @@ deleteDocumentAsync
- Parameters:
documentId - ID of the document you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1124,7 +1410,7 @@ updateDocumentAsync
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>
+- A document json with updated fields, if fields are writable. Otherwise, a document with unchanged fields.
CompletableFuture<String>
@@ -1154,7 +1440,7 @@ getLineItemsAsync
- Parameters:
documentId - ID of the document you'd like to retrieve.- Returns:
-- List of line items extracted from the document.
CompletableFuture<String>
+- List of line items extracted from the document.
CompletableFuture<String>
@@ -1188,7 +1474,7 @@ getLineItemAsync
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>
+- Line item extracted from the document.
CompletableFuture<String>
@@ -1226,7 +1512,7 @@ addLineItemAsync
documentId - ID of the document you'd like to update.payload - line item object to add.- Returns:
-- Added line item data.
CompletableFuture<String>
+- Added line item data.
CompletableFuture<String>
- Throws:
NotValidModelException - when the model is not valid it throws this exception.updateLineItemAsync
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>
+- 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.deleteLineItemsAsync
- Parameters:
documentId - ID of the document you'd like to delete.- Returns:
+- return the response data.
CompletableFuture<String>
@@ -1335,7 +1622,7 @@ deleteLineItemAsync
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>
+- the response data.
CompletableFuture<String>
@@ -1352,7 +1639,7 @@ replaceTags
documentId - ID of the document you'd like to update.tags - tags array of tags to be added.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1369,7 +1656,7 @@ replaceTagsAsync
documentId - ID of the document you'd like to update.tags - tags array of tags to be added.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1386,7 +1673,7 @@ addTags
documentId - ID of the document you'd like to update.tags - tags array of tags to be added.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1403,7 +1690,7 @@ addTagsAsync
documentId - ID of the document you'd like to update.tags - tags array of tags to be added.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1438,7 +1725,7 @@ getAnyDocumentsAsync
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/
+Returns a json string CompletableFuture<String> list of AnyDocuments. https://docs.veryfi.com/api/anydocs/get-A-docs/
- Specified by:
getAnyDocumentsAsync in interface ClientgetAnyDocument
getAnyDocumentAsync
-Returns a json string CompletableFuture<String> AnyDocument information. https://docs.veryfi.com/api/anydocs/get-a-A-doc/
+Returns a json string CompletableFuture<String> AnyDocument information. https://docs.veryfi.com/api/anydocs/get-a-A-doc/
- Specified by:
getAnyDocumentAsync in interface ClientprocessAnyDocumentAsync
blueprintName - The name of the extraction blueprints.parameters - Additional request parameters.- Returns:
-- the data extracted from the AnyDocument
CompletableFuture<String>
+- the data extracted from the AnyDocument
CompletableFuture<String>
+
+
+
+
-
+
+processAnyDocument
+public String processAnyDocument(String fileName,
+ String fileData,
+ 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:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file datablueprintName - The name of the extraction blueprints.parameters - Additional request parameters.- Returns:
+- the data extracted from the AnyDocument
String
+
+
+
+-
+
+processAnyDocumentAsync
+public CompletableFuture<String> processAnyDocumentAsync(String fileName,
+ String fileData,
+ 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:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file datablueprintName - The name of the extraction blueprints.parameters - Additional request parameters.- Returns:
+- the data extracted from the AnyDocument
CompletableFuture<String>
@@ -1559,7 +1888,7 @@ processAnyDocumentUrlAsync
blueprintName - The name of the extraction blueprints.parameters - Additional request parameters- Returns:
-- the data extracted from the AnyDocument
CompletableFuture<String>
+- the data extracted from the AnyDocument
CompletableFuture<String>
@@ -1589,7 +1918,7 @@ deleteAnyDocumentAsync
- Parameters:
documentId - ID of the AnyDocument you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1624,7 +1953,7 @@ getBankStatementsAsync
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/
+Returns a json string CompletableFuture<String> list of BankStatements. https://docs.veryfi.com/api/bank-statements/get-bank-statements/
- Specified by:
getBankStatementsAsync in interface ClientgetBankStatement
getBankStatementAsync
-Returns a json string CompletableFuture<String> BankStatement information. https://docs.veryfi.com/api/bank-statements/get-a-bank-statement/
+Returns a json string CompletableFuture<String> BankStatement information. https://docs.veryfi.com/api/bank-statements/get-a-bank-statement/
- Specified by:
getBankStatementAsync in interface ClientgetBankStatementAsync
processBankStatement
-Process a BankStatement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
+Process a Bank Statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
- Specified by:
processBankStatement in interface ClientprocessBankStatement
filePath - Path on disk to a file to submit for data extraction.parameters - Additional request parameters.- Returns:
-- the data extracted from the BankStatement
String
+- the data extracted from the Bank Statement
String
@@ -1691,7 +2020,7 @@ processBankStatement
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/
+Process a Bank Statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
- Specified by:
processBankStatementAsync in interface ClientprocessBankStatementAsync
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>
+- the data extracted from the Bank Statement
CompletableFuture<String>
+
+
+
+
-
+
+processBankStatement
+public String processBankStatement(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Process a Bank Statement 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:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters- Returns:
+- the data extracted from the Bank Statement
String
+
+
+
+-
+
+processBankStatementAsync
+public CompletableFuture<String> processBankStatementAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Process a Bank Statement 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:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters- Returns:
+- the data extracted from the Bank Statement
CompletableFuture<String>
@@ -1737,7 +2104,7 @@ processBankStatementUrlAsync
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>
+- the data extracted from the BankStatement
CompletableFuture<String>
@@ -1767,7 +2134,7 @@ deleteBankStatementAsync
- Parameters:
documentId - ID of the BankStatement you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1802,7 +2169,7 @@ getBusinessCardsAsync
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/
+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 ClientgetBusinessCard
getBusinessCardAsync
-Returns a json string CompletableFuture<String> Business Card information. https://docs.veryfi.com/api/business-cards/get-a-business-card/
+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 ClientprocessBusinessCardAsync
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>
+- the data extracted from the Business Card
CompletableFuture<String>
+
+
+
+
-
+
+processBusinessCard
+public String processBusinessCard(String fileName,
+ String fileData,
+ 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:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the Business Card
String
+
+
+
+-
+
+processBusinessCardAsync
+public CompletableFuture<String> processBusinessCardAsync(String fileName,
+ String fileData,
+ 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:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the Business Card
CompletableFuture<String>
@@ -1915,7 +2320,7 @@ processBusinessCardUrlAsync
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>
+- the data extracted from the Business Card
CompletableFuture<String>
@@ -1945,7 +2350,7 @@ deleteBusinessCardAsync
- Parameters:
documentId - ID of the Business Card you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -1980,7 +2385,7 @@ getChecksAsync
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/
+Returns a json string CompletableFuture<String> list of Checks. https://docs.veryfi.com/api/checks/get-checks/
- Specified by:
getChecksAsync in interface ClientgetCheck
getCheckAsync
-Returns a json string CompletableFuture<String> Check information. https://docs.veryfi.com/api/checks/get-a-check/
+Returns a json string CompletableFuture<String> Check information. https://docs.veryfi.com/api/checks/get-a-check/
- Specified by:
getCheckAsync in interface ClientprocessCheckAsync
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>
+- the data extracted from the Check
CompletableFuture<String>
-
-
-processCheckUrl
+
+processCheck
+
+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:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters- Returns:
+- the data extracted from the Check
String
+
+
+
+-
+
+processCheckAsync
+public CompletableFuture<String> processCheckAsync(String fileName,
+ String fileData,
+ 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:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - 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)
@@ -2093,7 +2536,7 @@ processCheckUrlAsync
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>
+- the data extracted from the Check
CompletableFuture<String>
@@ -2123,7 +2566,7 @@ deleteCheckAsync
- Parameters:
documentId - ID of the Check you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -2158,7 +2601,7 @@ getW2sAsync
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/
+Returns a json string CompletableFuture<String> list of W2s. https://docs.veryfi.com/api/w2s/get-w-2-s/
- Specified by:
getW2sAsync in interface ClientgetW2
getW2Async
-Returns a json string CompletableFuture<String> W2 information. https://docs.veryfi.com/api/w2s/get-a-w-2/
+Returns a json string CompletableFuture<String> W2 information. https://docs.veryfi.com/api/w2s/get-a-w-2/
- Specified by:
getW2Async in interface ClientprocessW2Async
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>
+- the data extracted from the W2
CompletableFuture<String>
@@ -2271,7 +2714,7 @@ processW2UrlAsync
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>
+- the data extracted from the W2
CompletableFuture<String>
@@ -2301,7 +2744,7 @@ deleteW2Async
- Parameters:
documentId - ID of the W2 you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -2336,7 +2779,7 @@ getW8BenEsAsync
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/
+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 ClientgetW8BenE
getW8BenEAsync
-Returns a json string CompletableFuture<String> W-8BEN-E information. https://docs.veryfi.com/api/w-8ben-e/get-a-w-8-ben-e/
+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 ClientprocessW8BenEAsync
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>
+- the data extracted from the W-8BEN-E
CompletableFuture<String>
+
+
+
+
-
+
+processW8BenE
+
+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:
+fileName - Name of the file to submit for data extraction.fileData - Base64 encoded file data.parameters - Additional request parameters.- Returns:
+- the data extracted from the W-8BEN-E
String
+
+
+
+-
+
+processW8BenEAsync
+public CompletableFuture<String> processW8BenEAsync(String fileName,
+ String fileData,
+ 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:
+fileName - Name of the file to submit for data extraction.fileData - Base64 encoded file data.parameters - Additional request parameters.- Returns:
+- the data extracted from the W-8BEN-E
CompletableFuture<String>
@@ -2449,7 +2930,7 @@ processW8BenEUrlAsync
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>
+- the data extracted from the W-8BEN-E
CompletableFuture<String>
@@ -2479,7 +2960,7 @@ deleteW8BenEAsync
- Parameters:
documentId - ID of the W-8BEN-E you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -2514,7 +2995,7 @@ getW9sAsync
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/
+Returns a json string CompletableFuture<String> list of W9s. https://docs.veryfi.com/api/w9s/get-w-9-s/
- Specified by:
getW9sAsync in interface ClientgetW9
getW9Async
-Returns a json string CompletableFuture<String> W9 information. https://docs.veryfi.com/api/w9s/get-a-w-9/
+Returns a json string CompletableFuture<String> W9 information. https://docs.veryfi.com/api/w9s/get-a-w-9/
- Specified by:
getW9Async in interface ClientprocessW9Async
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>
+- the data extracted from the W9
CompletableFuture<String>
+
+
+
+
-
+
+processW9
+
+Process a W9 and extract all the fields from it. https://docs.veryfi.com/api/w9s/process-a-w-9/
+
+
+
+-
+
+processW9Async
+public CompletableFuture<String> processW9Async(String fileName,
+ String fileData,
+ 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:
+fileName - Name of the file to submit for data extraction.fileData - Base64 encoded file data.parameters - Additional request parameters.- Returns:
+- the data extracted from the W9
CompletableFuture<String>
@@ -2627,7 +3146,7 @@ processW9UrlAsync
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>
+- the data extracted from the W9
CompletableFuture<String>
@@ -2657,7 +3176,7 @@ deleteW9Async
- Parameters:
documentId - ID of the W9 you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
@@ -2686,7 +3205,7 @@ getContractsAsync
public CompletableFuture<String> getContractsAsync(int page,
int pageSize,
org.json.JSONObject parameters)
-Returns a json string CompletableFuture<String> list of Contracts.
+Returns a json string CompletableFuture<String> list of Contracts.
- Specified by:
getContractsAsync in interface ClientgetContract
getContractAsync
-Returns a json string CompletableFuture<String> with the Contract information.
+Returns a json string CompletableFuture<String> with the Contract information.
- Specified by:
getContractAsync in interface ClientprocessContractAsync
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>
+- the data extracted from the Contract
CompletableFuture<String>
+
+
+
+
-
+
+processContract
+
+Process a Contract and extract all the fields from it.
+
+- Specified by:
+processContract in interface Client- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters- Returns:
+- the data extracted from the Contract
String
+
+
+
+-
+
+processContractAsync
+public CompletableFuture<String> processContractAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Process a Contract and extract all the fields from it.
+
+- Specified by:
+processContractAsync in interface Client- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters- Returns:
+- the data extracted from the Contract
CompletableFuture<String>
+
+
+
+-
+
+processW2
+
+Process a W2 and extract all the fields from it. https://docs.veryfi.com/api/w2s/process-a-w-2/
+
+
+
+-
+
+processW2Async
+public CompletableFuture<String> processW2Async(String fileName,
+ String fileData,
+ 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:
+fileName - Name of the file to submit for data extraction.fileData - Base64 encoded file data.parameters - Additional request parameters.- Returns:
+- the data extracted from the W2
CompletableFuture<String>
@@ -2793,7 +3388,7 @@ processContractUrlAsync
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>
+- the data extracted from the Contract
CompletableFuture<String>
@@ -2823,7 +3418,303 @@ deleteContractAsync
- Parameters:
documentId - ID of the Contract you'd like to delete.- Returns:
-- the response data.
CompletableFuture<String>
+- the response data.
CompletableFuture<String>
+
+
+
+-
+
+classifyDocument
+
+Classify a document and extract all the fields from it. https://docs.veryfi.com/api/classify/classify-a-document/
+
+- Specified by:
+classifyDocument 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 document
String
+
+
+
+-
+
+classifyDocumentAsync
+public CompletableFuture<String> classifyDocumentAsync(String filePath,
+ org.json.JSONObject parameters)
+Classify a document and extract all the fields from it. https://docs.veryfi.com/api/classify/classify-a-document/
+
+- Specified by:
+classifyDocumentAsync 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 document
CompletableFuture<String>
+
+
+
+-
+
+classifyDocument
+public String classifyDocument(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Classify a document and extract all the fields from it. https://docs.veryfi.com/api/classify/classify-a-document/
+
+- Specified by:
+classifyDocument in interface Client- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the document
String
+
+
+
+-
+
+classifyDocumentAsync
+public CompletableFuture<String> classifyDocumentAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Classify a document and extract all the fields from it. https://docs.veryfi.com/api/classify/classify-a-document/
+
+- Specified by:
+classifyDocumentAsync in interface Client- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the document
CompletableFuture<String>
+
+
+
+-
+
+classifyDocumentUrl
+public String classifyDocumentUrl(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters)
+Classify a document and extract all the fields from it. https://docs.veryfi.com/api/classify/classify-a-document/
+
+- Specified by:
+classifyDocumentUrl 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 document
String
+
+
+
+-
+
+classifyDocumentUrlAsync
+public CompletableFuture<String> classifyDocumentUrlAsync(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters)
+Classify a document and extract all the fields from it. https://docs.veryfi.com/api/classify/classify-a-document/
+
+- Specified by:
+classifyDocumentUrlAsync 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 document
CompletableFuture<String>
+
+
+
+-
+
+splitDocument
+
+Split document PDF from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+- Specified by:
+splitDocument 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 document
String
+
+
+
+-
+
+splitDocumentAsync
+public CompletableFuture<String> splitDocumentAsync(String filePath,
+ org.json.JSONObject parameters)
+Split document PDF from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+- Specified by:
+splitDocumentAsync 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 document
CompletableFuture<String>
+
+
+
+-
+
+splitDocument
+
+Split document PDF from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+- Specified by:
+splitDocument in interface Client- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the document
String
+
+
+
+-
+
+splitDocumentAsync
+public CompletableFuture<String> splitDocumentAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters)
+Split document PDF from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+- Specified by:
+splitDocumentAsync in interface Client- Parameters:
+fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.- Returns:
+- the data extracted from the document
CompletableFuture<String>
+
+
+
+-
+
+splitDocumentUrl
+public String splitDocumentUrl(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters)
+Split document PDF from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+- Specified by:
+splitDocumentUrl 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 document
String
+
+
+
+-
+
+splitDocumentUrlAsync
+public CompletableFuture<String> splitDocumentUrlAsync(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters)
+Split document PDF from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+- Specified by:
+splitDocumentUrlAsync 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 document
CompletableFuture<String>
+
+
+
+-
+
+getSplitDocuments
+public String getSplitDocuments(int page,
+ int pageSize,
+ boolean boundingBoxes,
+ boolean confidenceDetails,
+ org.json.JSONObject parameters)
+Veryfi's Get a Submitted PDF endpoint allows you to retrieve a collection of previously processed documents. https://docs.veryfi.com/api/receipts-invoices/get-submitted-pdf/
+
+- Specified by:
+getSplitDocuments 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:
+- JSON object of previously processed documents
String
+
+
+
+-
+
+getSplitDocumentsAsync
+public CompletableFuture<String> getSplitDocumentsAsync(int page,
+ int pageSize,
+ boolean boundingBoxes,
+ boolean confidenceDetails,
+ org.json.JSONObject parameters)
+Veryfi's Get a Submitted PDF endpoint allows you to retrieve a collection of previously processed documents. https://docs.veryfi.com/api/receipts-invoices/get-submitted-pdf/
+
+- Specified by:
+getSplitDocumentsAsync 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:
+- JSON object of previously processed documents
String
+
+
+
+-
+
+getSplitDocument
+
+Veryfi's Get a Documents from PDF endpoint allows you to retrieve a collection of previously processed documents. https://docs.veryfi.com/api/receipts-invoices/get-documents-from-pdf/
+
+- Specified by:
+getSplitDocument in interface Client- Parameters:
+documentId - ID of the document you'd like to retrieve.- Returns:
+- the data extracted from the document
String
+
+
+
+-
+
+getSplitDocumentAsync
+
+Veryfi's Get a Documents from PDF endpoint allows you to retrieve a collection of previously processed documents. https://docs.veryfi.com/api/receipts-invoices/get-documents-from-pdf/
+
+- Specified by:
+getSplitDocumentAsync in interface Client- Parameters:
+documentId - ID of the document you'd like to retrieve.- Returns:
+- the data extracted from the document
CompletableFuture<String>
@@ -2836,7 +3727,7 @@ deleteContractAsync
loggerprotected SplitServices(Credentials credentials,
+ int apiVersion) SplitServices.protected SplitServices(Credentials credentials,
+ int apiVersion,
+ HttpClient httpClient) SplitServices.protected StringgetSplitDocument(String documentId) protected CompletableFuture<String>getSplitDocumentAsync(String documentId) protected StringgetSplitDocuments(int page,
+ int pageSize,
+ boolean boundingBoxes,
+ boolean confidenceDetails,
+ org.json.JSONObject parameters) protected CompletableFuture<String>getSplitDocumentsAsync(int page,
+ int pageSize,
+ boolean boundingBoxes,
+ boolean confidenceDetails,
+ org.json.JSONObject parameters) protected StringsplitDocument(String fileName,
+ String fileData,
+ org.json.JSONObject parameters) protected StringsplitDocument(String filePath,
+ org.json.JSONObject parameters) protected CompletableFuture<String>splitDocumentAsync(String fileName,
+ String fileData,
+ org.json.JSONObject parameters) protected CompletableFuture<String>splitDocumentAsync(String filePath,
+ org.json.JSONObject parameters) protected StringsplitDocumentUrl(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters) protected CompletableFuture<String>splitDocumentUrlAsync(String fileUrl,
+ List<String> fileUrls,
+ org.json.JSONObject parameters) addFileToParameters, addFileToParameters, addUrlToParameters, request, requestAsync, setBaseUrl, setHttpClient, setTimeOutSplitServices.credentials - the Credentials provided by Veryfi.apiVersion - the int api version to use Veryfi.SplitServices.credentials - the Credentials provided by Veryfi.apiVersion - the int api version to use Veryfi.httpClient - HttpClient for the Veryfi APIfilePath - Path on disk to a file to submit for data extraction.parameters - Additional request parameters.StringfilePath - Path on disk to a file to submit for data extraction.parameters - Additional request parameters.CompletableFuture<String>fileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.StringfileName - Name of the file to upload to the Veryfi APIfileData - Base64 encoded file dataparameters - Additional request parameters.CompletableFuture<String>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.StringfileUrl - 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.CompletableFuture<String>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.Stringpage - 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.StringdocumentId - ID of the document you'd like to retrieve.StringdocumentId - ID of the document you'd like to retrieve.CompletableFuture<String>+ * This class provides helper methods for converting files to Base64 encoded strings + * that can be used with the Veryfi API. It handles both file paths and File objects, + * and automatically generates the appropriate data URI prefix based on file extension. + *
+ */ public class Base64Helper { + /** + * Converts a file to Base64 encoded string using the file path. + *+ * This method reads the file from the specified path, encodes it to Base64, + * and prepends the appropriate data URI prefix based on the file extension. + *
+ * + * @param filePath The path to the file to encode + * @return Base64 encoded string with data URI prefix + * @throws IOException if the file cannot be read + */ public static String getBase64FileContent(String filePath) throws IOException { String fileName = filePath.replaceAll("^.*[/\\\\]", ""); File file = new File(filePath); return getBase64FileContent(file); } + /** + * Converts a file to Base64 encoded string using a File object. + *+ * This method reads the file content, encodes it to Base64, and prepends + * the appropriate data URI prefix based on the file extension. + *
+ * + * @param file The file to encode + * @return Base64 encoded string with data URI prefix + * @throws IOException if the file cannot be read + */ public static String getBase64FileContent(File file) throws IOException { String fileData = ""; byte[] fileContent = Files.readAllBytes(file.toPath()); @@ -20,6 +50,17 @@ public static String getBase64FileContent(File file) throws IOException { return getUriPrefix(file) + fileData; } + /** + * Generates the data URI prefix for a file based on its extension. + *+ * This method determines the MIME type based on the file extension and + * returns the appropriate data URI prefix. If no extension is found, + * it defaults to "image/png". + *
+ * + * @param file The file to generate the prefix for + * @return Data URI prefix string (e.g., "data:image/jpeg;base64,") + */ public static String getUriPrefix(File file) { String extension = getFileExtension(file); if (extension.isEmpty()) @@ -27,6 +68,17 @@ public static String getUriPrefix(File file) { return "data:image/" + extension + ";base64,"; } + /** + * Extracts the file extension from a File object. + *+ * This method parses the filename to extract the extension (everything after + * the last dot). If no extension is found or the file has no name, an empty + * string is returned. + *
+ * + * @param file The file to extract the extension from + * @return The file extension (without the dot) or empty string if no extension + */ protected static String getFileExtension(File file) { String fileName = file.getName(); int dotIndex = fileName.lastIndexOf('.'); diff --git a/src/main/java/veryfi/Client.java b/src/main/java/veryfi/Client.java index dd82e50..dc1a021 100644 --- a/src/main/java/veryfi/Client.java +++ b/src/main/java/veryfi/Client.java @@ -30,7 +30,7 @@ public interface Client { String getDocuments(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, JSONObject parameters); /** - * Returns a json string {@link CompletableFuture