> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/veryfi.md).

# Veryfi

Extract vendor, totals, tax, and line items from receipts and invoices with Veryfi OCR.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Veryfi    | API Key        |

### Veryfi

Extract vendor, totals, tax, and line items from receipts and invoices with Veryfi OCR.

#### Set up in Veryfi

1. Prepare the Veryfi account or service that the workflow will access. Grant access to the required resources and operations.
2. **Client ID:** Your Veryfi Client ID, from Settings > API Auth Credentials.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Veryfi**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field                        | Required                 | What to enter                                                                                                                                                                                       |
| ------------------------------------ | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Client ID                            | Yes                      | Your Veryfi Client ID, from Settings > API Auth Credentials. [Provider instructions](https://app.veryfi.com/api/settings/keys/).                                                                    |
| API Key                              | Yes                      | Your Veryfi API key. A Bearer key (starting with 'vrfk\_') is recommended; a legacy standard key also needs the username below. [Provider instructions](https://app.veryfi.com/api/settings/keys/). |
| Username (legacy standard keys only) | Optional / as applicable | Only required with a legacy standard API key. Leave blank when using a Bearer key; Veryfi then authenticates with 'Authorization: Bearer \<api\_key>'.                                              |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Veryfi** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Process Receipt or Invoice

Extract vendor, totals, taxes, dates and line items from a receipt or invoice file.

#### Inputs

| Field                     | Type    | Required | Description                                                                                               |
| ------------------------- | ------- | -------- | --------------------------------------------------------------------------------------------------------- |
| File URL                  | string  | Yes      | Public link to the receipt or invoice (PDF, JPG, PNG, HEIC and more, up to 20 MB).                        |
| Tags                      | string  | No       | Comma-separated labels to attach to the document so you can filter it later.                              |
| Candidate Categories      | string  | No       | Comma-separated list of your own expense categories. Veryfi picks the best match instead of its defaults. |
| External ID               | string  | No       | Your own reference (for example an expense report ID) stored with the document.                           |
| Country Hint              | string  | No       | Two-letter country code of the document to improve accuracy, for example US or GB.                        |
| Max Pages                 | integer | No       | Maximum number of pages to read from the file. Default: 15.                                               |
| Fast Mode                 | boolean | No       | Return results faster by skipping extra enrichment such as vendor lookup. Default: false.                 |
| Include Confidence Scores | boolean | No       | Include how confident Veryfi is about each extracted field. Default: false.                               |
| Advanced options          | boolean | No       | Set candidate categories, an external ID, a country hint, or OCR tuning. Default: false.                  |

#### Outputs

| Field          | Type          | Description                                                 |
| -------------- | ------------- | ----------------------------------------------------------- |
| Document ID    | integer       | Veryfi ID of the document.                                  |
| Vendor         | string        | Merchant or supplier name.                                  |
| Date           | string        | Transaction or invoice date.                                |
| Total          | number        | Grand total.                                                |
| Subtotal       | number        | Total before tax.                                           |
| Tax            | number        | Tax amount.                                                 |
| Currency       | string        | Currency of the amounts.                                    |
| Invoice Number | string        | Invoice or receipt number.                                  |
| Category       | string        | Expense category Veryfi assigned.                           |
| Tags           | array         | Labels attached to the document.                            |
| Line Items     | object\_array | Individual items on the document.                           |
| PDF URL        | string        | Temporary link to the PDF Veryfi generated, when available. |
| Image URL      | string        | Temporary link to the original file, when available.        |
| Full Document  | object        | Every field Veryfi extracted.                               |

### Get Document

Fetch the extracted data of a document that was already processed.

#### Inputs

| Field                     | Type            | Required | Description                                                                 |
| ------------------------- | --------------- | -------- | --------------------------------------------------------------------------- |
| Document                  | select (string) | Yes      | The document to fetch. Options load from the selected connection.           |
| Advanced options          | boolean         | No       | Include per-field confidence scores in the full document. Default: false.   |
| Include Confidence Scores | boolean         | No       | Include how confident Veryfi is about each extracted field. Default: false. |

#### Outputs

| Field          | Type          | Description                                                 |
| -------------- | ------------- | ----------------------------------------------------------- |
| Document ID    | integer       | Veryfi ID of the document.                                  |
| Vendor         | string        | Merchant or supplier name.                                  |
| Date           | string        | Transaction or invoice date.                                |
| Total          | number        | Grand total.                                                |
| Subtotal       | number        | Total before tax.                                           |
| Tax            | number        | Tax amount.                                                 |
| Currency       | string        | Currency of the amounts.                                    |
| Invoice Number | string        | Invoice or receipt number.                                  |
| Category       | string        | Expense category Veryfi assigned.                           |
| Tags           | array         | Labels attached to the document.                            |
| Line Items     | object\_array | Individual items on the document.                           |
| PDF URL        | string        | Temporary link to the PDF Veryfi generated, when available. |
| Image URL      | string        | Temporary link to the original file, when available.        |
| Full Document  | object        | Every field Veryfi extracted.                               |

### List Documents

Find processed documents by text, tag, status or date.

#### Inputs

| Field            | Type            | Required | Description                                                                                                                               |
| ---------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Search Text      | string          | No       | Text that appears in the document or in an extracted field (case sensitive).                                                              |
| Tag              | string          | No       | Only documents with this tag.                                                                                                             |
| Status           | select (string) | No       | Only documents in this review status. Veryfi does not include the status in the results. Available values: Processed, Reviewed, Archived. |
| Uploaded After   | datetime        | No       | Only documents uploaded after this moment.                                                                                                |
| Uploaded Before  | datetime        | No       | Only documents uploaded before this moment.                                                                                               |
| Advanced options | boolean         | No       | Show external ID, max results, and page controls. Default: false.                                                                         |
| External ID      | string          | No       | Only the document with this external reference.                                                                                           |
| Max Results      | integer         | No       | Maximum number of documents to return (up to 200). Default: 50.                                                                           |
| Page             | integer         | No       | Page to start from, from a previous run's Next Page.                                                                                      |

#### Outputs

| Field     | Type          | Description                                          |
| --------- | ------------- | ---------------------------------------------------- |
| Documents | object\_array | Matching documents.                                  |
| Next Page | integer       | Page to continue from, empty when there are no more. |

### Update Document

Correct or enrich a processed document: category, tags, notes, vendor, amounts or review status.

#### Inputs

| Field            | Type                      | Required | Description                                                                                                                                                                                                                 |
| ---------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Document         | select (string)           | Yes      | The document to update. Options load from the selected connection.                                                                                                                                                          |
| Category         | string                    | No       | Expense category, for example Meals & Entertainment.                                                                                                                                                                        |
| Tags             | string                    | No       | Comma-separated tags. Replaces the current tags. Leave blank to keep them; remove them all with Clear fields under Advanced options.                                                                                        |
| Review Status    | select (string)           | No       | Mark the document as reviewed or archived. Veryfi only exposes this as a List Documents filter; it is not returned on the document. Available values: Processed, Reviewed, Archived.                                        |
| Notes            | textarea                  | No       | Free-text notes stored on the document. Leave blank to keep the current notes.                                                                                                                                              |
| Advanced options | boolean                   | No       | Reveal fields to correct the vendor, invoice number, amounts, external ID, approval status, or to clear tags, notes and the external ID. Default: false.                                                                    |
| Vendor Name      | string                    | No       | Correct the merchant or supplier name.                                                                                                                                                                                      |
| Invoice Number   | string                    | No       | Correct the invoice or receipt number.                                                                                                                                                                                      |
| Total            | number                    | No       | Correct the grand total.                                                                                                                                                                                                    |
| Subtotal         | number                    | No       | Correct the subtotal before tax.                                                                                                                                                                                            |
| Tax              | number                    | No       | Correct the tax amount.                                                                                                                                                                                                     |
| External ID      | string                    | No       | Your own reference stored with the document. Leave blank to keep the current one.                                                                                                                                           |
| Approved         | select (string)           | No       | Mark the document as approved or not approved. An approved document is locked: Veryfi rejects further edits until it is marked not approved. Available values: Leave unchanged, Approved, Not approved. Default: unchanged. |
| Clear Fields     | multiple\_select (string) | No       | Remove the current tags, notes or external ID from the document. Leave the matching field above blank; this is the only way to clear a value. Available values: Tags, Notes, External ID.                                   |

#### Outputs

| Field         | Type    | Description                    |
| ------------- | ------- | ------------------------------ |
| Document ID   | integer | Veryfi document ID.            |
| Full Document | object  | The document after the update. |

### Delete Document

Permanently delete a document and its extracted data from Veryfi.

#### Inputs

| Field    | Type            | Required | Description                                                        |
| -------- | --------------- | -------- | ------------------------------------------------------------------ |
| Document | select (string) | Yes      | The document to delete. Options load from the selected connection. |

#### Outputs

| Field       | Type    | Description                       |
| ----------- | ------- | --------------------------------- |
| Document ID | integer | ID of the deleted document.       |
| Deleted     | boolean | Whether the document was deleted. |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### New Document Processed

Starts the workflow for each new document that finishes processing in Veryfi, whether it was uploaded by API, email, mobile app or the web portal.

Optionally limit this to documents with one tag. Leave it blank to watch every processed document.

#### Configuration

| Field         | Type   | Required | Description                               |
| ------------- | ------ | -------- | ----------------------------------------- |
| Only With Tag | string | No       | Only trigger for documents with this tag. |

#### Event inputs

| Field         | Type    | Required | Description                     |
| ------------- | ------- | -------- | ------------------------------- |
| Document ID   | integer | Yes      | Veryfi document ID. Default: 0. |
| Vendor        | string  | No       | Merchant or supplier name.      |
| Total         | number  | No       | Grand total.                    |
| Full Document | object  | Yes      | Every field Veryfi extracted.   |

#### Outputs

| Field         | Type    | Description                   |
| ------------- | ------- | ----------------------------- |
| Document ID   | integer | Veryfi document ID.           |
| Vendor        | string  | Merchant or supplier name.    |
| Total         | number  | Grand total.                  |
| Full Document | object  | Every field Veryfi extracted. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/veryfi.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
