Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/veryfi/veryfi-nodejs

Node.js module for communicating with the Veryfi OCR API. || read: https://veryfi.com/nodejs
https://github.com/veryfi/veryfi-nodejs

api invoice nodejs ocr receipt sdk sdk-nodejs veryfi veryfi-api

Last synced: 2 days ago
JSON representation

Node.js module for communicating with the Veryfi OCR API. || read: https://veryfi.com/nodejs

Host: GitHub
URL: https://github.com/veryfi/veryfi-nodejs
Owner: veryfi
Created: 2021-06-30T20:08:01.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-10-23T22:53:18.000Z (23 days ago)
Last Synced: 2024-10-24T12:02:00.259Z (22 days ago)
Topics: api, invoice, nodejs, ocr, receipt, sdk, sdk-nodejs, veryfi, veryfi-api
Language: JavaScript
Homepage: https://veryfi.github.io/veryfi-nodejs/
Size: 4.24 MB
Stars: 26
Watchers: 5
Forks: 8
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Veryfi SDK for Node.js

[![Node.js - version](https://img.shields.io/badge/node-%3E%3D%206.0.0-brightgreen)](https://www.npmjs.com/package/@veryfi/veryfi-sdk)
[![npm](https://img.shields.io/badge/npm-v7.0.0-blue)](https://www.npmjs.com/package/@veryfi/veryfi-sdk)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

## Table of Contents

- [Veryfi SDK for Node.js](#veryfi-sdk-for-nodejs)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Obtaining Client ID and user keys](#obtaining-client-id-and-user-keys)
- [Node.js API Client Library](#nodejs-api-client-library)
- [Extracting Data](#extracting-data)
- [Response](#response)
- [Updating a document](#updating-a-document)
- [Need help?](#need-help)
- [Learn more at our blog](#learn-more-at-our-blog)
- [Tutorial Video](#tutorial-video)

**veryfi-nodejs** is a Node.js module for communicating with the [Veryfi OCR API](https://veryfi.com/api/)

## Installation

Install from [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), a package manager for Javascript.

```bash
npm i @veryfi/veryfi-sdk
```

You may need to run the above command with `sudo`.

## Getting Started

### Obtaining Client ID and user keys

If you don't have an account with Veryfi, please go ahead and register here: [https://app.veryfi.com/signup/api/](https://app.veryfi.com/signup/api/)

### Node.js API Client Library

The **veryfi** library can be used to communicate with Veryfi API. All available functionality is described here:

Below is a sample script using **Veryfi** for OCR and extracting data from a document:

### Extracting Data

```js
const Client = require('@veryfi/veryfi-sdk');
const client_id = 'your_client_id';
const client_secret = 'your_client_secret';
const username = 'your_username';
const api_key = 'your_password';

const categories = ['Grocery', 'Utilities', 'Travel'];
const file_path = './test/receipt.png';
```

This submits a document for processing (3-5 seconds for a response)

```js
let veryfi_client = new Client(client_id, client_secret, username, api_key);
let response = veryfi_client.process_document(file_path, categories=categories).then(response => {
console.log(response)
});
```

...or with a URL

```js
let response = veryfi_client.process_document_url(url, external_id=some_id).then(response => {
console.log(response)
});
```

### Response

### Updating a document

```js
let new_vendor = {"name": "Starbucks", "address": "123 Easy Str, San Francisco, CA 94158"};
let category = "Meals & Entertainment";
let new_total = 11.23;
veryfi_client.update_document(id=12345,
{
'vendor': new_vendor,
'category': new_category,
'total': new_total
})
.then(response => {
console.log(response)
});
```

## Need help?
Visit https://docs.veryfi.com/ to access integration guides and usage notes in the Veryfi API Documentation Portal

If you run into any issue or need help installing or using the library, please contact [email protected].

If you found a bug in this library or would like new features added, then open an issue or pull requests against this repo!

### [API Docs](https://docs.veryfi.com/)

### [Learn more at our blog](https://www.veryfi.com/nodejs/)

## Tutorial Video

[![Veryfi Tutorial](https://img.youtube.com/vi/PcJdgnvyfBc/maxresdefault.jpg)](https://www.youtube.com/watch?v=PcJdgnvyfBc)