Skip to main content
POST
/
sdk
/
create-verification-link
Create Verification Link
curl --request POST \
  --url https://api.botshield.ai/operations/sdk/create-verification-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_email": "[email protected]",
  "return_url": "<string>",
  "webhook_url": "<string>",
  "scope": "<string>",
  "sdk_type": "signal",
  "metadata": {}
}
'
{
  "data": {
    "request_id": "<string>",
    "deep_link": "<string>",
    "web_url": "<string>",
    "qr_code_url": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "organization": {
      "id": "<string>"
    },
    "sdk_type": "signal",
    "scope": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Your BotShield API key (e.g., bs_live_sk_... for production, bsk_test_... for test). For create-verification-link, use the session token (bss_*) returned from create-session.

Body

application/json
​
user_email
string<email>

Email of the user being verified (used for delivery if applicable)

​
return_url
string

URL to redirect the user back to after verification completes

​
webhook_url
string<uri>

URL where BotShield will POST the verification result when complete

​
scope
string

Action scope for this verification (e.g., 'checkout.complete', 'account.create')

​
sdk_type
enum<string>

SDK type. Use 'signal' for SDK A (currently available)

Available options:
signal,
presence
​
metadata
object

Custom metadata attached to the verification request (e.g., order_id, amount)

Response

Verification link created

​
data
object
required