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 bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Settings updated.

Bodyapplication/json

🟠400

🟠401Unauthorized

🟠404ChannelNotFound

🟠429TooManyRequests

🔴502BadGateway

Request Example

Shell

JavaScript

Java

Swift

cURL

Require verified identitiesAccept only expiring userTokensBoth rules

curl --location --request PUT 'https://apigw.klinkcx.com/api/v1/webchat/channels//identity-verification' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "enforce": true
}'

Response Example

200 - Success

{
    "requestId": "7c0d4e2a-1b3f-4a6d-9e8c-5f2b1a0d3c47",
    "enforceIdentityVerification": true,
    "requireIdentityToken": true
}

Modified at 2026-09-29 08:27:56

Get identity verification settings

Create or rotate the identity secret