POST Secret key. Returns the session_id your frontend opens with vycheck({ session }), and the hosted url if you would rather redirect yourself.
Body
Where the person lands when done, with
?vyt=<token>&vyc=<0|1> appended. Overrides the URL saved on the verification. Absolute https; http allowed on localhost and private addresses.Your id for this run. Duplicates are reported against it. A different id than the person’s earlier pass always runs a fresh check, even inside the skip window.
Your id for the uniqueness pool this run belongs to, so one verification can be reused across separate groups. Judged only against passes carrying the same group; omit to judge against all of them. Keep
external_id per person rather than per group. 1 to 255 characters. See Groups.Other groups whose history also counts against this run. A prior pass in an included group blocks or flags exactly as a pass in the run’s own
group would, following the verification’s settings; the run still settles into its own group. Does nothing without group, since an ungrouped run is judged against everything already. Up to 50 ids, each 1 to 255 characters. See Groups.What you already know about this person — a plan, a signup date, a department code. Kept against them and shown on their profile in the dashboard, beside the columns an uploaded list carries. Never affects the result. Requires an identifier (
email, phone or external_id): an anonymous session has nobody to attach it to. Up to 50 keys, keys 1 to 64 characters, string values 1 to 1024. An empty value is refused rather than dropped.Extra query params echoed onto the return URL.
vy* names are ignored. Unlike metadata, these are not kept — they only ride the return URL.Return to
redirect_url the instant an approved check settles, instead of showing the result screen with a return button. Works with any key. Overlays the verification’s saved setting for this run only. Ignored by invite links.Response
Errors
Example
verification_external_id, external_tracker, expire_in_days, and the invite_id response field.