Skip to main content
This guide takes you from a registry key to a working sign-up check and your first report.

Prerequisites

  • An active registry membership and a registry API key. See Membership.
  • Node.js 18 or later, or cURL.
1

Store your registry key

Keep the key out of your code. The examples read it from an environment variable.
2

Add the hash function

Copy the reference implementation into your codebase as registry-hash.mjs. It exports registryDigest(email), which returns the value to send, or null when the value is not an email.Confirm that it produces the published value:
3

Check a sign-up

Call the registry when a user creates an account, before you activate it.
A user that no member reported returns:
4

Act on the result

On a match, apply your policy for each signal. Refuse on the match alone only when automated_refusal_permitted is true. See Act on a match for a complete sign-up handler.
5

Report a ban

When your team bans a user for a registry category, report the email hash with your own case reference.
The API returns 201 Created with the new entry. Keep its entry_id with your case, so that you can revoke the report if you overturn the ban.

Next steps

Check a sign-up

When to check, what the result means, and how to handle a match or an error.

Report a banned user

Report, refresh, list and revoke your entries.