Domains

Get EPP auth code

Get the EPP/auth code needed to transfer a domain to another registrar. Automatically unlocks the domain if it's locked. Whoever holds the auth code can move the domain, and its mail with it: reading it needs the email:auth_secrets scope and a token not confined to mailboxes (403 INSUFFICIENT_SCOPE or 403 MAILBOX_CONFINED otherwise), and every read is recorded in the audit log. Some registrars have no API for the code: the first call then answers 202 with status: "requested" while Domani's team unlocks the domain and gets the code by hand (within 1 business day, expected_by); the user gets an email when it is ready, and a later call answers 200 with status: "ready" and the code. Within 60 days of a registration or transfer-in such a domain answers 409 TRANSFER_LOCKED with available_at.

get/api/domains/{domain}/auth-code

Request

  • Base URL: https://domani.run
  • URL: https://domani.run/api/domains/{domain}/auth-code
  • Auth: HTTP bearer

Path parameters

domainstring required
Example:mysite.com

Domain name you own

Response

Auth code retrieved

domainstring required
status'ready' | 'requested' required

ready: the code is in auth_code. requested: Domani's team is getting it from the registrar; the user gets an email when it is ready.

auth_codestring nullable required

EPP auth code to give to the new registrar. null while requested.

was_unlockedboolean required

Whether the domain was unlocked to allow the transfer

requested_atstring date-time

When the code was asked for (registrars without an API for it)

expected_bystring date-time

When Domani's team will have the code at the latest (status requested)

hintstring required
next_stepsstring[] required

Changes

No recorded changes to this operation across all 2 revisions of this API.