Skip to main content
​
SDK 0.4.0

​
Embed a server-minted session

vycheck({ session }) runs a session you created on your server, so an embedded flow can carry an external_id or a bound identity that only a secret key can set.
  • Call POST /v3/initialize from your backend with external_id, email, or phone. It now returns a session_id next to url.
  • Pass the session_id to vycheck({ session }) in the browser. The flow opens as a drawer or inline, with no redirect.
  • Confirm the returned token on your backend as before.
Embedded flows previously ran from the publishable key alone and couldn’t attach an external_id. Now they can.

​
close() on the vycheck handle

vycheck() returns a handle with a close() method to dismiss a drawer or inline embed before the person finishes. See vycheck().

​
Documented confirmation reasons

The reasons on a confirmation are now enumerated in the API reference, each with a line on what it means: collision_company, identity_mismatch, duplicate_account, and the rest.
​
SDK 0.2.0

​
SDK 0.2.0 is the new default

npm install @verifyyou-sdk/client now installs 0.2.0. The headline: you choose how the flow appears.
  • Display modes. Alongside the classic redirect, the flow can now open as a drawer that slides over your page or inline inside an element you own. Pick the mode once in init(); vycheck() stays the same call.
  • Completion callbacks. In the embedded modes the result is delivered to your onComplete callback and resolves the vycheck() promise. No redirect, no lost page state.
  • Production by default. SDK builds now target the production API out of the box.
If you’re on 0.1.1, the core contract is unchanged: the same vyt/vyc return parameters and the same backend confirmation. See the updated vycheck() and vyget() pages for the new result shape.

​
Richer confirmation responses

GET /v3/confirmations/{token} now returns more than the verdict:
  • status: approved or denied (approved with findings is presented as flagged)
  • reasons: the rule findings behind the status, such as collision_company
  • confirmed_at: when the verdict settled
  • identity: the verified email or phone, when your verification has sharing enabled
  • id: the confirmation id
verified remains the field to gate on.

​
Key check endpoint

POST /v3/keys/test validates any key and reports its type and mode. Wire it into setup scripts or healthchecks.

​
Docs

  • New init() page covering setup and the display modes
  • Identity and recognition: clearer story on device IDs and the claim a verified identity gives a person over their own uniqueness
  • Condensed uniqueness explanation: check group (company or network) and collision action (block or flag)
  • Flow tracking webhooks and the Platform API pages were removed ahead of deprecation