What is API download?
Veriff's API allows you to fetch session-related data on demand by sending specific requests to Veriff's endpoints. This method gives you more control over the data retrieval process and is particularly useful for bulk downloads.
Get verification data via Veriff’s API
Whether you need real-time updates or scheduled data retrieval, this video walks you through using Veriff’s API to access sessions data with maximum flexibility.
💡 Watch this video to learn how to:
✅ Fetch data via API. Retrieve session details, user info, verification attempts, and decisions on demand.
✅ Make efficient API calls. Learn how to structure requests to optimize performance and stay within rate limits.
✅ Automate bulk data downloads. Write scripts to process multiple session IDs efficiently.
🎥 Watch now and start retrieving verification data on demand!
Step-by-step process: How to Download Data via API
1. Store Session ID
When generating verification session, store the session ID that’s returned by API
2. Fetch Data Using API Endpoints
Use the following Veriff API endpoints to download specific data:
Data Type | API Endpoint |
Session Details | GET /sessions/{sessionId} |
Person Data (User Info) | GET /sessions/{sessionId}/person |
Verification Attempts Data | GET /sessions/{sessionId}/attempts |
Verification Decision Data | GET /sessions/{sessionId}/decision |
Replace {sessionId} with the session ID for the verification session.
Each endpoint will return a JSON response containing the requested data.
3. Automate the Bulk Download
If you have a large number of sessions to process, write a script to iterate through session IDs and call these endpoints sequentially.
Collect and store the JSON responses in your database or file system.
4. Handle Rate Limits
Veriff's API has rate limits, so ensure your script respects these limits to avoid disruptions.
API example use case
You need historical or bulk data for offline analysis or audits.
You want to fetch data on demand instead of waiting for webhook updates.