Skip to main content
POST
Create a verification

Authorizations

API-KEY
string
header
required

Your VerifyYou API key.

Body

application/json
external_id
string

Your application's user identifier. If omitted, a UUID is generated automatically.

Example:

"user_123"

redirect
string<uri>

URL the user is redirected to after completing verification. vy_token and vy_status query parameters are appended.

Example:

"https://yourapp.com/done"

region
string

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.

Example:

"event_2026_austin"

phone
string

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.

Example:

"+12105550142"

Response

Verification created successfully.

verification_url
string<uri>

URL to send the user to for verification. Two possible shapes:

  • No phone in the request: https://verifyyou.com/invite?session_id=<id>, landing page → phone-OTP → liveness.
  • phone supplied: 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.

Example:

"https://verifyyou.com/invite?session_id=zsjmq6"

external_id
string

The external_id used for this verification. Matches what you sent, or the auto-generated ID if omitted.

Example:

"user_123"