Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Have I Been Pwned Domainverification API

The Domainverification API from Have I Been Pwned — 3 operation(s) for domainverification.

Have I Been Pwned Domainverification API is one of 16 APIs that Have I Been Pwned publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Domainverification. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against 2 base URLs: https://haveibeenpwned.com/api/v3, https://api.pwnedpasswords.com.

3 operations 3 paths 5 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://haveibeenpwned.com/api/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Have I Been Pwned Domainverification API declares 1 security scheme for authenticating requests. An API key is passed in the header as hibp-api-key (HibpApiKey).

  • HibpApiKey — HIBP API key passed in the hibp-api-key header. Paid APIs require a 32-character hexadecimal value. On supported test-only endpoints, any 32-character hexadeci…

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Domainverification 3
POST
/domainverification/generatednstoken
Generate a DNS verification token for a domain
1 param body → 200400401403
POST
/domainverification/verifydnstoken
Verify a DNS token for a domain
1 param body → 200400401403404
POST
/domainverification/sendemail
Send a domain verification approval email
1 param body → 200400401403

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Error (2 properties), DomainVerificationEmailRequest (2 properties), MessageOnlyError (1 property), DomainVerificationDnsTokenResponse (1 property). Each schema is shown below with its type and property counts.

DomainVerificationRequest
object
1 property 1 required
DomainVerificationDnsTokenResponse
object
1 property 1 required
DomainVerificationEmailRequest
object
2 properties 2 required
MessageOnlyError
object
Simple error response used by the domain-verification APIs.
1 property 1 required
Error
object
Standard error response returned by most authenticated HIBP APIs.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

have-i-been-pwned-domainverification-api-openapi.yml Raw ↑

Other APIs Have I Been Pwned publishes across the network.

Have I Been Pwned API v3
Pwned Passwords API
Have I Been Pwned Breach API
Have I Been Pwned Breachedaccount API
Have I Been Pwned Breacheddomain API
Have I Been Pwned Breaches API
Have I Been Pwned Dataclasses API
Have I Been Pwned Latestbreach API
Have I Been Pwned Pasteaccount API
Have I Been Pwned Range API
Have I Been Pwned Stealerlogsbyemail API
Have I Been Pwned Stealerlogsbyemaildomain API