Package veryfi
Interface Client
- All Known Implementing Classes:
ClientImpl
public interface Client
Veryfi API client for Java.
The instances of classes that implement this interface are thread-safe and immutable.
-
Method Summary
Modifier and TypeMethodDescriptionaddLineItem
(String documentId, AddLineItem payload) Add a new line item on an existing document.addLineItemAsync
(String documentId, AddLineItem payload) Add a new line item on an existing document.Add multiple tags on an existing document.addTagsAsync
(String documentId, List<String> tags) Add multiple tags on an existing document.deleteAnyDocument
(String documentId) Delete AnyDocument from Veryfi.deleteAnyDocumentAsync
(String documentId) Delete AnyDocument from Veryfi.deleteBankStatement
(String documentId) Delete BankStatement from Veryfi.deleteBankStatementAsync
(String documentId) Delete BankStatement from Veryfi.deleteBusinessCard
(String documentId) Delete BusinessCard from Veryfi.deleteBusinessCardAsync
(String documentId) Delete BusinessCard from Veryfi.deleteCheck
(String documentId) Delete Check from Veryfi.deleteCheckAsync
(String documentId) Delete Check from Veryfi.deleteContract
(String documentId) Delete a Contract from Veryfi.deleteContractAsync
(String documentId) Delete a Contract from Veryfi.deleteDocument
(String documentId) Delete Document from Veryfi.deleteDocumentAsync
(String documentId) Delete Document from Veryfi.deleteLineItem
(String documentId, String lineItemId) Delete an existing line item on an existing document.deleteLineItemAsync
(String documentId, String lineItemId) Delete an existing line item on an existing document.deleteLineItems
(String documentId) Delete all line items on an existing document.deleteLineItemsAsync
(String documentId) Delete all line items on an existing document.Delete W2 from Veryfi.deleteW2Async
(String documentId) Delete W2 from Veryfi.deleteW8BenE
(String documentId) Delete W-8BEN-E from Veryfi.deleteW8BenEAsync
(String documentId) Delete W-8BEN-E from Veryfi.Delete W9 from Veryfi.deleteW9Async
(String documentId) Delete W9 from Veryfi.getAnyDocument
(String documentId) Returns a json stringString
AnyDocument information.getAnyDocumentAsync
(String documentId) Returns a json stringCompletableFuture<String>
AnyDocument information.getAnyDocuments
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the list of Any Documents.getAnyDocumentsAsync
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<String>
list of AnyDocuments.getBankStatement
(String documentId) Returns a json stringString
BankStatement information.getBankStatementAsync
(String documentId) Returns a json stringCompletableFuture<String>
BankStatement information.getBankStatements
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the list of Bank Statements.getBankStatementsAsync
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<String>
list of BankStatements.getBusinessCard
(String documentId) Returns a json stringString
Business Card information.getBusinessCardAsync
(String documentId) Returns a json stringCompletableFuture<String>
Business Card information.getBusinessCards
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the list of Business Cards.getBusinessCardsAsync
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<String>
list of Business Cards.Returns a json stringString
Check information.getCheckAsync
(String documentId) Returns a json stringCompletableFuture<String>
Check information.getChecks
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the list of Checks.getChecksAsync
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<String>
list of Checks.getContract
(String documentId) Returns a json stringString
with the Contract information.getContractAsync
(String documentId) Returns a json stringCompletableFuture<String>
with the Contract information.getContracts
(int page, int pageSize, org.json.JSONObject parameters) Returns a json stringString
with the list of Contracts.getContractsAsync
(int page, int pageSize, org.json.JSONObject parameters) Returns a json stringCompletableFuture<String>
list of Contracts.getDocument
(String documentId) Returns a json stringString
document information.getDocumentAsync
(String documentId) Returns a json stringCompletableFuture<String>
document information.getDocuments
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
list of documents.getDocumentsAsync
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<String>
list of documents.getLineItem
(String documentId, String lineItemId) Retrieve a line item for existing document by ID.getLineItemAsync
(String documentId, String lineItemId) Retrieve a line item for existing document by ID.getLineItems
(String documentId) Retrieve all line items for a document.getLineItemsAsync
(String documentId) Retrieve all line items for a document.Returns a json stringString
W2 information.getW2Async
(String documentId) Returns a json stringCompletableFuture<String>
W2 information.getW2s
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the list of W2s.getW2sAsync
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<String>
list of W2s.Returns a json stringString
W-8BEN-E information.getW8BenEAsync
(String documentId) Returns a json stringCompletableFuture<String>
W-8BEN-E information.getW8BenEs
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the list of W-8BEN-E.getW8BenEsAsync
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<String>
list of W-8BEN-E.Returns a json stringString
W9 information.getW9Async
(String documentId) Returns a json stringCompletableFuture<String>
W9 information.getW9s
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the list of W9s.getW9sAsync
(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<String>
list of W9s.processAnyDocument
(String filePath, String blueprintName, org.json.JSONObject parameters) Process a AnyDocument and extract all the fields from it.processAnyDocumentAsync
(String filePath, String blueprintName, org.json.JSONObject parameters) Process a AnyDocument and extract all the fields from it.processAnyDocumentUrl
(String fileUrl, List<String> fileUrls, String blueprintName, org.json.JSONObject parameters) Process AnyDocument from url and extract all the fields from it.processAnyDocumentUrlAsync
(String fileUrl, List<String> fileUrls, String blueprintName, org.json.JSONObject parameters) Process AnyDocument from url and extract all the fields from it.processBankStatement
(String filePath, org.json.JSONObject parameters) Process a BankStatement and extract all the fields from it.processBankStatementAsync
(String filePath, org.json.JSONObject parameters) Process a BankStatement 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.processBankStatementUrlAsync
(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process BankStatement from url 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 filePath, org.json.JSONObject parameters) Process a Business Card and extract all the fields from it.processBusinessCardUrl
(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process Business Card from url and extract all the fields from it.processBusinessCardUrlAsync
(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process Business Card from url 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 filePath, org.json.JSONObject parameters) Process a Check and extract all the fields from it.processCheckUrl
(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process Check from url and extract all the fields from it.processCheckUrlAsync
(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process Check from url 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 filePath, org.json.JSONObject parameters) Process a Contract and extract all the fields from it.processContractUrl
(String fileUrl, org.json.JSONObject parameters) Process Contract from url and extract all the fields from it.processContractUrlAsync
(String fileUrl, org.json.JSONObject parameters) Process Contract from url 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 filePath, List<String> categories, boolean deleteAfterProcessing, org.json.JSONObject parameters) Process a document and extract all the fields from it.processDocumentUrl
(String fileUrl, List<String> fileUrls, List<String> categories, boolean deleteAfterProcessing, int maxPagesToProcess, boolean boostMode, String externalId, org.json.JSONObject parameters) Process Document from url and extract all the fields from it.processDocumentUrlAsync
(String fileUrl, List<String> fileUrls, List<String> categories, boolean deleteAfterProcessing, int maxPagesToProcess, boolean boostMode, String externalId, org.json.JSONObject parameters) Process Document from url and extract all the fields from it.Process a W2 and extract all the fields from it.processW2Async
(String filePath, org.json.JSONObject parameters) Process a W2 and extract all the fields from it.processW2Url
(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process W2 from url and extract all the fields from it.processW2UrlAsync
(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process W2 from url 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 filePath, org.json.JSONObject parameters) Process a W-8BEN-E and extract all the fields from it.processW8BenEUrl
(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process W-8BEN-E from url and extract all the fields from it.processW8BenEUrlAsync
(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process W-8BEN-E from url and extract all the fields from it.Process a W9 and extract all the fields from it.processW9Async
(String filePath, org.json.JSONObject parameters) Process a W9 and extract all the fields from it.processW9Url
(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process W9 from url and extract all the fields from it.processW9UrlAsync
(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process W9 from url and extract all the fields from it.replaceTags
(String documentId, List<String> tags) Replace multiple tags on an existing document.replaceTagsAsync
(String documentId, List<String> tags) Replace multiple tags on an existing document.updateDocument
(String documentId, org.json.JSONObject parameters) Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` and etc.updateDocumentAsync
(String documentId, org.json.JSONObject parameters) Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` and etc.updateLineItem
(String documentId, String lineItemId, UpdateLineItem payload) Update an existing line item on an existing document.updateLineItemAsync
(String documentId, String lineItemId, UpdateLineItem payload) Update an existing line item on an existing document.
-
Method Details
-
getDocuments
String getDocuments(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the list of previously processed documents
String
-
getDocumentsAsync
CompletableFuture<String> getDocumentsAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the list of previously processed documents
String
-
getDocument
Returns a json stringString
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
String
-
getDocumentAsync
Returns a json stringCompletableFuture<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>
-
processDocument
String processDocument(String filePath, List<String> categories, boolean deleteAfterProcessing, org.json.JSONObject parameters) Process a document and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/- Parameters:
filePath
- Path on disk to a file to submit for data extractioncategories
- 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 filePath, List<String> categories, boolean deleteAfterProcessing, org.json.JSONObject parameters) Process a document and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/- Parameters:
filePath
- Path on disk to a file to submit for data extractioncategories
- 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>
-
processDocumentUrl
String processDocumentUrl(String fileUrl, List<String> fileUrls, List<String> categories, boolean deleteAfterProcessing, int maxPagesToProcess, boolean boostMode, String externalId, org.json.JSONObject parameters) Process Document from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]categories
- List of categories to use when categorizing the documentdeleteAfterProcessing
- Delete this document from Veryfi after data has been extractedmaxPagesToProcess
- When sending a long document to Veryfi for processing, this parameter controls how many pages of the document will be read and processed, starting from page 1.boostMode
- Flag that tells Veryfi whether boost mode should be enabled. When set to 1, Veryfi will skip data enrichment steps, but will process the document faster. Default value for this flag is 0externalId
- 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
String
-
processDocumentUrlAsync
CompletableFuture<String> processDocumentUrlAsync(String fileUrl, List<String> fileUrls, List<String> categories, boolean deleteAfterProcessing, int maxPagesToProcess, boolean boostMode, String externalId, org.json.JSONObject parameters) Process Document from url and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]categories
- List of categories to use when categorizing the documentdeleteAfterProcessing
- Delete this document from Veryfi after data has been extractedmaxPagesToProcess
- When sending a long document to Veryfi for processing, this parameter controls how many pages of the document will be read and processed, starting from page 1.boostMode
- Flag that tells Veryfi whether boost mode should be enabled. When set to 1, Veryfi will skip data enrichment steps, but will process the document faster. Default value for this flag is 0externalId
- 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>
-
deleteDocument
Delete Document from Veryfi. https://docs.veryfi.com/api/receipts-invoices/delete-a-document/- Parameters:
documentId
- ID of the document you'd like to delete.- Returns:
- the response data.
String
-
deleteDocumentAsync
Delete Document from Veryfi. https://docs.veryfi.com/api/receipts-invoices/delete-a-document/- Parameters:
documentId
- ID of the document you'd like to delete.- Returns:
- the response data.
CompletableFuture<String>
-
updateDocument
Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` and etc. https://docs.veryfi.com/api/receipts-invoices/update-a-document/- Parameters:
documentId
- ID of the document you'd like to update.parameters
- Additional request parameters.- Returns:
- A document json with updated fields, if fields are writable. Otherwise a document with unchanged fields.
String
-
updateDocumentAsync
Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` and etc. https://docs.veryfi.com/api/receipts-invoices/update-a-document/- Parameters:
documentId
- ID of the document you'd like to update.parameters
- Additional request parameters.- Returns:
- A document json with updated fields, if fields are writable. Otherwise a document with unchanged fields.
CompletableFuture<String>
-
getLineItems
Retrieve all line items for a document. https://docs.veryfi.com/api/receipts-invoices/get-document-line-items/- Parameters:
documentId
- ID of the document you'd like to retrieve.- Returns:
- List of line items extracted from the document.
String
-
getLineItemsAsync
Retrieve all line items for a document. https://docs.veryfi.com/api/receipts-invoices/get-document-line-items/- Parameters:
documentId
- ID of the document you'd like to retrieve.- Returns:
- List of line items extracted from the document.
CompletableFuture<String>
-
getLineItem
Retrieve a line item for existing document by ID. https://docs.veryfi.com/api/receipts-invoices/get-a-line-item/- Parameters:
documentId
- ID of the document you'd like to retrieve.lineItemId
- ID of the line item you'd like to retrieve.- Returns:
- Line item extracted from the document.
String
-
getLineItemAsync
Retrieve a line item for existing document by ID. https://docs.veryfi.com/api/receipts-invoices/get-a-line-item/- Parameters:
documentId
- ID of the document you'd like to retrieve.lineItemId
- ID of the line item you'd like to retrieve.- Returns:
- Line item extracted from the document.
CompletableFuture<String>
-
addLineItem
Add a new line item on an existing document. https://docs.veryfi.com/api/receipts-invoices/create-a-line-item/- Parameters:
documentId
- ID of the document you'd like to update.payload
- line item object to add.- Returns:
- Added line item data.
String
- Throws:
NotValidModelException
- when the model is not valid it throws this exception.
-
addLineItemAsync
CompletableFuture<String> addLineItemAsync(String documentId, AddLineItem payload) throws NotValidModelException Add a new line item on an existing document. https://docs.veryfi.com/api/receipts-invoices/create-a-line-item/- Parameters:
documentId
- ID of the document you'd like to update.payload
- line item object to add.- Returns:
- Added line item data.
CompletableFuture<String>
- Throws:
NotValidModelException
- when the model is not valid it throws this exception.
-
updateLineItem
String updateLineItem(String documentId, String lineItemId, UpdateLineItem payload) throws NotValidModelException Update an existing line item on an existing document. https://docs.veryfi.com/api/receipts-invoices/update-a-line-item/- Parameters:
documentId
- ID of the document you'd like to update.lineItemId
- ID of the line item you'd like to update.payload
- line item object to update.- Returns:
- Line item data with updated fields, if fields are writable. Otherwise line item data with unchanged fields.
String
- Throws:
NotValidModelException
- when the model is not valid it throws this exception.
-
updateLineItemAsync
CompletableFuture<String> updateLineItemAsync(String documentId, String lineItemId, UpdateLineItem payload) throws NotValidModelException Update an existing line item on an existing document. https://docs.veryfi.com/api/receipts-invoices/update-a-line-item/- Parameters:
documentId
- ID of the document you'd like to update.lineItemId
- ID of the line item you'd like to update.payload
- line item object to update.- Returns:
- Line item data with updated fields, if fields are writable. Otherwise line item data with unchanged fields.
CompletableFuture<String>
- Throws:
NotValidModelException
- when the model is not valid it throws this exception.
-
deleteLineItems
Delete all line items on an existing document. https://docs.veryfi.com/api/receipts-invoices/delete-all-document-line-items/- Parameters:
documentId
- ID of the document you'd like to delete.- Returns:
- the response data.
String
-
deleteLineItemsAsync
Delete all line items on an existing document. https://docs.veryfi.com/api/receipts-invoices/delete-all-document-line-items/- Parameters:
documentId
- ID of the document you'd like to delete.- Returns:
-
deleteLineItem
Delete an existing line item on an existing document. https://docs.veryfi.com/api/receipts-invoices/delete-a-line-item/- Parameters:
documentId
- ID of the document you'd like to delete.lineItemId
- ID of the line item you'd like to delete.- Returns:
- the response data.
String
-
deleteLineItemAsync
Delete an existing line item on an existing document. https://docs.veryfi.com/api/receipts-invoices/delete-a-line-item/- Parameters:
documentId
- ID of the document you'd like to delete.lineItemId
- ID of the line item you'd like to delete.- Returns:
- the response data.
CompletableFuture<String>
-
replaceTags
Replace multiple tags on an existing document. https://docs.veryfi.com/api/receipts-invoices/add-tags-to-a-document/- Parameters:
documentId
- ID of the document you'd like to update.tags
- tags array of tags to be added.- Returns:
- the response data.
String
-
replaceTagsAsync
Replace multiple tags on an existing document. https://docs.veryfi.com/api/receipts-invoices/add-tags-to-a-document/- Parameters:
documentId
- ID of the document you'd like to update.tags
- tags array of tags to be added.- Returns:
- the response data.
CompletableFuture<String>
-
addTags
Add multiple tags on an existing document. https://docs.veryfi.com/api/receipts-invoices/add-tags-to-a-document/- Parameters:
documentId
- ID of the document you'd like to update.tags
- tags array of tags to be added.- Returns:
- the response data.
String
-
addTagsAsync
Add multiple tags on an existing document. https://docs.veryfi.com/api/receipts-invoices/add-tags-to-a-document/- Parameters:
documentId
- ID of the document you'd like to update.tags
- tags array of tags to be added.- Returns:
- the response data.
CompletableFuture<String>
-
getAnyDocuments
String getAnyDocuments(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the list of Any Documents. 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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the url
String
-
getAnyDocumentsAsync
CompletableFuture<String> getAnyDocumentsAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the list of previously processed AnyDocuments
String
-
getAnyDocument
Returns a json stringString
AnyDocument information. https://docs.veryfi.com/api/anydocs/get-a-A-doc/- Parameters:
documentId
- ID of the AnyDocument you'd like to retrieve.- Returns:
- the data extracted from the AnyDocument
String
-
getAnyDocumentAsync
Returns a json stringCompletableFuture<String>
AnyDocument information. https://docs.veryfi.com/api/anydocs/get-a-A-doc/- Parameters:
documentId
- ID of the AnyDocument you'd like to retrieve.- Returns:
- the data extracted from the AnyDocument
String
-
processAnyDocument
Process a AnyDocument and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-A-doc/- Parameters:
filePath
- Path on disk to a file to submit for data extraction.blueprintName
- The name of the extraction blueprints.parameters
- Additional request parameters.- Returns:
- the data extracted from the AnyDocument
String
-
processAnyDocumentAsync
CompletableFuture<String> processAnyDocumentAsync(String filePath, String blueprintName, org.json.JSONObject parameters) Process a AnyDocument and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-A-doc/- Parameters:
filePath
- Path on disk to a file to submit for data extraction.blueprintName
- The name of the extraction blueprints.parameters
- Additional request parameters.- Returns:
- the data extracted from the AnyDocument
CompletableFuture<String>
-
processAnyDocumentUrl
String processAnyDocumentUrl(String fileUrl, List<String> fileUrls, String blueprintName, org.json.JSONObject parameters) Process AnyDocument from url and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-A-doc/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]blueprintName
- The name of the extraction blueprints.parameters
- Additional request parameters- Returns:
- the data extracted from the AnyDocument
String
-
processAnyDocumentUrlAsync
CompletableFuture<String> processAnyDocumentUrlAsync(String fileUrl, List<String> fileUrls, String blueprintName, org.json.JSONObject parameters) Process AnyDocument from url and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-A-doc/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]blueprintName
- The name of the extraction blueprints.parameters
- Additional request parameters- Returns:
- the data extracted from the AnyDocument
CompletableFuture<String>
-
deleteAnyDocument
Delete AnyDocument from Veryfi. https://docs.veryfi.com/api/anydocs/delete-a-A-doc/- Parameters:
documentId
- ID of the AnyDocument you'd like to delete.- Returns:
- the response data.
String
-
deleteAnyDocumentAsync
Delete AnyDocument from Veryfi. https://docs.veryfi.com/api/anydocs/delete-a-A-doc/- Parameters:
documentId
- ID of the AnyDocument you'd like to delete.- Returns:
- the response data.
CompletableFuture<String>
-
getBankStatements
String getBankStatements(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the list of Bank Statements. 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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the url
String
-
getBankStatementsAsync
CompletableFuture<String> getBankStatementsAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the list of previously processed BankStatements
String
-
getBankStatement
Returns a json stringString
BankStatement information. https://docs.veryfi.com/api/bank-statements/get-a-bank-statement/- Parameters:
documentId
- ID of the BankStatement you'd like to retrieve.- Returns:
- the data extracted from the BankStatement
String
-
getBankStatementAsync
Returns a json stringCompletableFuture<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.- Returns:
- the data extracted from the BankStatement
String
-
processBankStatement
Process a BankStatement 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
String
-
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/- Parameters:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the BankStatement
CompletableFuture<String>
-
processBankStatementUrl
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/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]parameters
- Additional request parameters- Returns:
- the data extracted from the BankStatement
String
-
processBankStatementUrlAsync
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/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]parameters
- Additional request parameters- Returns:
- the data extracted from the BankStatement
CompletableFuture<String>
-
deleteBankStatement
Delete BankStatement from Veryfi. https://docs.veryfi.com/api/bank-statements/delete-a-bank-statement/- Parameters:
documentId
- ID of the BankStatement you'd like to delete.- Returns:
- the response data.
String
-
deleteBankStatementAsync
Delete BankStatement from Veryfi. https://docs.veryfi.com/api/bank-statements/delete-a-bank-statement/- Parameters:
documentId
- ID of the BankStatement you'd like to delete.- Returns:
- the response data.
CompletableFuture<String>
-
getBusinessCards
String getBusinessCards(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the 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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the url
String
-
getBusinessCardsAsync
CompletableFuture<String> getBusinessCardsAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the list of previously processed Business Cards
String
-
getBusinessCard
Returns a json stringString
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.- Returns:
- the data extracted from the Business Card
String
-
getBusinessCardAsync
Returns a json stringCompletableFuture<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.- Returns:
- the data extracted from the Business Card
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:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the Business Card
String
-
processBusinessCardAsync
Process a Business Card and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/- Parameters:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the Business Card
CompletableFuture<String>
-
processBusinessCardUrl
String processBusinessCardUrl(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process Business Card from url and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]parameters
- Additional request parameters- Returns:
- the data extracted from the Business Card
String
-
processBusinessCardUrlAsync
CompletableFuture<String> processBusinessCardUrlAsync(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process Business Card from url and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]parameters
- Additional request parameters- Returns:
- the data extracted from the Business Card
CompletableFuture<String>
-
deleteBusinessCard
Delete BusinessCard from Veryfi. https://docs.veryfi.com/api/business-cards/delete-a-business-card/- Parameters:
documentId
- ID of the Business Card you'd like to delete.- Returns:
- the response data.
String
-
deleteBusinessCardAsync
Delete BusinessCard from Veryfi. https://docs.veryfi.com/api/business-cards/delete-a-business-card/- Parameters:
documentId
- ID of the Business Card you'd like to delete.- Returns:
- the response data.
CompletableFuture<String>
-
getChecks
String getChecks(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the 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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the url
String
-
getChecksAsync
CompletableFuture<String> getChecksAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the list of previously processed checks
String
-
getCheck
Returns a json stringString
Check information. https://docs.veryfi.com/api/checks/get-a-check/- Parameters:
documentId
- ID of the Check you'd like to retrieve.- Returns:
- the data extracted from the Check
String
-
getCheckAsync
Returns a json stringCompletableFuture<String>
Check information.- Parameters:
documentId
- ID of the Check you'd like to retrieve. https://docs.veryfi.com/api/checks/get-a-check/- Returns:
- the data extracted from the Check
String
-
processCheck
Process a Check and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/- Parameters:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the Check
String
-
processCheckAsync
Process a Check and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/- Parameters:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the Check
CompletableFuture<String>
-
processCheckUrl
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
-
processCheckUrlAsync
CompletableFuture<String> processCheckUrlAsync(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process Check from url and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]parameters
- Additional request parameters- Returns:
- the data extracted from the Check
CompletableFuture<String>
-
deleteCheck
Delete Check from Veryfi. https://docs.veryfi.com/api/checks/delete-a-check/- Parameters:
documentId
- ID of the Check you'd like to delete.- Returns:
- the response data.
String
-
deleteCheckAsync
Delete Check from Veryfi. https://docs.veryfi.com/api/checks/delete-a-check/- Parameters:
documentId
- ID of the Check you'd like to delete.- Returns:
- the response data.
CompletableFuture<String>
-
getW2s
String getW2s(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the 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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the url
String
-
getW2sAsync
CompletableFuture<String> getW2sAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the list of previously processed W2s
String
-
getW2
Returns a json stringString
W2 information. https://docs.veryfi.com/api/w2s/get-a-w-2/- Parameters:
documentId
- ID of the W2 you'd like to retrieve.- Returns:
- the data extracted from the W2
String
-
getW2Async
Returns a json stringCompletableFuture<String>
W2 information. https://docs.veryfi.com/api/w2s/get-a-w-2/- Parameters:
documentId
- ID of the W2 you'd like to retrieve.- Returns:
- the data extracted from the W2
String
-
processW2
Process a W2 and extract all the fields from it. https://docs.veryfi.com/api/w2s/process-a-w-2/- Parameters:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the W2
String
-
processW2Async
Process a W2 and extract all the fields from it. https://docs.veryfi.com/api/w2s/process-a-w-2/- Parameters:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the W2
CompletableFuture<String>
-
processW2Url
Process W2 from url and extract all the fields from it. https://docs.veryfi.com/api/w2s/process-a-w-2/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]parameters
- Additional request parameters- Returns:
- the data extracted from the W2
String
-
processW2UrlAsync
CompletableFuture<String> processW2UrlAsync(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process W2 from url and extract all the fields from it. https://docs.veryfi.com/api/w2s/process-a-w-2/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]parameters
- Additional request parameters- Returns:
- the data extracted from the W2
CompletableFuture<String>
-
deleteW2
Delete W2 from Veryfi. https://docs.veryfi.com/api/w2s/delete-a-w-2/- Parameters:
documentId
- ID of the W2 you'd like to delete.- Returns:
- the response data.
String
-
deleteW2Async
Delete W2 from Veryfi. https://docs.veryfi.com/api/w2s/delete-a-w-2/- Parameters:
documentId
- ID of the W2 you'd like to delete.- Returns:
- the response data.
CompletableFuture<String>
-
getW8BenEs
String getW8BenEs(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the 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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the url
String
-
getW8BenEsAsync
CompletableFuture<String> getW8BenEsAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the list of previously processed W-8BEN-E
String
-
getW8BenE
Returns a json stringString
W-8BEN-E information. https://docs.veryfi.com/api/w-8ben-e/get-a-w-8-ben-e/- Parameters:
documentId
- ID of the W-8BEN-E you'd like to retrieve.- Returns:
- the data extracted from the W-8BEN-E
String
-
getW8BenEAsync
Returns a json stringCompletableFuture<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/- Returns:
- the data extracted from the W-8BEN-E
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:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the W-8BEN-E
String
-
processW8BenEAsync
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:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the W-8BEN-E
CompletableFuture<String>
-
processW8BenEUrl
Process W-8BEN-E from url and extract all the fields from it. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]parameters
- Additional request parameters- Returns:
- the data extracted from the W-8BEN-E
String
-
processW8BenEUrlAsync
CompletableFuture<String> processW8BenEUrlAsync(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process W-8BEN-E from url and extract all the fields from it. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]parameters
- Additional request parameters- Returns:
- the data extracted from the W-8BEN-E
CompletableFuture<String>
-
deleteW8BenE
Delete W-8BEN-E from Veryfi. https://docs.veryfi.com/api/w-8ben-e/delete-a-w-8-ben-e/- Parameters:
documentId
- ID of the W-8BEN-E you'd like to delete.- Returns:
- the response data.
String
-
deleteW8BenEAsync
Delete W-8BEN-E from Veryfi. https://docs.veryfi.com/api/w-8ben-e/delete-a-w-8-ben-e/- Parameters:
documentId
- ID of the W-8BEN-E you'd like to delete.- Returns:
- the response data.
CompletableFuture<String>
-
getW9s
String getW9s(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringString
with the 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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the url
String
-
getW9sAsync
CompletableFuture<String> getW9sAsync(int page, int pageSize, boolean boundingBoxes, boolean confidenceDetails, org.json.JSONObject parameters) Returns a json stringCompletableFuture<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.pageSize
- The number of Documents per page.boundingBoxes
- A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.confidenceDetails
- A field used to determine whether or not to return the score and ocr_score fields in the Document response.parameters
- Additional request parameters.- Returns:
- the list of previously processed W9s
String
-
getW9
Returns a json stringString
W9 information. https://docs.veryfi.com/api/w9s/get-a-w-9/- Parameters:
documentId
- ID of the W9 you'd like to retrieve.- Returns:
- the data extracted from the W9
String
-
getW9Async
Returns a json stringCompletableFuture<String>
W9 information. https://docs.veryfi.com/api/w9s/get-a-w-9/- Parameters:
documentId
- ID of the W9 you'd like to retrieve.- Returns:
- the data extracted from the W9
String
-
processW9
Process a W9 and extract all the fields from it. https://docs.veryfi.com/api/w9s/process-a-w-9/- Parameters:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the W9
String
-
processW9Async
Process a W9 and extract all the fields from it. https://docs.veryfi.com/api/w9s/process-a-w-9/- Parameters:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the W9
CompletableFuture<String>
-
processW9Url
Process W9 from url and extract all the fields from it. https://docs.veryfi.com/api/w9s/process-a-w-9/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]parameters
- Additional request parameters- Returns:
- the data extracted from the W9
String
-
processW9UrlAsync
CompletableFuture<String> processW9UrlAsync(String fileUrl, List<String> fileUrls, org.json.JSONObject parameters) Process W9 from url and extract all the fields from it. https://docs.veryfi.com/api/w9s/process-a-w-9/- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".fileUrls
- Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]parameters
- Additional request parameters- Returns:
- the data extracted from the W9
CompletableFuture<String>
-
deleteW9
Delete W9 from Veryfi. https://docs.veryfi.com/api/w9s/delete-a-w-9/- Parameters:
documentId
- ID of the W9 you'd like to delete.- Returns:
- the response data.
String
-
deleteW9Async
Delete W9 from Veryfi. https://docs.veryfi.com/api/w9s/delete-a-w-9/- Parameters:
documentId
- ID of the W9 you'd like to delete.- Returns:
- the response data.
CompletableFuture<String>
-
getContracts
Returns a json stringString
with the list of Contracts.- Parameters:
page
- The page number. The response is capped to maximum of 50 results per page.pageSize
- The number of Documents per page.parameters
- Additional request parameters.- Returns:
- the url
String
-
getContractsAsync
Returns a json stringCompletableFuture<String>
list of Contracts.- Parameters:
page
- The page number. The response is capped to maximum of 50 results per page.pageSize
- The number of Documents per page.parameters
- Additional request parameters.- Returns:
- the list of previously processed Contracts
String
-
getContract
Returns a json stringString
with the Contract information.- Parameters:
documentId
- ID of the Contract you'd like to retrieve.- Returns:
- the data extracted from the Contract
String
-
getContractAsync
Returns a json stringCompletableFuture<String>
with the Contract information.- Parameters:
documentId
- ID of the Contract you'd like to retrieve.- Returns:
- the data extracted from the Contract
String
-
processContract
Process a Contract and extract all the fields from it.- Parameters:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the Contract
String
-
processContractAsync
Process a Contract and extract all the fields from it.- Parameters:
filePath
- Path on disk to a file to submit for data extraction.parameters
- Additional request parameters.- Returns:
- the data extracted from the Contract
CompletableFuture<String>
-
processContractUrl
Process Contract from url and extract all the fields from it.- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".parameters
- Additional request parameters- Returns:
- the data extracted from the Contract
String
-
processContractUrlAsync
Process Contract from url and extract all the fields from it.- Parameters:
fileUrl
- Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".parameters
- Additional request parameters- Returns:
- the data extracted from the Contract
CompletableFuture<String>
-
deleteContract
Delete a Contract from Veryfi.- Parameters:
documentId
- ID of the Contract you'd like to delete.- Returns:
- the response data.
String
-
deleteContractAsync
Delete a Contract from Veryfi.- Parameters:
documentId
- ID of the Contract you'd like to delete.- Returns:
- the response data.
CompletableFuture<String>
-