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 '
{
"return_url": "<string>",
"webhook_url": "<string>",
"scope": "<string>",
"mode": "linked-account",
"signal_token": "<string>",
"metadata": {}
}
'import requests
url = "https://api.botshield.ai/operations/sdk/create-verification-link"
payload = {
"return_url": "<string>",
"webhook_url": "<string>",
"scope": "<string>",
"mode": "linked-account",
"signal_token": "<string>",
"metadata": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
return_url: '<string>',
webhook_url: '<string>',
scope: '<string>',
mode: 'linked-account',
signal_token: '<string>',
metadata: {}
})
};
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([
'return_url' => '<string>',
'webhook_url' => '<string>',
'scope' => '<string>',
'mode' => 'linked-account',
'signal_token' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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 \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"scope\": \"<string>\",\n \"mode\": \"linked-account\",\n \"signal_token\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"scope\": \"<string>\",\n \"mode\": \"linked-account\",\n \"signal_token\": \"<string>\",\n \"metadata\": {}\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"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"scope\": \"<string>\",\n \"mode\": \"linked-account\",\n \"signal_token\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}SDK Operations
Create a verification request
Creates a verification request with deep link, web URL, and QR code. Requires an anchor grant token from create-session.
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 '
{
"return_url": "<string>",
"webhook_url": "<string>",
"scope": "<string>",
"mode": "linked-account",
"signal_token": "<string>",
"metadata": {}
}
'import requests
url = "https://api.botshield.ai/operations/sdk/create-verification-link"
payload = {
"return_url": "<string>",
"webhook_url": "<string>",
"scope": "<string>",
"mode": "linked-account",
"signal_token": "<string>",
"metadata": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
return_url: '<string>',
webhook_url: '<string>',
scope: '<string>',
mode: 'linked-account',
signal_token: '<string>',
metadata: {}
})
};
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([
'return_url' => '<string>',
'webhook_url' => '<string>',
'scope' => '<string>',
'mode' => 'linked-account',
'signal_token' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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 \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"scope\": \"<string>\",\n \"mode\": \"linked-account\",\n \"signal_token\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"scope\": \"<string>\",\n \"mode\": \"linked-account\",\n \"signal_token\": \"<string>\",\n \"metadata\": {}\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"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"scope\": \"<string>\",\n \"mode\": \"linked-account\",\n \"signal_token\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Authorizations
API key with Bearer prefix (e.g., 'Bearer bs_live_sk_...' or 'Bearer pk_live_...')
Body
application/json
Available options:
signal, presence linked-account = OAuth+passkey, private = direct WebAuthn (no PII)
Available options:
linked-account, private Tamper-proof Signal Pixel token (bs_sig_...) for server-side score correlation
Response
Verification link created
Show child attributes
Show child attributes
⌘I