Phone Breaches

POST

api

agent

phone-breaches

Phone Breaches

curl --request POST \
  --url https://encrata.com/api/agent/phone-breaches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>"
}
'

import requests

url = "https://encrata.com/api/agent/phone-breaches"

payload = { "query": "<string>" }
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({query: '<string>'})
};

fetch('https://encrata.com/api/agent/phone-breaches', 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://encrata.com/api/agent/phone-breaches",
  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([
    'query' => '<string>'
  ]),
  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://encrata.com/api/agent/phone-breaches"

	payload := strings.NewReader("{\n  \"query\": \"<string>\"\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://encrata.com/api/agent/phone-breaches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://encrata.com/api/agent/phone-breaches")

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  \"query\": \"<string>\"\n}"

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

Overview

Phone Breaches tells you whether a phone number has been exposed in known data breaches, and how many times. Use it to flag high-risk numbers during sign-up, account recovery, or fraud review. There are three ways to run it:

Agent API (POST /api/agent/phone-breaches): the API-key endpoint documented on this page, for programmatic access.
In-app (POST /api/phone/breaches): the session-authenticated endpoint used by the dashboard. First lookup of a number costs 1 credit; repeats of the same number are free for the same customer for six months.
Bulk (POST /api/phone-jobs with {"feature": "breaches"}): enqueue an async job that checks up to 1,000,000 numbers with background workers; poll GET /api/phone-jobs?id=<id> for progress and download results as CSV.

Authentication

Requires an API key in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Request

string

required

The phone number to check. Include the country code (e.g. +14155552671).

Example request

curl -X POST "https://encrata.com/api/agent/phone-breaches" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "+14155552671"}'

import requests

resp = requests.post(
    "https://encrata.com/api/agent/phone-breaches",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"query": "+14155552671"},
)
print(resp.json())

Response

{
  "phone": "+14155552671",
  "breached": true,
  "total_breaches": 3,
  "first_breached": "2016-05-01",
  "last_breached": "2021-11-01",
  "summary": "Exposed in 3 known data breaches",
  "credits": 1
}

Field	Type	Description
`phone`	string	The normalized (E.164) phone number that was checked.
`breached`	boolean	Whether the number appears in any known breach.
`total_breaches`	integer	How many known breaches the number appears in.
`first_breached`	string	Date the number was first seen in a breach (if known).
`last_breached`	string	Date the number was most recently seen in a breach (if known).
`summary`	string	A human-readable one-line verdict.
`credits`	integer	Credits charged (always 1).

Cost

1 credit per number checked (single and per-number in bulk).

Phone Breaches

curl --request POST \
  --url https://encrata.com/api/agent/phone-breaches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>"
}
'

import requests

url = "https://encrata.com/api/agent/phone-breaches"

payload = { "query": "<string>" }
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({query: '<string>'})
};

fetch('https://encrata.com/api/agent/phone-breaches', 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://encrata.com/api/agent/phone-breaches",
  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([
    'query' => '<string>'
  ]),
  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://encrata.com/api/agent/phone-breaches"

	payload := strings.NewReader("{\n  \"query\": \"<string>\"\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://encrata.com/api/agent/phone-breaches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://encrata.com/api/agent/phone-breaches")

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  \"query\": \"<string>\"\n}"

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

Overview

Email Lookup

Bulk Operations

Workflows

Monitors

Contact Lists

API Keys

Webhooks

Resources

Overview

Authentication

Request

Example request

Response

Cost

​Overview

​Authentication

​Request

​Example request

​Response

​Cost

Overview

Authentication

Request

Example request

Response

Cost