1. Webchat Identity Verification
  • Getting Started
    • Introduction
    • Quickstart
    • Authentication
    • Status codes
  • Webhook
    • Webhook Setup
    • Webhook Events and Schema
  • SDKs
    • @klink.cloud/call-sdk
  • API Reference
    • Contact
      • Listing
      • Create
      • Filter By SocialPlatformId
      • Form Fields
      • Detail
      • Update
      • Delete
      • Fetch Contact Groups
      • Update tags
      • Filter By Phone Number
    • Tag
      • Listing
    • Channel
      • Listing
      • Create
    • Ticket
      • Listing
      • Create
      • Filter by Contact ID
      • Form Fields
      • Update
      • Update status
    • Category
      • Listing
    • CxLog
      • Listing
    • Message
      • Send message
      • Create comments
      • Get Comments
    • Media Manager
      • Upload File (multipart)
      • Get Folders
      • Get Folder By ID
      • Create Folder
      • Update Folder
      • Delete Folder
      • Get Files
      • Get File By ID
      • Create File
      • Update File
      • Delete File
    • Agent Activity
      • Get Agents Activities
    • Telephony
      • Get Telephony CDR
    • User
      • Create
      • Listing
      • Detail
      • Update
      • Delete
    • Automation Queue
      • Create
      • Listing
      • Detail
      • Update
      • Delete
      • Add Member
      • Remove Member
    • Role
      • Listing
    • Webchat Identity Verification
      • Get identity verification settings
        GET
      • Update identity verification settings
        PUT
      • Create or rotate the identity secret
        POST
    • Schemas
      • RequestId
      • IdentityVerificationStatus
      • IdentityVerificationUpdate
      • IdentityVerificationSettings
      • IdentitySecret
      • userToken (JWT claims)
      • Error
Blog
Github
  1. 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 bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Responses

🟢200
application/json
Current settings.
Bodyapplication/json

🟠400BadRequest
🟠401Unauthorized
🟠404ChannelNotFound
🟠429TooManyRequests
🔴502BadGateway
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://apigw.klinkcx.com/api/v1/webchat/channels//identity-verification' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Success
{
    "requestId": "3f2b6c1e-9d7a-4e1b-8c55-2a9f0e7d4b10",
    "secretConfigured": true,
    "enforceIdentityVerification": true,
    "requireIdentityToken": false
}
Modified at 2026-09-29 08:27:56
Previous
Listing
Next
Update identity verification settings
Built with