rate.email
Get an API key

API reference

Every endpoint rate.email exposes, generated straight from the OpenAPI spec that also backs the SDKs and the Magento extension.

Authentication

Send your API key as a bearer token, Authorization: Bearer <api_key>, or as X-Api-Key: <api_key>. Both forms work on every endpoint exceptGET /v1/reasons and GET /v1/health, which are public. A missing or invalid key returns 401 with a recovery hint in the response body, not a bare status code.

Verdict rule

verdict comes only from the severities present in reasons, never from the numeric score:

  1. Any high severity reason present: reject.
  2. Else any medium severity reason present: review.
  3. Otherwise: accept.

low and info reasons never change the verdict. They only move the score and add context.

Reason codes

Every reason includes a code, a severity, a sourceand a plain-language message. Codes are stable identifiers, always printed in upper case, never translated. See the fullreason code catalogue for every code, its penalty and an example trigger.

Full reference