---
title: "Check an address or domain against the policy"
method: GET
path: "/stats/email-domains/check"
tags: ["Stats"]
---

# Check an address or domain against the policy

`GET /stats/email-domains/check`

## Request

- Base URL: `https://api.nippy.host`
- URL: `https://api.nippy.host/stats/email-domains/check`
- Auth: `bearer` (a scheme the document does not define)

Admin-only. Says whether a new signup from the address would be refused, which list refuses it, and whether an `allow` rule overrides a block. Existing users are never refused — this is what a new address would meet.

## Query parameters

- `value` string, required

## Response `200`

- APIEmailDomainCheck
  - `domain` string, nullable, required: The normalised domain checked; null when none was found.
  - `blocked` boolean, required: Whether a new signup would be refused.
  - `list` 'community' | 'nippy' | 'plus_alias', nullable, required: What blocks it: a domain list, or `plus_alias` for a `+` alias outside the staff domains. Null when not blocked.
  - `matchedDomain` string, nullable, required: The listed domain that matched (the domain or a parent).
  - `allowedBy` string, nullable, required: The `allow` rule that overrode a block, if any.
  - `existingUsers` number, required: Existing users on the domain or a subdomain.
  - `signupRule` 'same_mailbox' | 'numbered_address' | 'device_limit', nullable, required: The signup limit that would refuse this address as a new account (address rules only — the browser limit needs a browser); null when none applies or the input is a bare domain (ADR 0050).
  - `signupMatch` string, nullable, required: The existing account that triggers `signupRule`.
  - `signupAllowlisted` boolean, required: Whether the address is on the signup-limit override list.

## Other responses

- `403`: Admin access required

---

[API](https://skmtc.dev/nippy/apis/nippy-backend-api.md) · [All operations](https://skmtc.dev/nippy/apis/nippy-backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nippy/apis/nippy-backend-api/revisions/7ab23f040a55?raw)
