Password Breach Checker

Overview

The password is hashed with SHA-1 on our side and only the first 5 characters of the hash are sent to the Pwned Passwords range API, with response padding on, so the password itself never leaves the request. It is not logged, stored or returned. You can also send the SHA-1 yourself so the plain password never reaches us.

Live Test Password Breach Checker API →

Endpoint

One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.

1
2
3
4
5
6

curl -X POST https://api.apiverve.com/v1/passwordbreach \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "password": "password123"
}'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

const res = await fetch('https://api.apiverve.com/v1/passwordbreach', {
  method: 'POST',
  headers: {
    'x-api-key': 'your_api_key_here',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "password": "password123"
}),
});

if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);

const { data } = await res.json();
console.log(data);

1
2
3
4
5
6
7
8
9
10
11
12
13

import requests

res = requests.post(
    "https://api.apiverve.com/v1/passwordbreach",
    headers={"x-api-key": "your_api_key_here"},
    json={
    "password": "password123"
},
    timeout=15,
)
res.raise_for_status()

print(res.json()["data"])

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

package main

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

func main() {
	body := strings.NewReader(`{
  "password": "password123"
}`)
	req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/passwordbreach", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("x-api-key", "your_api_key_here")

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

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.

Authentication

Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.

Parameters

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.

Response

Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.

1
2
3
4
5
6
7
8
9
10
11

{
  "status": "ok",
  "error": null,
  "data": {
    "breached": true,
    "breachCount": 2266543,
    "riskLevel": "critical",
    "inputType": "password",
    "hashPrefix": "CBFDA"
  }
}

Response fields

Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.

Use cases

Sign-Up and Password Change

Reject or warn on passwords that have appeared in breaches when a user creates an account or changes their password, as NIST SP 800-63B recommends.

Login Risk Scoring

Flag accounts whose current password is known to be breached and prompt a reset before credential stuffing finds them.

Password Audits

Check stored SHA-1 hashes from a legacy system against the breach corpus without handling plain passwords.

Password Managers

Mark saved passwords that have leaked so users know which ones to change first.

Other ways to use Password Breach Checker

Set up Password Breach Checker on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.

Related

More in Security: