Overview
The Konfir API is designed for teams who want to create verifications from their own systems and keep applicants in a single, in-session flow. Instead of sending invite links via email/sms, your product launches the Konfir journey directly and then consumes results programmatically.
You still get the same outcome: a structured verification you can review in Konsole if needed. The difference is how the journey starts and how you operationalise results.
Why use the Konfir API
Use the API when you need one or more of the following:
You’re running high volumes
You want to keep your users inside your product journey for instant results
You want results to land back in your systems
Note: If you’re creating occasional one-off requests and reviewing manually, using the Konsole may be simpler. See: How to create verifications.
What you can do with the Konfir API
At a high level, the API supports three things:
1) Create a verification request
Your system creates a verification and receives a candidate URL the applicant uses to start the Konfir journey.
2) Bring applicants into the journey in-flow
You present the candidate URL inside your experience (for example, as a button or embedded step) to keep applicants in your journey
3) Retrieve results
Once the applicant finishes, you can retrieve the verification output and use it in your workflow (and optionally generate a PDF report for review/audit).
Getting Started
To integrate, see API setup guide: documentation & checklist