Collect Automation Intelligence.

curl --request POST \
  --url https://api.fpjs.io/v4/edge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "headers": [
    {
      "name": "User-Agent",
      "value": "Mozilla/5.0 (Local Test Bot)"
    },
    {
      "name": "Host",
      "value": "example.com"
    },
    {
      "name": "Signature-Agent",
      "value": "\"https://chatgpt.com\""
    },
    {
      "name": "Signature-Input",
      "value": "binding0=(\"@authority\" \"signature-agent\");created=1769022347;keyid=\"otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg\";alg=\"ed25519\";expires=1769022407;tag=\"web-bot-auth\""
    },
    {
      "name": "Signature",
      "value": "binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:"
    }
  ],
  "method": "POST",
  "url": "https://example.com/login?foo=bar",
  "ipv4_address": "34.162.244.71"
}
'

import requests

url = "https://api.fpjs.io/v4/edge"

payload = {
    "headers": [
        {
            "name": "User-Agent",
            "value": "Mozilla/5.0 (Local Test Bot)"
        },
        {
            "name": "Host",
            "value": "example.com"
        },
        {
            "name": "Signature-Agent",
            "value": "\"https://chatgpt.com\""
        },
        {
            "name": "Signature-Input",
            "value": "binding0=(\"@authority\" \"signature-agent\");created=1769022347;keyid=\"otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg\";alg=\"ed25519\";expires=1769022407;tag=\"web-bot-auth\""
        },
        {
            "name": "Signature",
            "value": "binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:"
        }
    ],
    "method": "POST",
    "url": "https://example.com/login?foo=bar",
    "ipv4_address": "34.162.244.71"
}
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({
    headers: [
      {name: 'User-Agent', value: 'Mozilla/5.0 (Local Test Bot)'},
      {name: 'Host', value: 'example.com'},
      {name: 'Signature-Agent', value: '"https://chatgpt.com"'},
      {
        name: 'Signature-Input',
        value: 'binding0=("@authority" "signature-agent");created=1769022347;keyid="otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg";alg="ed25519";expires=1769022407;tag="web-bot-auth"'
      },
      {
        name: 'Signature',
        value: 'binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:'
      }
    ],
    method: 'POST',
    url: 'https://example.com/login?foo=bar',
    ipv4_address: '34.162.244.71'
  })
};

