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
Login to your Veryfi API Portal Account (Signup - Veryfi Hub)
Grab the required keys from Settings (left-hand menu) (https://app.veryfi.com/api/settings/keys/)
Client Header: this identifies the Partner (ie. you) that is making requests to Veryfi APIs
Authorization Header: this provides credentials that authenticate a user agent with a server, allowing access to a protected resource. It consists of USERNAME, API_KEY and the ENVIRONMENT_URL.
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/v8/partner/documents/
If you're still using V7 please read more about API Version 7 vs 8
Additionally, you need a CLIENT_SECRET: A CLIENT_SECRET is a private key known only to you/your application and the authorization server.
API Keys Access Permissions
For security and safety reasons, there is now an additional control for Admin users to access API Keys or restrict it.
Admin users that have access to API Keys can grant API Keys access to another user Admin user. API Keys is company-sensitive information, a compromise and exposure of which can lead to data breaches or other undesired situations. Please note that when you add external people as team members to your Veryfi account.
Access to API Keys can be granted to Admin users only. For non-Admin access to API Keys is restricted. Read more here
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).
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.
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: