Skip to content

Get the holder e-mail verification

GET /api/v2/domains/{id}/email-verification

Shows whether the domain holder has confirmed their e-mail address with the registry. Until it is confirmed the registry can suspend the domain. status is verified when nothing is pending. Otherwise reason explains the state and verification.recipient is the address the e-mail goes to. Resend the e-mail with POST /api/v2/domains/{id}/email-verification/actions/resend when actions.canResend.allowed is true. When the address is on a suspended domain (verification.recipientOnSuspendedDomain), the e-mail cannot arrive. Change the domain holder’s e-mail address in the domain contacts instead. A new verification e-mail then goes to the new address.

Authentication: An API key with the scope read:domains. About keys and scopes

Request

Path parameters

idstringrequired
The domain ID. From GET /api/v2/domains.

Example

GET /api/v2/domains/{id}/email-verification
curl "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/email-verification" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 The holder e-mail verification state.

{
"status": "verified",
"isVerified": true,
"isSuspended": false,
"reason": null,
"verifiedAt": null,
"lastCheckedAt": null,
"verification": null,
"actions": {
"canResend": {
"allowed": false,
"reason": "No verification email is needed for this domain."
}
}
}
Response fields
statusstring
verified: nothing is pending. pending: an e-mail was sent and waits for the link to be opened. unverified: the address was not confirmed. expired: the link expired. unknown: the state could not be determined. One of verified, unverified, pending, expired, unknown.
isVerifiedboolean
True when status is verified.
isSuspendedboolean
True when the registry has suspended the domain because the address was not confirmed in time.
reasonstring | null
Plain-text explanation when the address is not verified. Null when verified.
verifiedAtstring | null
Not recorded. Always null.
lastCheckedAtstring | null
When the verification state was last read from the registry.
verificationobject | null
The open verification. Null when nothing is pending.
methodstring | null
How the holder confirms the address: email. Null when no recipient is known. One of email, dns_txt, admin_manual, other.
recipientstring | null
The address the verification e-mail goes to.
txtRecordobject | null
Reserved for DNS-based verification. Always null today.
namestring
valuestring
expiresAtstring | null
When the current verification link expires.
recipientOnSuspendedDomainboolean
True when the address is on a suspended domain. The e-mail cannot arrive and resending is refused. Change the domain holder’s e-mail address instead.
actionsobject
canResendobject
Whether the verification e-mail can be sent again, with the reason when it cannot.
allowedboolean
reasonstring | null

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller; code is domain_not_found.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.