fetch('https://api.fpjs.io/v4/edge', 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.fpjs.io/v4/edge",
  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([
    'headers' => [
        [
                'name' => 'User-Agent',
                'value' => 'Mozilla/5.0 (Local Test Bot)'
        ],
        [
                'name' => 'Host',
                'value' => 'example.com'
        ],
        [
                'name' => 'Signature-Agent',
                'value' => '"https://chatgpt.com"'
        ],
        [
                'name' => 'Signature-Input',
                'value' => 'binding0=("@authority" "signature-agent");created=1769022347;keyid="otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg";alg="ed25519";expires=1769022407;tag="web-bot-auth"'
        ],
        [
                'name' => 'Signature',
                'value' => 'binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:'
        ]
    ],
    'method' => 'POST',
    'url' => 'https://example.com/login?foo=bar',
    'ipv4_address' => '34.162.244.71'
  ]),
  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.fpjs.io/v4/edge"

	payload := strings.NewReader("{\n  \"headers\": [\n    {\n      \"name\": \"User-Agent\",\n      \"value\": \"Mozilla/5.0 (Local Test Bot)\"\n    },\n    {\n      \"name\": \"Host\",\n      \"value\": \"example.com\"\n    },\n    {\n      \"name\": \"Signature-Agent\",\n      \"value\": \"\\\"https://chatgpt.com\\\"\"\n    },\n    {\n      \"name\": \"Signature-Input\",\n      \"value\": \"binding0=(\\\"@authority\\\" \\\"signature-agent\\\");created=1769022347;keyid=\\\"otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg\\\";alg=\\\"ed25519\\\";expires=1769022407;tag=\\\"web-bot-auth\\\"\"\n    },\n    {\n      \"name\": \"Signature\",\n      \"value\": \"binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:\"\n    }\n  ],\n  \"method\": \"POST\",\n  \"url\": \"https://example.com/login?foo=bar\",\n  \"ipv4_address\": \"34.162.244.71\"\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.fpjs.io/v4/edge")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"headers\": [\n    {\n      \"name\": \"User-Agent\",\n      \"value\": \"Mozilla/5.0 (Local Test Bot)\"\n    },\n    {\n      \"name\": \"Host\",\n      \"value\": \"example.com\"\n    },\n    {\n      \"name\": \"Signature-Agent\",\n      \"value\": \"\\\"https://chatgpt.com\\\"\"\n    },\n    {\n      \"name\": \"Signature-Input\",\n      \"value\": \"binding0=(\\\"@authority\\\" \\\"signature-agent\\\");created=1769022347;keyid=\\\"otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg\\\";alg=\\\"ed25519\\\";expires=1769022407;tag=\\\"web-bot-auth\\\"\"\n    },\n    {\n      \"name\": \"Signature\",\n      \"value\": \"binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:\"\n    }\n  ],\n  \"method\": \"POST\",\n  \"url\": \"https://example.com/login?foo=bar\",\n  \"ipv4_address\": \"34.162.244.71\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fpjs.io/v4/edge")

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  \"headers\": [\n    {\n      \"name\": \"User-Agent\",\n      \"value\": \"Mozilla/5.0 (Local Test Bot)\"\n    },\n    {\n      \"name\": \"Host\",\n      \"value\": \"example.com\"\n    },\n    {\n      \"name\": \"Signature-Agent\",\n      \"value\": \"\\\"https://chatgpt.com\\\"\"\n    },\n    {\n      \"name\": \"Signature-Input\",\n      \"value\": \"binding0=(\\\"@authority\\\" \\\"signature-agent\\\");created=1769022347;keyid=\\\"otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg\\\";alg=\\\"ed25519\\\";expires=1769022407;tag=\\\"web-bot-auth\\\"\"\n    },\n    {\n      \"name\": \"Signature\",\n      \"value\": \"binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:\"\n    }\n  ],\n  \"method\": \"POST\",\n  \"url\": \"https://example.com/login?foo=bar\",\n  \"ipv4_address\": \"34.162.244.71\"\n}"

response = http.request(request)
puts response.read_body

{
  "event_id": "1758130560902.8tRtrH",
  "timestamp": 1758130560902,
  "source": "edge",
  "url": "https://example.com/login?foo=bar",
  "bot_info": {
    "category": "ai_agent",
    "provider": "OpenAI",
    "provider_url": "https://openai.com",
    "name": "ChatGPT Agent",
    "identity": "signed",
    "confidence": "high"
  },
  "ip_info": {
    "v4": {
      "address": "104.210.139.192",
      "geolocation": {
        "accuracy_radius": 20,
        "latitude": 29.42412,
        "longitude": -98.49363,
        "postal_code": "78205",
        "timezone": "America/Chicago",
        "city_name": "San Antonio",
        "country_code": "US",
        "country_name": "United States",
        "continent_code": "NA",
        "continent_name": "North America",
        "subdivisions": [
          {
            "iso_code": "TX",
            "name": "Texas"
          }
        ]
      },
      "asn": "8075",
      "asn_name": "Microsoft Corporation",
      "asn_network": "104.208.0.0/13",
      "asn_type": "hosting",
      "datacenter_result": true,
      "datacenter_name": "Microsoft Azure"
    }
  },
  "proxy": false,
  "proxy_confidence": "high",
  "vpn": false,
  "vpn_confidence": "medium",
  "vpn_methods": {
    "public_vpn": false,
    "relay": false
  }
}

Automation Intelligence API

Collect Intelligence

The Automation Intelligence API gives you the tools to determine whether traffic is legitimate and should be accepted by your application.

This feature is currently in a Public Preview testing phase. All feedback is welcome! If you encounter any issues, please contact our support team.

The API detects automation tools like AI Agents, AI Assistants, AI Browsers, and other bots. Additionally, it provides IP intelligence like geolocation, residential proxy, VPN and data center detection.

