Password Breaches

POST

api

agent

password-breaches

Password Breaches

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

import requests

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

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

fetch('https://encrata.com/api/agent/password-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/password-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([
    'password' => '<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/password-breaches"

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

require 'uri'
require 'net/http'

url = URI("https://encrata.com/api/agent/password-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  \"password\": \"<string>\"\n}"

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

Overview

Password Breaches tells you whether a password has appeared in known data breaches, and how many times, without ever transmitting or storing the plaintext password. It’s built for a sign-up / password-reset guard: warn a user when the password they chose has already leaked and prompt them to pick a different one. It uses the k-anonymity model on top of Have I Been Pwned’s Pwned Passwords corpus: the password is SHA-1 hashed and only the first 5 hex characters of the hash are ever sent to the upstream service. There are three ways to run it:

Agent API (POST /api/agent/password-breaches): the API-key endpoint documented on this page, for programmatic access (e.g. your sign-up backend).
In-app (POST /api/password/breaches): the session-authenticated endpoint used by the dashboard, where the browser hashes the password first.
Bulk (POST /api/password/breaches/bulk): check up to 1,000 passwords in one request.

The plaintext password is never stored. History records only a masked label (a dotted mask plus the 5-char hash prefix), never the password or its full hash.

Request

string

The raw password to check. Hashed server-side (SHA-1) immediately and never stored; only the 5-char hash prefix leaves the server.

For production, prefer sending a pre-computed hash instead of the raw password: pass sha1 (upper-case hex SHA-1 of the password) in place of password, so the plaintext never leaves the caller. Provide exactly one of password or sha1.

curl -X POST "https://encrata.com/api/agent/password-breaches" \
  -H "Authorization: Bearer $ENCRATA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sha1": "5BAA61E4C9B93F3F0682250B6CF8331B7EE68FD8"}'

Response

{
  "prefix": "5BAA6",
  "found": true,
  "count": 52372427,
  "credits": 1
}

Field	Type	Description
`prefix`	string	The 5-char SHA-1 hash prefix used for the k-anonymity query.
`found`	boolean	Whether the password appears in any known breach.
`count`	integer	How many times the password has been seen across breaches.
`credits`	integer	Credits charged (always 1).

Bulk

POST /api/password/breaches/bulk accepts sha1s (array of hashes) or passwords (array of raw passwords), up to 1,000 entries, and charges 1 credit per unique password:

{
  "total": 3,
  "breached": 3,
  "results": [
    { "prefix": "5BAA6", "found": true, "count": 52372427 },
    { "prefix": "B1B37", "found": true, "count": 30812897 },
    { "prefix": "AAF4C", "found": true, "count": 1189270 }
  ],
  "credits": 3
}

Cost

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

Enterprise / async bulk (up to 1M)

For large lists (banks, enterprises), use the async job pipeline instead of the synchronous bulk endpoint. The browser SHA-1 hashes every password first, so the uploaded input is a list of hashes, and plaintext never reaches the server.

POST /api/password-jobs: body { "sha1s": ["<40-hex>", ...], "file_name": "list.txt" } (up to 1,000,000). Returns a job { id, status, total, ... }.
GET /api/password-jobs?id=<id>: poll live status + counts (processed_count, breached_count).
GET /api/password-jobs/results?id=<id>&page=&page_size=&breached=1: paginated result rows ({ line_no, prefix, found, count }).
GET /api/password-jobs/download?id=<id>&breached=1: stream the full results as CSV.
POST /api/password-jobs/cancel?id=<id>: cancel an in-flight job.

Jobs are processed by background workers in resumable chunks, so a 1M-row job runs reliably without a long-held HTTP request. 1 credit is charged per password.

Check Breaches

Bulk Lookup

Password Breaches

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

import requests

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

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

fetch('https://encrata.com/api/agent/password-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/password-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([
    'password' => '<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/password-breaches"

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

require 'uri'
require 'net/http'

url = URI("https://encrata.com/api/agent/password-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  \"password\": \"<string>\"\n}"

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

Overview

Email Lookup

Bulk Operations

Workflows

Monitors

Contact Lists

API Keys

Webhooks

Resources

Password Breaches

Overview

Request

Response

Bulk

Cost

Enterprise / async bulk (up to 1M)

​Overview

​Request

​Response

​Bulk

​Cost

​Enterprise / async bulk (up to 1M)

Overview

Request

Response

Bulk

Cost

Enterprise / async bulk (up to 1M)