AegisIntel
API Reference & Integration Guide

AegisIntel API Documentation

Integrate AegisIntel public security checks and drop-in HIBP-compatible v3 breach intelligence endpoints using standard HTTP, OpenAPI 3.1, RFC 9457 error payloads, and IETF RateLimit headers.

Public Unauthenticated Endpoints (https://aegisintelai.com)

GET /api/public/breaches

Returns the indexed historical public breach catalog in JSON.

GET or POST /api/public/dmarc-check?domain=example.com

Audits public DNS SPF, DMARC, MX, DKIM posture and redacted breach hits.

GET /api/public/password-range/{prefix}

Queries 5-character SHA-1 k-Anonymity password hash suffixes with padded buckets.

POST /api/public/breach-teaser

Checks redacted email breach exposure counts (3 checks/hour per IP).

Authenticated Tenant API v3 (https://app.aegisintelai.com)

Paid subscriptions issue an API key prefixed with aegis_live_ via Stripe Checkout. Supply your key in either Authorization: Bearer <key> or hibp-api-key: <key> when calling tenant endpoints on https://app.aegisintelai.com (such as GET /api/v3/breachedaccount/{account} and GET /api/v3/stealerlogsbyemaildomain/{domain}).

Errors & Rate-Limit Headers

All public API errors return RFC 9457 application/problem+json payloads containing type, title, status, code, detail, and resolution. Responses emit standard RateLimit-Policy and RateLimit headers, plus Retry-After on HTTP 429.

API Versioning & Deprecation Policy

Public utility routes follow non-breaking additive versioning under X-API-Version: 1.0, while authenticated enterprise routes maintain HIBP /api/v3/ path stability. Breaking schema changes always ship under a new major version path, and deprecated endpoints announce RFC 9745 Deprecation and Sunset headers at least 90 days prior to retirement.