domains
GET /v1/domains/registrant-email-verifications
The caller's domains whose registrant email address is not yet confirmed.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/domains/registrant-email-verifications \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
ICANN requires the registrar to confirm a generic-TLD registrant's email address: it mails the registrant a link, and a name whose address is not confirmed by the deadline is suspended by the registry. Each item is one of your domains still waiting, with the address the link went to and the deadline. Read from what the registrar reported at its last check (every 6 hours, checked_at), soonest deadline first, at most 200 items. A confirmed address leaves the list at the next check. Requires sites.view. Scoped to the caller's OWN orgs (direct memberships, or the API key's org), or to the one org the request names in X-Zinn-Org: a parent or reseller org is never shown a client org's notice unless it acts in that client org.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
domain_id (query) | Uuid | No | — |
org_id (query) | Uuid | No | The one org whose notices to list (the same as X-Zinn-Org; this parameter wins when both are sent). Narrowed to the orgs the caller may view with sites.view: an org outside… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
items | RegistrantEmailVerification[] | Yes | — |
count | integer | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429