Skip to main content
POST
/
sdk
/
create-verification-link
Create a verification request
curl --request POST \
  --url https://api.botshield.ai/operations/sdk/create-verification-link \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_email": "[email protected]",
  "return_url": "<string>",
  "webhook_url": "<string>",
  "scope": "<string>",
  "mode": "linked-account",
  "botshield_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "signal_token": "<string>",
  "metadata": {}
}
'
{
  "data": {
    "request_id": "<string>",
    "deep_link": "<string>",
    "web_url": "<string>",
    "qr_code_url": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "scope": "<string>",
    "organization": {
      "id": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

API key with Bearer prefix (e.g., 'Bearer bs_live_sk_...' or 'Bearer pk_live_...')

Body

application/json
​
user_email
string<email>
​
return_url
string<uri>
​
webhook_url
string<uri>
​
scope
string
​
sdk_type
enum<string>
Available options:
signal,
presence
​
mode
enum<string>
default:linked-account

linked-account = OAuth+passkey, private = direct WebAuthn (no PII)

Available options:
linked-account,
private
​
botshield_user_id
string<uuid>

Returning user ID to skip onboarding

​
signal_token
string

Tamper-proof Signal Pixel token (bs_sig_...) for server-side score correlation

​
metadata
object

Response

Verification link created

​
data
object
required