Automation Intelligence is derived from HTTP request metadata that reaches your server. It does not require the use of a JavaScript client-side agent or mobile SDKs to collect device context.

The API is fast, with average response times of less than 30ms, making it a great fit for edge, pre-origin or middleware contexts. The API is platform-agnostic and can be used with different CDN providers, cloud platforms, or any server backend.

Because this API doesn’t require the use of a client-side device collection agent, it doesn’t support device identification via visitor_id and a few Smart Signals derived from deep device telemetry.

Event Retrieval

Events created by the Automation Intelligence API can be fetched via the /v4/events/{event_id} API using the event_id present in the API response.

Fetch all Automation Intelligence API events via the /v4/events?source=edge API.

POST

edge

Collect Automation Intelligence.

curl --request POST \
  --url https://api.fpjs.io/v4/edge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "headers": [
    {
      "name": "User-Agent",
      "value": "Mozilla/5.0 (Local Test Bot)"
    },
    {
      "name": "Host",
      "value": "example.com"
    },
    {
      "name": "Signature-Agent",
      "value": "\"https://chatgpt.com\""
    },
    {
      "name": "Signature-Input",
      "value": "binding0=(\"@authority\" \"signature-agent\");created=1769022347;keyid=\"otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg\";alg=\"ed25519\";expires=1769022407;tag=\"web-bot-auth\""
    },
    {
      "name": "Signature",
      "value": "binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:"
    }
  ],
  "method": "POST",
  "url": "https://example.com/login?foo=bar",
  "ipv4_address": "34.162.244.71"
}
'

import requests

url = "https://api.fpjs.io/v4/edge"

payload = {
    "headers": [
        {
            "name": "User-Agent",
            "value": "Mozilla/5.0 (Local Test Bot)"
        },
        {
            "name": "Host",
            "value": "example.com"
        },
        {
            "name": "Signature-Agent",
            "value": "\"https://chatgpt.com\""
        },
        {
            "name": "Signature-Input",
            "value": "binding0=(\"@authority\" \"signature-agent\");created=1769022347;keyid=\"otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg\";alg=\"ed25519\";expires=1769022407;tag=\"web-bot-auth\""
        },
        {
            "name": "Signature",
            "value": "binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:"
        }
    ],
    "method": "POST",
    "url": "https://example.com/login?foo=bar",
    "ipv4_address": "34.162.244.71"
}
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({
    headers: [
      {name: 'User-Agent', value: 'Mozilla/5.0 (Local Test Bot)'},
      {name: 'Host', value: 'example.com'},
      {name: 'Signature-Agent', value: '"https://chatgpt.com"'},
      {
        name: 'Signature-Input',
        value: 'binding0=("@authority" "signature-agent");created=1769022347;keyid="otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg";alg="ed25519";expires=1769022407;tag="web-bot-auth"'
      },
      {
        name: 'Signature',
        value: 'binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:'
      }
    ],
    method: 'POST',
    url: 'https://example.com/login?foo=bar',
    ipv4_address: '34.162.244.71'
  })
};

