FaceVerifyDocs
Browse docsTap to expand

FaceVerify API

A hosted face verification API. Your backend starts a verification session, then the person completes a guided live capture in the browser before the session is confirmed.

How it works

  1. Your backend calls POST /v1/verify with an external user ID, optional display name, redirect URL, and metadata.
  2. The response always includes a verify_url. Send the user there to begin the camera flow.
  3. The hosted page guides them through the live steps: center, turn, blink, and smile.
  4. The completion endpoint returns a decision, and the same result is available through the signed webhook or GET /v1/sessions/:token.
  5. If you provided a redirect_url, the browser is redirected there at the end too.

Quickstart

Every request needs an API key. Generate one from your dashboard, then:

POSThttps://api-faceverify.bluufun.com/v1/verify
Headers
Authorization: Bearer sk_live_...
Body (form-data)
KeyValueType
external_user_iduser-001Text
full_nameJane DoeText
redirect_urlhttps://yourapp.com/verify/callbackText

You always get back a pending verification session with a verify_url see Verify a session for the full response shape.

All request/response examples in these docs use the live v2 flow. The old one-shot image match path is gone.