Getting Started
Integrate VerifiMe identity verification and risk assessment into your application
VerifiMe handles identity verification, document validation, biometric checks, and AML/CTF risk assessment so you don't have to. Your application calls the API, presents the verification experience to your customer, and receives structured results via webhook.
Integrate in 3 Steps
1. Create an invite
Call POST /v1/user/invite with the customer's email and your organisation code. You get back a trackingReference and an inviteUrl. Optionally pass customerContext to pre-fill the onboarding form.
2. Present the verification experience
You have two options:
- VerifiMe Widget (recommended) - embed the widget on your page. It displays a QR code and verification button, polls status automatically, and fires
onSuccess()when the customer completes data entry. See Widget Integration. - Custom integration - use the
inviteUrlandtrackingReferencedirectly. Send the customer to the invite URL (via redirect, email, or in-app link), and poll the tracking status API to detect completion. This gives you full control over the UI.
3. Receive the webhook
VerifiMe processes identity documents, biometrics, PEP/sanctions screening, and risk rules in the background. Within 1-3 minutes, you receive a RISK_ASSESSMENT_UPDATED webhook with the risk level, customer name, and a link to the full assessment.
How It Works
The customer completes data entry in the VerifiMe portal (Phase 1), then returns to your application. VerifiMe performs backend verification and risk assessment asynchronously (Phase 2) and delivers results via webhook. Your application never handles raw identity documents.
For the full architecture, see Integration Flow.
Explore the Documentation
Integration Flow
Sequence diagram and the four integration points
API Reference
POST /v1/user/invite and GET tracking status
Widget
Embed the verification widget in your application
Webhooks
HMAC security, event payloads, and retry behaviour
Risk Assessment
Risk levels, assessment status, and scoring
Environments & Checklist
Staging and production URLs, integration checklist
Need Help?
For integration support, email support@verifime.com.