fetch('https://api.fpjs.io/v4/edge', 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.fpjs.io/v4/edge",
  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([
    'headers' => [
        [
                'name' => 'User-Agent',
                'value' => 'Mozilla/5.0 (Local Test Bot)'
        ],
        [
                'name' => 'Host',
                'value' => 'example.com'
        ],
        [
                'name' => 'Signature-Agent',
                'value' => '"https://chatgpt.com"'
        ],
        [
                'name' => 'Signature-Input',
                'value' => 'binding0=("@authority" "signature-agent");created=1769022347;keyid="otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg";alg="ed25519";expires=1769022407;tag="web-bot-auth"'
        ],
        [
                'name' => 'Signature',
                'value' => 'binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:'
        ]
    ],
    'method' => 'POST',
    'url' => 'https://example.com/login?foo=bar',
    'ipv4_address' => '34.162.244.71'
  ]),
  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.fpjs.io/v4/edge"

	payload := strings.NewReader("{\n  \"headers\": [\n    {\n      \"name\": \"User-Agent\",\n      \"value\": \"Mozilla/5.0 (Local Test Bot)\"\n    },\n    {\n      \"name\": \"Host\",\n      \"value\": \"example.com\"\n    },\n    {\n      \"name\": \"Signature-Agent\",\n      \"value\": \"\\\"https://chatgpt.com\\\"\"\n    },\n    {\n      \"name\": \"Signature-Input\",\n      \"value\": \"binding0=(\\\"@authority\\\" \\\"signature-agent\\\");created=1769022347;keyid=\\\"otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg\\\";alg=\\\"ed25519\\\";expires=1769022407;tag=\\\"web-bot-auth\\\"\"\n    },\n    {\n      \"name\": \"Signature\",\n      \"value\": \"binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:\"\n    }\n  ],\n  \"method\": \"POST\",\n  \"url\": \"https://example.com/login?foo=bar\",\n  \"ipv4_address\": \"34.162.244.71\"\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.fpjs.io/v4/edge")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"headers\": [\n    {\n      \"name\": \"User-Agent\",\n      \"value\": \"Mozilla/5.0 (Local Test Bot)\"\n    },\n    {\n      \"name\": \"Host\",\n      \"value\": \"example.com\"\n    },\n    {\n      \"name\": \"Signature-Agent\",\n      \"value\": \"\\\"https://chatgpt.com\\\"\"\n    },\n    {\n      \"name\": \"Signature-Input\",\n      \"value\": \"binding0=(\\\"@authority\\\" \\\"signature-agent\\\");created=1769022347;keyid=\\\"otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg\\\";alg=\\\"ed25519\\\";expires=1769022407;tag=\\\"web-bot-auth\\\"\"\n    },\n    {\n      \"name\": \"Signature\",\n      \"value\": \"binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:\"\n    }\n  ],\n  \"method\": \"POST\",\n  \"url\": \"https://example.com/login?foo=bar\",\n  \"ipv4_address\": \"34.162.244.71\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fpjs.io/v4/edge")

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  \"headers\": [\n    {\n      \"name\": \"User-Agent\",\n      \"value\": \"Mozilla/5.0 (Local Test Bot)\"\n    },\n    {\n      \"name\": \"Host\",\n      \"value\": \"example.com\"\n    },\n    {\n      \"name\": \"Signature-Agent\",\n      \"value\": \"\\\"https://chatgpt.com\\\"\"\n    },\n    {\n      \"name\": \"Signature-Input\",\n      \"value\": \"binding0=(\\\"@authority\\\" \\\"signature-agent\\\");created=1769022347;keyid=\\\"otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg\\\";alg=\\\"ed25519\\\";expires=1769022407;tag=\\\"web-bot-auth\\\"\"\n    },\n    {\n      \"name\": \"Signature\",\n      \"value\": \"binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:\"\n    }\n  ],\n  \"method\": \"POST\",\n  \"url\": \"https://example.com/login?foo=bar\",\n  \"ipv4_address\": \"34.162.244.71\"\n}"

response = http.request(request)
puts response.read_body

{
  "event_id": "1758130560902.8tRtrH",
  "timestamp": 1758130560902,
  "source": "edge",
  "url": "https://example.com/login?foo=bar",
  "bot_info": {
    "category": "ai_agent",
    "provider": "OpenAI",
    "provider_url": "https://openai.com",
    "name": "ChatGPT Agent",
    "identity": "signed",
    "confidence": "high"
  },
  "ip_info": {
    "v4": {
      "address": "104.210.139.192",
      "geolocation": {
        "accuracy_radius": 20,
        "latitude": 29.42412,
        "longitude": -98.49363,
        "postal_code": "78205",
        "timezone": "America/Chicago",
        "city_name": "San Antonio",
        "country_code": "US",
        "country_name": "United States",
        "continent_code": "NA",
        "continent_name": "North America",
        "subdivisions": [
          {
            "iso_code": "TX",
            "name": "Texas"
          }
        ]
      },
      "asn": "8075",
      "asn_name": "Microsoft Corporation",
      "asn_network": "104.208.0.0/13",
      "asn_type": "hosting",
      "datacenter_result": true,
      "datacenter_name": "Microsoft Azure"
    }
  },
  "proxy": false,
  "proxy_confidence": "high",
  "vpn": false,
  "vpn_confidence": "medium",
  "vpn_methods": {
    "public_vpn": false,
    "relay": false
  }
}

