Konfir’s API lets you create a verification request programmatically and receive a candidate URL you can embed in your own journey (button, link, QR code). This is the recommended approach for scalable, embedded workflows. This article explains product-level detail (workflow and prerequisites).
For technical detail (e.g. endpoints, payloads, and implementation recipe), use our developer documentation (password-protected).
Prerequisites
API access and keys
API access is available to Enterprise clients and requires API keys issued directly by Konfir. Keys cannot be self-generated in Konsole.
If you need API access, contact your Konfir account owner or email [email protected].
Redirect and webhook URLs
Most integrations also require:
a redirect URL where applicants return after the Konfir journey
a webhook URL for real-time status updates (optional)
Konfir will confirm the setup required for your organisation during onboarding.
How the API integration works
At a high level, the workflow is:
Create a verification via API - Your system creates a new verification request for an applicant.
Receive a secure applicant URL - Konfir returns a unique URL for the applicant journey.
Send or redirect the applicant into the Konfir journey - You can embed this in your UI (link/button) or redirect applicants from your flow.
Applicant completes the journey - The applicant consents to connect the enabled data sources and submits their verification.
Return to your application - After the journey, the applicant is redirected back to your redirect URL (if configured).
Track progress and retrieve results - You can track status changes and completion via webhooks (recommended) and/or fetch results via API.
What you typically build
Most teams implement:
a server-side call to create verifications
a way to present the applicant URL in their product
a return/confirmation page for applicants after completion
optionally, a webhook endpoint to receive updates and keep your UI in sync
Where to find the technical specification
For the exact API reference, request/response formats, and implementation examples, use Konfir’s password-protected developer documentation. If you don’t have access, contact your Konfir account manager or email [email protected].