Fraudulent Rule Search

POSThttps://api.deepinfo.com/v1/brp/fraudulent-rules/search

Searches your fraudulent rules.

Example

Request

curl

curl -X POST 'https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page_size=25' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'

Python

import requests

url = "https://api.deepinfo.com/v1/brp/fraudulent-rules/search"

params = {
    "page_size": "25"
}

headers = {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
}

payload = {}

response = requests.post(url, params=params, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

JavaScript

const url = "https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page_size=25";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({}),
});

const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	payload := strings.NewReader(`{}`)

	req, err := http.NewRequest("POST", "https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page_size=25", payload)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(body))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page_size=25"))
            .header("apikey", "YOUR_API_KEY")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString("{}"))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page_size=25");
request.Headers.Add("apikey", "YOUR_API_KEY");
request.Headers.Add("Accept", "application/json");
request.Content = new StringContent("{}", Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page_size=25',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'apikey: YOUR_API_KEY',
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{}',
]);

$response = curl_exec($curl);

if ($response === false) {
    throw new RuntimeException(curl_error($curl));
}

echo $response . PHP_EOL;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page_size=25')

request = Net::HTTP::Post.new(uri)
request['apikey'] = 'YOUR_API_KEY'
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = '{}'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

puts response.body

Response

200 OK · application/json

Response Body

{
  "page": 1,
  "page_size": 25,
  "result_count": 21,
  "results": [
    {
      "id": "000000000000000e8e040001",
      "name": "Brand name",
      "filters": {
        "match_type": "contains"
      },
      "detected_fraudulent_count": 37,
      "tags": [],
      "enabled": true,
      "create_date": "2025-06-01T08:00:00Z",
      "last_update_date": "2025-07-01T08:00:00Z"
    },
    {
      "id": "000000000000000e8e040002",
      "name": "Product names",
      "filters": {
        "match_type": "contains"
      },
      "detected_fraudulent_count": 38,
      "tags": [],
      "enabled": true,
      "create_date": "2025-05-25T08:00:00Z",
      "last_update_date": "2025-06-24T08:00:00Z"
    }
  ]
}

Content-Type: application/json
deepinfo-request-id: 00000000-0000-4000-8000-0000356d0001

Request

curl

curl -X POST 'https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page=0' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'

Python

import requests

url = "https://api.deepinfo.com/v1/brp/fraudulent-rules/search"

params = {
    "page": "0"
}

headers = {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
}

payload = {}

response = requests.post(url, params=params, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

JavaScript

const url = "https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page=0";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({}),
});

const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	payload := strings.NewReader(`{}`)

	req, err := http.NewRequest("POST", "https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page=0", payload)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(body))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page=0"))
            .header("apikey", "YOUR_API_KEY")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString("{}"))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page=0");
request.Headers.Add("apikey", "YOUR_API_KEY");
request.Headers.Add("Accept", "application/json");
request.Content = new StringContent("{}", Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page=0',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'apikey: YOUR_API_KEY',
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{}',
]);

$response = curl_exec($curl);

if ($response === false) {
    throw new RuntimeException(curl_error($curl));
}

echo $response . PHP_EOL;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.deepinfo.com/v1/brp/fraudulent-rules/search?page=0')

request = Net::HTTP::Post.new(uri)
request['apikey'] = 'YOUR_API_KEY'
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = '{}'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

puts response.body

Response

400 Bad Request · application/json

Response Body

{
  "code": 10400,
  "parameters": [
    {
      "param": "page",
      "details": [
        "Ensure this value is greater than or equal to 1."
      ]
    }
  ],
  "solution": "https://docs.deepinfo.com/reference/"
}

Content-Type: application/json
deepinfo-request-id: 00000000-0000-4000-8000-0000356d0001

Authentication

Send your API key in the apikey request header.

Query Parameters

Parameter	Required	Description
`page_size`	Optional	Min `25`, max `100`. Default `100`. Example`25`
`page`	Optional	Min `1`, max `800`. Default `1`. Example`1`

Request Body

Parameter	Type	Required	Description
`filters`	object	Optional	See Filtering below
`sort`	object	Optional	One `{field, order}` object

application/json

{}

This search takes filters as an object with one key per field, not as a must list. Each field takes the operators of its filter type as keys, and fields combine with AND. sort is one {field, order} object, not a list. Example body:

JSON

{
  "filters": {
    "name": {
      "equals": [
        "<value>"
      ]
    }
  },
  "sort": {
    "field": "name",
    "order": "desc"
  }
}

Operators by field:

Field	Operators
`name`	`equals`, `not_equals`, `contains`, `not_contains`, `startswith`, `endswith`; each takes a list of values
`filters.match_type`	`equals`, `not_equals`; each takes a list of values
`detected_fraudulent_count`	`gt`, `gte`, `lt`, `lte`
`tags`	`equals`, `not_equals`, `contains`, `not_contains`, `startswith`, `endswith`; each takes a list of values
`enabled`	a plain boolean value
`create_date`	`gt`, `gte`, `lt`, `lte`
`last_update_date`	`gt`, `gte`, `lt`, `lte`

Searchable Fields

Field	Description
`name`	The fraudulent domain rule's name, as you gave it.
`filters.match_type`	How the rule matches domain names to its keyword: `exact`, `contains`, `fuzzy`, `fuzzy_contains` or a `confusable_*` variant (look-alike characters). It sits in a nested `filters` object: `{"filters": {"filters": {"match_type": {"equals": ["contains"]}}}}`.
`detected_fraudulent_count`	How many fraudulent domains the rule has detected.
`tags`	The tags on the rule.
`enabled`	`true` for rules that are switched on, `false` for rules that are switched off.
`create_date`	When the rule was created (ISO 8601 date-time).
`last_update_date`	When the rule was last changed (ISO 8601 date-time).

Sortable Fields

Field	Description
`name`	The fraudulent domain rule's name, as you gave it.
`filters_match_type`	The rule's match type (`filters.match_type` in the response), for sorting.
`detected_fraudulent_count`	How many fraudulent domains the rule has detected.
`tags`	The tags on the rule.
`enabled`	`true` for rules that are switched on, `false` for rules that are switched off.
`create_date`	When the rule was created (ISO 8601 date-time).
`last_update_date`	When the rule was last changed (ISO 8601 date-time).

Response Fields

Field	Type	Description
`page`	integer
`page_size`	integer
`result_count`	integer
`results`	array of object
`results[].id`	string
`results[].name`	string
`results[].filters`	object
`results[].detected_fraudulent_count`	integer
`results[].tags`	array of string
`results[].enabled`	boolean
`results[].create_date`	string	date-time
`results[].last_update_date`	string	date-time

Paginated. See Getting Started → Pagination.

Response Schema

Inferred from examples Built from the saved 2xx example response: the fields it contains, with the types seen there. It is not a contract.

Field	Type	Example
`page`	number	`1`
`page_size`	number	`25`
`result_count`	number	`21`
`results`	array<object>
`results[].id`	string	`"000000000000000e8e040001"`
`results[].name`	string	`"Brand name"`
`results[].filters`	object
`results[].filters.match_type`	string	`"contains"`
`results[].detected_fraudulent_count`	number	`37`
`results[].tags`	array
`results[].enabled`	boolean	`true`
`results[].create_date`	string	`"2025-06-01T08:00:00Z"`
`results[].last_update_date`	string	`"2025-07-01T08:00:00Z"`

Examples

Selecting one loads it into the request and response panels.

Reference updated September 27, 2026