klink-developers-logo

Webchat Identity Verification

Update identity verification settings

PUT/api/v1/webchat/channels/{channelId}/identity-verification

Turn verification rules on or off. Send enforce, requireToken, or both. Fields you leave out keep their current value.

  • enforce: true means a logged-in user must be verified. Unverified identities are treated as anonymous guests.
  • requireToken: true means only expiring userTokens are accepted. The non-expiring legacy userHash is refused.

Both require an identity secret (create one with POST …/secret first).

Turn on requireToken only when every page and every supported app version sends userToken. Otherwise those users chat as guests.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Path Params
  • channelIdstringrequired

    Example:

Body Paramsapplication/json
  • enforcebooleanoptional

    Require every logged-in user to be verified.

  • requireTokenbooleanoptional

    Accept only expiring userTokens, and refuse the legacy userHash.

Responses

200

Settings updated.

  • requestIdstring<uuid>required

    Unique ID for this request, useful when contacting support.

  • enforceIdentityVerificationbooleanrequired
  • requireIdentityTokenbooleanrequired
400

Invalid request. Either neither field was sent, a value isn't a boolean, or enforcement was requested before an identity secret exists.

  • messagestringrequired
  • errorstringoptional
  • statusCodeintegerrequired
401

The API token is missing, invalid, expired or revoked.

  • messagestringrequired
  • errorstringoptional
  • statusCodeintegerrequired
404

No web chat channel with this ID exists in your account.

  • messagestringrequired
  • errorstringoptional
  • statusCodeintegerrequired
429

Rate limit exceeded (10 requests per second).

  • messagestringrequired
  • errorstringoptional
  • statusCodeintegerrequired
502

The chat service couldn't be reached. Retry shortly.

  • messagestringrequired
  • errorstringoptional
  • statusCodeintegerrequired