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>",
"mode": "linked-account",
"botshield_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"partner_user_ref": "<string>",
"link_on_verify": true,
"parent_request_id": "<string>",
"metadata": {},
"notarize": true,
"gate": "<string>",
"act": "dibs:listing_4417",
"act_label": "Trade with sam_k — 2 GA for $180"
}
'import requests
url = "https://api.botshield.ai/operations/sdk/create-verification-link"
payload = {
"user_email": "[email protected]",
"return_url": "<string>",
"webhook_url": "<string>",
"scope": "<string>",
"mode": "linked-account",
"botshield_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"partner_user_ref": "<string>",
"link_on_verify": True,
"parent_request_id": "<string>",
"metadata": {},
"notarize": True,
"gate": "<string>",
"act": "dibs:listing_4417",
"act_label": "Trade with sam_k — 2 GA for $180"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user_email: '[email protected]',
return_url: '<string>',
webhook_url: '<string>',
scope: '<string>',
mode: 'linked-account',
botshield_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
partner_user_ref: '<string>',
link_on_verify: true,
parent_request_id: '<string>',
metadata: {},
notarize: true,
gate: '<string>',
act: 'dibs:listing_4417',
act_label: 'Trade with sam_k — 2 GA for $180'
})
};
fetch('https://api.botshield.ai/operations/sdk/create-verification-link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.botshield.ai/operations/sdk/create-verification-link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user_email' => '[email protected]',
'return_url' => '<string>',
'webhook_url' => '<string>',
'scope' => '<string>',
'mode' => 'linked-account',
'botshield_user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'partner_user_ref' => '<string>',
'link_on_verify' => true,
'parent_request_id' => '<string>',
'metadata' => [
],
'notarize' => true,
'gate' => '<string>',
'act' => 'dibs:listing_4417',
'act_label' => 'Trade with sam_k — 2 GA for $180'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.botshield.ai/operations/sdk/create-verification-link"
payload := strings.NewReader("{\n \"user_email\": \"[email protected]\",\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"scope\": \"<string>\",\n \"mode\": \"linked-account\",\n \"botshield_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"partner_user_ref\": \"<string>\",\n \"link_on_verify\": true,\n \"parent_request_id\": \"<string>\",\n \"metadata\": {},\n \"notarize\": true,\n \"gate\": \"<string>\",\n \"act\": \"dibs:listing_4417\",\n \"act_label\": \"Trade with sam_k — 2 GA for $180\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.botshield.ai/operations/sdk/create-verification-link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user_email\": \"[email protected]\",\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"scope\": \"<string>\",\n \"mode\": \"linked-account\",\n \"botshield_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"partner_user_ref\": \"<string>\",\n \"link_on_verify\": true,\n \"parent_request_id\": \"<string>\",\n \"metadata\": {},\n \"notarize\": true,\n \"gate\": \"<string>\",\n \"act\": \"dibs:listing_4417\",\n \"act_label\": \"Trade with sam_k — 2 GA for $180\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botshield.ai/operations/sdk/create-verification-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_email\": \"[email protected]\",\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"scope\": \"<string>\",\n \"mode\": \"linked-account\",\n \"botshield_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"partner_user_ref\": \"<string>\",\n \"link_on_verify\": true,\n \"parent_request_id\": \"<string>\",\n \"metadata\": {},\n \"notarize\": true,\n \"gate\": \"<string>\",\n \"act\": \"dibs:listing_4417\",\n \"act_label\": \"Trade with sam_k — 2 GA for $180\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"data": {
"request_id": "<string>",
"deep_link": "<string>",
"web_url": "<string>",
"qr_code_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"pushed_to_devices": 123,
"sdk_type": "signal",
"auth_mode": "linked-account",
"scope": "<string>",
"organization": {
"id": "<string>"
},
"gate_type": "human",
"age_threshold": 13,
"trusted": true,
"notarize": true,
"notarize_fallback_reason": "notarize_not_enabled",
"gate": "<string>"
},
"error": {
"message": "<string>",
"statusCode": 123,
"code": "<string>",
"min_ttl_seconds": 123,
"max_ttl_seconds": 123,
"retryable": true,
"next_step": "<string>",
"violations": [
{
"source": "<string>",
"type": "<string>",
"path": "<string>",
"severity": "<string>",
"value": "<unknown>",
"explanation": "<string>",
"fix": "<string>"
}
],
"reason": "rate",
"bucket": "<string>",
"retry_in": 123,
"limits": {},
"upgrade_url": "<string>"
}
}
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Create a verification request
Creates a verification request (deep link, web URL, QR code) for a gate. Requires an grant token from create-session. Returns 409 when a pending request already exists for the same gate and user.
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>",
"mode": "linked-account",
"botshield_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"partner_user_ref": "<string>",
"link_on_verify": true,
"parent_request_id": "<string>",
"metadata": {},
"notarize": true,
"gate": "<string>",
"act": "dibs:listing_4417",
"act_label": "Trade with sam_k — 2 GA for $180"
}
'import requests
url = "https://api.botshield.ai/operations/sdk/create-verification-link"
payload = {
"user_email": "[email protected]",
"return_url": "<string>",
"webhook_url": "<string>",
"scope": "<string>",
"mode": "linked-account",
"botshield_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"partner_user_ref": "<string>",
"link_on_verify": True,
"parent_request_id": "<string>",
"metadata": {},
"notarize": True,
"gate": "<string>",
"act": "dibs:listing_4417",
"act_label": "Trade with sam_k — 2 GA for $180"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user_email: '[email protected]',
return_url: '<string>',
webhook_url: '<string>',
scope: '<string>',
mode: 'linked-account',
botshield_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
partner_user_ref: '<string>',
link_on_verify: true,
parent_request_id: '<string>',
metadata: {},
notarize: true,
gate: '<string>',
act: 'dibs:listing_4417',
act_label: 'Trade with sam_k — 2 GA for $180'
})
};
fetch('https://api.botshield.ai/operations/sdk/create-verification-link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.botshield.ai/operations/sdk/create-verification-link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user_email' => '[email protected]',
'return_url' => '<string>',
'webhook_url' => '<string>',
'scope' => '<string>',
'mode' => 'linked-account',
'botshield_user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'partner_user_ref' => '<string>',
'link_on_verify' => true,
'parent_request_id' => '<string>',
'metadata' => [
],
'notarize' => true,
'gate' => '<string>',
'act' => 'dibs:listing_4417',
'act_label' => 'Trade with sam_k — 2 GA for $180'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.botshield.ai/operations/sdk/create-verification-link"
payload := strings.NewReader("{\n \"user_email\": \"[email protected]\",\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"scope\": \"<string>\",\n \"mode\": \"linked-account\",\n \"botshield_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"partner_user_ref\": \"<string>\",\n \"link_on_verify\": true,\n \"parent_request_id\": \"<string>\",\n \"metadata\": {},\n \"notarize\": true,\n \"gate\": \"<string>\",\n \"act\": \"dibs:listing_4417\",\n \"act_label\": \"Trade with sam_k — 2 GA for $180\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.botshield.ai/operations/sdk/create-verification-link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user_email\": \"[email protected]\",\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"scope\": \"<string>\",\n \"mode\": \"linked-account\",\n \"botshield_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"partner_user_ref\": \"<string>\",\n \"link_on_verify\": true,\n \"parent_request_id\": \"<string>\",\n \"metadata\": {},\n \"notarize\": true,\n \"gate\": \"<string>\",\n \"act\": \"dibs:listing_4417\",\n \"act_label\": \"Trade with sam_k — 2 GA for $180\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botshield.ai/operations/sdk/create-verification-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_email\": \"[email protected]\",\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"scope\": \"<string>\",\n \"mode\": \"linked-account\",\n \"botshield_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"partner_user_ref\": \"<string>\",\n \"link_on_verify\": true,\n \"parent_request_id\": \"<string>\",\n \"metadata\": {},\n \"notarize\": true,\n \"gate\": \"<string>\",\n \"act\": \"dibs:listing_4417\",\n \"act_label\": \"Trade with sam_k — 2 GA for $180\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"data": {
"request_id": "<string>",
"deep_link": "<string>",
"web_url": "<string>",
"qr_code_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"pushed_to_devices": 123,
"sdk_type": "signal",
"auth_mode": "linked-account",
"scope": "<string>",
"organization": {
"id": "<string>"
},
"gate_type": "human",
"age_threshold": 13,
"trusted": true,
"notarize": true,
"notarize_fallback_reason": "notarize_not_enabled",
"gate": "<string>"
},
"error": {
"message": "<string>",
"statusCode": 123,
"code": "<string>",
"min_ttl_seconds": 123,
"max_ttl_seconds": 123,
"retryable": true,
"next_step": "<string>",
"violations": [
{
"source": "<string>",
"type": "<string>",
"path": "<string>",
"severity": "<string>",
"value": "<unknown>",
"explanation": "<string>",
"fix": "<string>"
}
],
"reason": "rate",
"bucket": "<string>",
"retry_in": 123,
"limits": {},
"upgrade_url": "<string>"
}
}
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Authorizations
Body
The gate this request runs (the gate's action name, as listed in the Console under BotShield Gate). Deprecated (alias window, sunset 2027-01-15): use gate. Accepted through the window; responses carry both. https://docs.botshield.ai/changelog/alias-window
Run this ceremony as a notarize ceremony. The gate's Console switch (notarize_enabled) is the authority: the ceremony runs only when the switch is on. true with the switch off falls back to a plain verification with notarize_fallback_reason = notarize_not_enabled. false opts this placement out. Absent → inherited from the grant window, else offered when the switch is on. Requires partner_user_ref; never on an Age Gate. verification/complete writes the Verified Account binding in the same transaction as the completion.
BotShield Actions: the act this tap is for — e.g. watch or dibs:listing_4417. The part before the first ':' must name a placed, live BotShield Action (Console → Verified Accounts › BotShield Actions, or the Gates API); the rest is yours and is never read — it rides the signed token as the act claim (verify-token echoes it verbatim), so your own check can tell one tap from another. Never together with gate/scope (action_not_a_gate). An action always stands on a verified account: partner_user_ref is required (action_requires_user_ref) and the tap runs the linking ceremony.
128^[A-Za-z0-9][A-Za-z0-9_:.\-]{0,127}$"dibs:listing_4417"
What the person is confirming, shown verbatim on their card (e.g. "Trade with sam_k — 2 GA for $180"). Only with act (act_label_without_act). Display only — it is NOT in the token; bind terms through act (e.g. a hash of them), which the token carries.
1 - 90"Trade with sam_k — 2 GA for $180"
Response
Verification link created. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes for this operation: 400 (partner not found / gate not active), 401, 403 (gate not in the token allowlist), 409 (pending request already exists — call revoke-verification). BotShield Actions and linking codes (data.error.code): act_label_without_act (400), action_not_a_gate (400), action_invalid (400 — act malformed), action_not_found (400 — no action with that key here), action_off (409), action_requires_user_ref (400), link_requires_user_ref (400 — the gate's policy is link: required and no partner_user_ref was sent).
