ARCY AI
SettingsInstall

Identity verification

Turn the identity check on once your signed identify() calls verify, and read the chart that shows how each session's claim fared.

Settings > Install > Identity verification shows whether the user ids your pages claim through identify() arrive with a valid signature, and lets an admin make that signature required. It reads the environment in the address.

While the check is off, anyone can call arcy.identify() with someone else's user id from a browser console, and ARCY answers as that person, with that person's attributes filled in. This page is the only place that warning appears, because this is where it is turned off. Nothing private belongs in the Persona or in the widget texts for signed-in users until it is on.

Before you start

  • Signing happens on your server with the environment's Secret key. The recipe is in the Quickstart.
  • Only a Workspace Admin can change Require identity verification. Everyone can read the chart.

Setting it up

  1. Add the signature to your identify() calls, following Sign the users you identify on the page. Each agent button on that card copies the whole task, written for that agent: where the Secret key is read, how the hash is made, how it reaches identify().
  2. Deploy, then watch Identity checks. The chart opens on Last 7 days; pick a narrower window from the date picker on the card to see the deploy by the hour. A window of two days or less draws one bar per hour, a wider one draws one bar per day in your own time zone. Each bar is the sessions that tried to identify in that hour or day, split by outcome, and the totals under the chart cover the picked window.
  3. When the bars are Verified and Unverified has gone to zero, turn on Require identity verification.

What it changes

Off, ARCY checks every signature, records the outcome in the chart, and turns nobody away.

On, a session whose claim does not verify is served as anonymous. The whole identify() call is dropped: the user id and every attribute sent with it, including name, email and plan. No profile is created or updated. The call still succeeds from the browser's point of view, so the widget can greet the user by the name it was handed while ARCY stores nothing.

The chart splits sessions into Verified, Verified (previous secret key), Unverified and Refused. What each outcome means for one session is explained on Users, where the same outcome is shown per session.

When it goes wrong

Unverified rises after you turned the check on. Users are arriving as anonymous. Open the browser console on an affected page: the widget warns on every call that is missing userHash. Fix the signature before anything else.

Refused rises after you replaced the Secret key. A server is still signing with the old Secret key. Deploy the new one. Replacing happens on API Keys, not here.

Everything is Unverified although your code signs. Sign the exact string you pass to identify(). String(user.id) and user.id are different inputs.

See also

On this page