To access the Veryfi API programmatically, you will need a secure API (application programming interface) key. An API key is a unique identifier used to authenticate a user, developer, or calling program to an API. Here is how to obtain your API key and related authentication information in order to use the Veryfi API.

3 Simple Steps

  1. Login to your Veryfi API Portal Account (Signup - Veryfi Hub )

  2. Grab the required keys from Settings (left-hand menu) (https://hub.veryfi.com/api/settings/keys/)

    1. Client Header: identifies the Partner (ie. you) that is making the requests to Veryfi APIs

    2. Authorization Header: this provides credentials that authenticate a user agent with a server, allowing access to a protected resource. For Veryfi. it consists of USERNAME, API_KEY and the ENVIRONMENT_URL

  3. Dive into the API Documentation, test drive Postman or power up with the Veryfi SDKs to accelerate your work.

Client Header

Your Client ID is located in the Keys section.

CLIENT-ID: "CLIENT_ID"

Authorization

API requests should carry the following authorization header.

AUTHORIZATION: "apikey USERNAME:API_KEY"

This is how your authorization should look:

AUTHORIZATION: "apikey api_demo:b11111111111111111a111111"

ENVIRONMENT URL

https://api.veryfi.com/

The correct address a request should be sent to should look:

ENVIRONMENT_URL/api/v7/partner/users/

To switch to version 8, all you’ll need to do is change that v7 to a v8 like so:

ENVIRONMENT_URL/api/v8/partner/users/

Read more about API Version 7 vs 8

For your convenience, just released an Interactive API Documentation feature in the Veryfi Portal (Hub). You can now try out Veryfi’s API versions while viewing the documentation directly on the Veryfi website.

Additionally, you need a CLIENT_SECRET: A CLIENT_SECRET is a private key known only to you/your application and the authorization server.


Code with Veryfi

Veryfi SDKs

The following SDKs are open-sourced and available on Github for you to use and contribute to (give back to the community).

Postman:

To help you get started with the Veryfi API, we've prepared a downloadable JSON export of the various REST requests described in this API Documentation section.

Once you've downloaded the file, open the Postman app and navigate to File > Import to import it. Download Postman File

UI Path:

Get up and running quickly with the Veryfi API in UIPath with this example UIPath project Download UIPath Project. More described in API Documentation.

Have questions, feel free to reach out to support@veryfi.com

Other Related Articles:

What is CLIENT_SECRET

Veryfi OCR API Self-Serve Portal Walk-Through

API Documentation

What Document Types Veryfi Supports

Languages Veryfi OCR API works with

File formats Veryfi supports

Want to know if the submitted image is ok or blurry

How to Improve the Accuracy


Did this answer your question?