Create a verification
Registers a user and returns a verification_url. Redirect or link your
user to this URL so they can complete the liveness check. After
completion, the user is redirected back to redirect with vy_token
and vy_status query parameters appended.
Authorizations
Your VerifyYou API key.
Body
Your application's user identifier. If omitted, a UUID is generated automatically.
"user_123"
URL the user is redirected to after completing verification.
vy_token and vy_status query parameters are appended.
"https://yourapp.com/done"
Limits each verified person to one account per region, preventing duplicate accounts and fraud within the same context. Use this when you need one real human per context: e.g. one account per competition, one response per form, or one player per server. Users already verified can connect to new regions instantly without redoing the liveness check. If omitted, each person is limited to one account across your entire integration.
"event_2026_austin"
Optional E.164 phone number. When supplied, the returned
verification_url lands the user directly on the liveness check
with no phone-OTP step (instead of the usual /invite landing
page). Use this only when you've already verified the number
out-of-band (e.g. your own SMS/login flow); the URL is the
trust anchor for the shortcut, so deliver it over a channel
you've already authenticated. Test phone numbers from the
sandbox work today; real-phone bypass requires server-side OTP
suppression that isn't shipped yet.
"+12105550142"
Response
Verification created successfully.
URL to send the user to for verification. Two possible shapes:
- No
phonein the request:https://verifyyou.com/invite?session_id=<id>, landing page → phone-OTP → liveness. phonesupplied:https://verifyyou.com/verify?session_id=<id>&t=<opaque>, skips the phone-OTP step and lands the user directly on the liveness check.
Always send your user to whichever URL came back; the path is an implementation detail.
"https://verifyyou.com/invite?session_id=zsjmq6"
The external_id used for this verification. Matches what you sent, or the auto-generated ID if omitted.
"user_123"