Knowledge base

API key scopes

Every scope your key can request, what each allows, and which endpoints require it.

Team roles and permissions

What each team role can do in the app versus what an API key scope allows.

Audit log events

Brief descriptions of team and personal audit log action labels.

API rate limiting

How /api/v1 throttles traffic, which response headers to read, and how that relates to monthly API quotas.

Detection overview

Every field returned by GET /api/v1/emails/detect, how checks run in order, and links to deep dives on each signal.

Valid syntax

How EmailGuard validates addr-spec syntax under RFC 5322 and RFC 5321, converts IDNA domains, and exposes syntax_validation in the detect API.

Normalization

How the normalized field collapses provider-specific aliases so duplicate signups map to one mailbox, and when subaddressing is set.

Subaddressing

When subaddressing is true, what plus-addressing and provider aliases mean for signup policy, and how to read the flag from the detect API.

Role addresses

How role_address flags shared inboxes like admin@ and support@, with example patterns and signup policy guidance.

Public domains

When public_domain is true, how freemail providers are classified, and using the flag in B2B signup and lead routing.

Relay detection

How relay_domain and relay_provider identify privacy forwarding services, with example domains and API usage.

Disposable detection

How disposable and detection_source identify throwaway inbox providers, live vs precomputed results, and blocking abuse at signup.