Authorizations

Authorization

string

header

required

Add your Secret API Key to the Authorization header using the standard Bearer format: Authorization: Bearer <secret_api_key>

Body

application/json

HTTP request metadata (including the HTTP method, headers and IP address) sent by you (your server) to the Fingerprint API for IP and bot analysis. To improve accuracy, retain as much of the original semantics of the HTTP request as possible. For example, preserve the order of the request headers and their capitalization. At least one of ipv4_address or ipv6_address must be provided; a request with neither is rejected with a 400 error. If both IPv4 and IPv6 are provided, IP intelligence will be provided for each address. If an IPv4-mapped IPv6 address is provided in the ipv6_address request property, the IP intelligence will be provided in the ipv4_address property of the response.

headers

object[]

required

Ordered header entries from the request made to your server. Each entry represents one header line. If one header name appears as multiple lines, send each as a separate item in the array.

Headers that contain authentication or session data must still be included, but with with their value set to an empty string. This includes headers like Authorization and Cookie, but may contain more depending on your specific project, for instance Proxy-Authenticate or X-Api-Key. Omitting the headers entirely changes the shape of the request and can affect detection. Never forward the real secret values.

Whenever possible, we recommend preserving header order and capitalization to provide the best accuracy, however it’s not a strict requirement if your runtime does not maintain http header order or canonicalizes header names.

Minimum array length: 1

Show child attributes

Examples:

[
  { "name": "Host", "value": "example.com" },
  {
    "name": "User-Agent",
    "value": "Mozilla/5.0"
  },
  {
    "name": "Accept-Language",
    "value": "en-US,en;q=0.9"
  }
]

[
  { "name": "Host", "value": "example.com" },
  {
    "name": "User-Agent",
    "value": "Mozilla/5.0"
  },
  {
    "name": "Accept-Encoding",
    "value": "gzip"
  },
  {
    "name": "Accept-Encoding",
    "value": "deflate"
  }
]

method

string

required

The original HTTP method of the request. If supported in your runtime, preserve the original casing.

Examples:

"GET"

"POST"

"PUT"

"PATCH"

"DELETE"

url

string<uri>

required

Absolute URL of the request, without a #fragment suffix. Only HTTP and HTTPS schemes are supported.

Examples:

"http://example.com"

"https://example.com/checkout?method=card"

ipv4_address

string<ipv4>

Client IPv4 address observed by your server.

Examples:

"34.162.244.71"

"3.208.0.3"

"173.56.0.4"

ipv6_address

string<ipv6>

Client IPv6 address observed by your server.

Examples:

"2001:4860:4801:10::1"

"2600:1f42:abcd:5678:9876:fedc:1357:2468"

"2001:4868:85f:1a2b:3c4d:5e6f:7890:abcd"

"::ffff:22a2:f447"

"::ffff:34.162.244.71"

linked_id

string

A customer-provided id that was sent with the request.

Example:

"somelinkedId"

Response

OK.

IP and bot analysis for a request submitted through the Automation Intelligence API.

event_id

string

required

Unique identifier of the user's request. The first portion of the event_id is a unix epoch milliseconds timestamp.

Example:

"1708102555327.NLOjmg"

timestamp

integer<int64>

required

Timestamp of the event with millisecond precision in Unix time.

Example:

1708102555327

ip_info

object

required

Details about the request IP address. Has separate fields for v4 and v6 IP address versions.

Show child attributes

source

enum<string>

Identifies how the event was generated.

device - the event was generated by the JS agent or a mobile SDK running on an end-user device.
edge - the event was generated by the Automation Intelligence API (/edge endpoint), analyzing a request intercepted at the edge.

Available options:

device,

edge

linked_id

string

A customer-provided id that was sent with the request.

Example:

"somelinkedId"

JavaScript Agent

Server API

Automation Intelligence API

Policy and Upgrades

Device Reputation Network API

Management API

Server SDKs

Collect Intelligence

Event Retrieval

Authorizations

Body

Response