Integration

Hosted flow and verification links

Send users to a ready-made, branded verification flow.

Every session has a url. That page is the whole verification flow: camera capture, quality checks, retries, translations and your branding.

#Ways to open it

OptionHow
RedirectSend the browser to url
Email the link"send_email": true with contact_details.email on POST /v3/session/
Web SDKModal or inline on your page. See Web SDK
Mobile WebViewSee Mobile apps
QR codeThe flow shows one on desktop so users can continue on a phone

#When the user finishes

The browser goes to your callback with ?verificationSessionId=… added. Don't trust the redirect alone: wait for the webhook or read the decision from your server.

#Pre-fill and check details

Send what you already know so the user types less, and so we can compare it with the document:

json
{
  "workflow_id": "wf_...",
  "vendor_data": "user-123",
  "contact_details": { "email": "[email protected]", "phone": "+447700900123" },
  "expected_details": { "first_name": "Jane", "last_name": "Doe", "date_of_birth": "1990-04-12", "nationality": "GBR" },
  "metadata": { "plan": "gold" }
}

A link that is never opened expires after 7 days. To let a user come back later, create a new session token or resubmit the session.