Integrate

Hosted links

Single-use links from the dashboard and reusable links for verify buttons.

Use hosted links when a verification starts outside your product, for example from an email or a support call.

In the dashboard, open Verifications → New verification, enter your reference for the customer, and you get a link and a QR code to send them. Like a session created with the API, it's for one verification and lasts 24 hours.

Every verify button has a link anyone can open to start a new verification:

Hosted link
https://www.kaywhysee.com/b/vb_...?ref=user_1042

The link opens a page with a Start verification button; each press starts a fresh session and sends the visitor into it. Opening the link alone starts nothing, so link previews in chat apps and email don't create sessions. Add ref to set the session's reference, for example in an email to a known customer; it arrives as web:user_1042, kept apart from the references you create over the API, because anyone can edit a link. Put it behind any button you already have, or in an email template.

warning

Anyone with a reusable link can start sessions on your account, so it's rate-limited per visitor. Use a link for one customer, or the API, when you know who they are.

link On a computer

When someone opens any of these links on a computer, they see a QR code to scan with their phone. The code works once and lasts five minutes. The computer's page moves on by itself when they finish on the phone.

Was this page helpful?

Authorization

Your secret key stays in this tab: it is sent with this request only and never stored.

Body application/json

Response

Send the request to see the response.