`check_account`

Pack: hibp · Endpoint: https://gateway.pipeworx.io/hibp/mcp

Look up breaches an email account has been seen in. REQUIRES a paid HIBP subscription key (pass _apiKey). Returns the set of breach names; combine with get_breach for details.

Parameters

Name	Type	Required	Description
`account`	string	yes	Email address
`truncate`	boolean	no	Return only breach names (default true). Set false for full breach objects (counts as 1 query).

Example call

Arguments

{
  "account": "[email protected]",
  "_apiKey": "your-hibp-api-key"
}

curl

curl -X POST https://gateway.pipeworx.io/hibp/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"check_account","arguments":{"account":"[email protected]","_apiKey":"your-hibp-api-key"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('check_account', {
  "account": "[email protected]",
  "_apiKey": "your-hibp-api-key"
});

More examples

{
  "account": "[email protected]",
  "truncate": false,
  "_apiKey": "your-hibp-api-key"
}

Response shape

Always returns: account, pwned

Field	Type	Description
`account`	string	Email address checked
`pwned`	boolean	Whether account found in any breaches
`breach_names`	array	Breach names (when truncate=true)
`breaches`	array	Full breach objects (when truncate=false)

Full JSON Schema

{
  "type": "object",
  "properties": {
    "account": {
      "type": "string",
      "description": "Email address checked"
    },
    "pwned": {
      "type": "boolean",
      "description": "Whether account found in any breaches"
    },
    "breach_names": {
      "type": "array",
      "description": "Breach names (when truncate=true)",
      "items": {
        "type": "string"
      }
    },
    "breaches": {
      "type": "array",
      "description": "Full breach objects (when truncate=false)",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "description": "Unique breach name"
          },
          "title": {
            "type": [
              "string",
              "null"
            ],
            "description": "Human-readable breach title"
          },
          "domain": {
            "type": [
              "string",
              "null"
            ],
            "description": "Primary domain affected"
          },
          "breach_date": {
            "type": [
              "string",
              "null"
            ],
            "description": "Date breach occurred"
          },
          "added_date": {
            "type": [
              "string",
              "null"
            ],
            "description": "Date added to HIBP"
          },
          "modified_date": {
            "type": [
              "string",
              "null"
            ],
            "description": "Last modification date"
          },
          "pwn_count": {
            "type": [
              "number",
              "null"
            ],
            "description": "Number of affected accounts"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "Detailed breach description"
          },
          "data_classes": {
            "type": "array",
            "description": "Types of data exposed",
            "items": {
              "type": "string"
            }
          },
          "is_verified": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "Whether breach is verified"
          },
          "is_fabricated": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "Whether breach is fabricated"
          },
          "is_sensitive": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "Whether breach is sensitive"
          },
          "is_retired": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "Whether breach is retired"
          },
          "is_spam_list": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "Whether this is a spam list"
          },
          "is_malware": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "Whether malware was involved"
          },
          "logo_path": {
            "type": [
              "string",
              "null"
            ],
            "description": "Path to breach logo image"
          }
        },
        "required": [
          "name",
          "title",
          "domain",
          "breach_date",
          "added_date",
          "modified_date",
          "pwn_count",
          "description",
          "data_classes",
          "is_verified",
          "is_fabricated",
          "is_sensitive",
          "is_retired",
          "is_spam_list",
          "is_malware",
          "logo_path"
        ]
      }
    }
  },
  "required": [
    "account",
    "pwned"
  ]
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "hibp": {
      "url": "https://gateway.pipeworx.io/hibp/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

check_account