Complete Reference + Interactive API Walkthrough
No Postman required. Test every endpoint live from your browser. Authenticate with one click, fire real API calls, inspect JSON responses, and copy curl commands - all inside the Veryfi portal. |
Overview
Veryfi API Documentation is available at docs.veryfi.com and inside the Veryfi portal for registered users. No account is required to browse the reference docs. To make live API calls, sign up for free and start building in minutes.
API Docs (public) | |
API Portal (logged in) | |
Interactive API Explorer | docs.veryfi.com > Interactive API (top nav) |
API v8 base URL | |
API Status | |
Free signup |
Interactive API Explorer
The Interactive API Explorer is Veryfi's built-in Postman-style interface. It lets you authenticate, fill in parameters, fire real HTTP requests, and inspect live JSON responses without leaving your browser. No external tooling needed.
How to Access the Interactive API
There are two ways to reach the Interactive API Explorer:
From the docs: Navigate to docs.veryfi.com and click Interactive API in the top navigation bar.
From the portal: Log into app.veryfi.com and navigate to API Docs > Interactive in the left sidebar.
🔑 Prerequisite: You need a Veryfi account to use live API calls. Create one at app.veryfi.com/signup/api in under 2 minutes. Learn more |
💡 What you get: Full request/response cycles with real data, auto-generated curl commands, response timing, schema documentation, and example JSON responses - all in one place. |
Interface Components in Detail
Here is a breakdown of every component you will encounter inside the Interactive API Explorer.
API Server Selector
The base URL selector at the top lets you switch between Production and Dev environments with a single click. No need to edit URLs manually.
Production | https://api.veryfi.com/ (live data, real documents) |
Development | https://devapi.veryfi.com/ (safe sandbox for testing new models) |
Authentication Section
Two credential fields sit beneath the server selector:
CLIENT-ID header: Your account's unique client identifier.
AUTHORIZATION header: The value is in the format apikey USERNAME:API_KEY
⚡ Set key automatically: Clicking this button reads your credentials from your active session and fills both fields instantly. This is the fastest way to start and avoids credential typos. |
Endpoint Rows
Each endpoint is listed with its HTTP method and path. The color coding makes it easy to scan:
Method | Meaning in the API |
GET | Retrieve documents, search results, or account data - read only, no changes made |
POST | Submit a new document for processing or create a new resource |
PUT | Replace an existing document's data or settings entirely |
DELETE | Remove a document or resource from your account |
Request Panel
When you expand an endpoint you see the full parameter list. Each parameter shows its name, data type (string, integer, boolean, file), whether it is required or optional, and a plain-English description of what it does. This is the canonical reference for building your own integration.
Response Panel
The Response panel has three tabs:
Schema tab: The full JSON schema of what the endpoint returns, with field names and types.
Example tab: A realistic sample response so you can see what real extracted data looks like before you have your own documents.
Live result tab: After pressing Try, your actual response appears here with status code, latency, and the full JSON body.
Curl Tab
After every successful Try, a Curl tab appears next to the response. It shows the exact command you would run in a terminal to reproduce the same call. This is one of the fastest ways to move from the interactive explorer to your own code.
curl -X POST https://api.veryfi.com/api/v8/partner/documents/ \ -H "CLIENT-ID: vrfKOMO1xSEM0AWN************o" \ -H "AUTHORIZATION: apikey api_demo:4b1c01e8ce*******d808demo" \ -H "Content-Type: application/json" \ -d '{"file_url": "https://cdn.veryfi.com/receipts/sample.jpg"}' |
Postman Collection Download
Prefer Postman? Veryfi also provides a downloadable collection file. Import it into Postman (File > Import) to get all endpoints pre-configured. The collection includes code examples in Python, PHP, Java, and curl for every request. You can also run it via Newman from the CLI.
Find the Postman collection download link inside the portal under API Docs > Keys.
A UIPath project download is also available for RPA integrations.
📦 What the Postman file contains: All REST endpoints, pre-filled auth headers, example request bodies, and metadata so Newman can run the full collection from the command line. |
Authentication Reference
All requests to the Veryfi API require authentication headers. Find your credentials in Settings > Keys in the portal. Full guide at docs.veryfi.com/api/getting-started/authentication.
Required Headers
Header | Value Format | Notes |
CLIENT-ID | your CLIENT_ID | Identifies your account on every request |
AUTHORIZATION | apikey USERNAME:API_KEY | Authenticates the calling user |
Content-Type | application/json | Required for POST/PUT/PATCH with a JSON body |
🔒 Security tip: Rotate your API Key before going live. Admin-only users can access keys - non-admin team members are restricted by default. Learn more |
Document Processing Methods
Veryfi accepts documents in three forms. All three are available in the Interactive API Explorer via the POST /documents/ endpoint.
Method | How to Use | Best For |
File URL | Pass a publicly accessible URL in the file_url field | Documents hosted on S3, GCS, or any CDN |
Base64 | Encode the file bytes as base64 and pass in file_data | Mobile apps, files already in memory |
Multipart Upload | Send the file as a multipart/form-data attachment | Server-side direct upload of local files |
Sync vs Async Processing
Synchronous (default) | The API call blocks and returns the extracted JSON in the same response. Best for low-to-medium volume and real-time use cases. |
Asynchronous | The API accepts the document and returns a job ID immediately. The result is delivered to your webhook URL when processing completes. Best for high volume batch processing. |
Webhooks | Register a webhook URL in Settings > Webhooks. Veryfi POSTs the extracted JSON to your endpoint on completion. Use the Settings API to manage webhook registrations programmatically. |
Quick Reference
Resource | URL |
API Documentation (public) | |
Interactive API Explorer | |
API Portal (login) | |
API Keys / Settings | |
Free Signup | |
System Status | |
SDK Downloads | |
Help Center (FAQ) | |
Email Support |
Questions? Email [email protected] or chat at app.veryfi.com