klink-developers-logo

Webchat Identity Verification

Get identity verification settings

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

Returns whether a secret is configured and which verification rules are active. The secret itself is never returned by this endpoint.

Request

Authorization

Bearer Token

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

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

Path Params
  • channelIdstringrequired

    Example:

Responses

200

Current settings.

  • requestIdstring<uuid>required

    Unique ID for this request, useful when contacting support.

  • secretConfiguredbooleanrequired

    Whether an identity secret exists for this channel.

  • enforceIdentityVerificationbooleanrequired

    When true, unverified identities are treated as anonymous guests.

  • requireIdentityTokenbooleanrequired

    When true, only expiring userTokens are accepted, and the legacy userHash is refused.

400

Invalid request, e.g. channelId is not a UUID.

  • 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