---
canonical_url: "https://docs.composio.dev/toolkits/veryfi"
markdown_url: "https://docs.composio.dev/toolkits/veryfi.md"
product: "platform"
version: null
last_updated: null
---

# Veryfi OCR

Veryfi extracts structured data from receipts, invoices, bank statements, tax forms, checks, business cards, and other documents.

- **Category:** ai document extraction
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 5
- **Triggers:** 0
- **Slug:** `VERYFI`
- **Version:** 00000000_00

## Tools

### Delete Document

**Slug:** `VERYFI_DELETE_DOCUMENT`

Permanently delete one Veryfi receipt or invoice by document id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | Veryfi id of the document to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document

**Slug:** `VERYFI_GET_DOCUMENT`

Retrieve one processed receipt or invoice and all extracted OCR fields by its Veryfi document ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | Veryfi ID of the processed document. |
| `bounding_boxes` | boolean | No | Include bounding boxes and regions for extracted fields. |
| `confidence_details` | boolean | No | Include confidence and OCR confidence scores for extracted fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Process Document

**Slug:** `VERYFI_PROCESS_DOCUMENT`

Submit one receipt or invoice to Veryfi OCR by public URL or base64 content. Choose synchronous processing to return extracted data now or asynchronous processing to return an id for later retrieval. This operation can be billable and is non-idempotent; after an ambiguous failure, verify whether the document was created before retrying.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags to attach to the processed document. |
| `file_url` | string | No | Publicly reachable URL of the receipt or invoice. Provide exactly one of file_url or file_data. |
| `file_data` | string | No | Base64-encoded receipt or invoice content. Provide exactly one of file_data or file_url. |
| `file_name` | string | No | Original filename including its extension, especially for file_data. |
| `categories` | array | No | Receipt or invoice categories Veryfi may use during extraction. |
| `external_id` | string | No | Caller-defined id used to correlate and later search for this document. |
| `bounding_boxes` | boolean | No | Whether to include bounding boxes and regions for extracted fields. |
| `processing_mode` | string ("sync" | "async") | No | Use sync to wait for extracted fields or async to return a document id for later retrieval. |
| `confidence_details` | boolean | No | Whether to include confidence and OCR confidence scores. |
| `max_pages_to_process` | integer | No | Maximum number of pages to OCR, from 1 through 15. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Documents

**Slug:** `VERYFI_SEARCH_DOCUMENTS`

List or search processed receipts and invoices using text, identifiers, tags, status, or date ranges, returning one controllable page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Return documents carrying this tag. |
| `query` | string | No | Case-sensitive text to match in OCR text or extracted fields; append * for a partial match. |
| `status` | string | No | Return documents with this processing status, such as in_progress. |
| `order_by` | string | No | Provider ordering expression; -created returns newest documents first. |
| `page_size` | integer | No | Documents to return in this page (1-50). |
| `external_id` | string | No | Return documents with this caller-defined external id. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page; when continuing, the cursor retains the original filters and page size. |
| `created_after` | string | No | Return documents created at or after this UTC ISO 8601 date-time. |
| `bounding_boxes` | boolean | No | Include bounding boxes and regions in returned documents. |
| `created_before` | string | No | Return documents created at or before this UTC ISO 8601 date-time. |
| `confidence_details` | boolean | No | Include confidence and OCR confidence scores in returned documents. |
| `document_date_after` | string | No | Return documents whose extracted date is at or after this UTC ISO 8601 date-time. |
| `track_total_results` | boolean | No | Request accurate totals for filtered search; this may make the request slower. |
| `document_date_before` | string | No | Return documents whose extracted date is at or before this UTC ISO 8601 date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document

**Slug:** `VERYFI_UPDATE_DOCUMENT`

Correct practical metadata and review flags on a processed receipt or invoice. Provide at least one of external_id, notes, is_approved, or is_duplicate; only explicitly provided fields are changed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | string | No | Human-readable notes to store on the document. |
| `document_id` | integer | Yes | Veryfi id of the document to update. |
| `external_id` | string | No | Replacement caller-defined correlation id. |
| `is_approved` | boolean | No | Mark whether the extracted document has been reviewed and approved. |
| `is_duplicate` | boolean | No | Mark whether this document is a duplicate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |