NicNames API v2 (2.0)

Glossary

• OID - Order ID
• CTS - Creation date and time
• UTS - Modification date and time
• ETS - Expiration date and time

Time

Any field of time type represents the number of seconds elapsed since the Unix epoch, which is 1970-01-01T00:00:00Z.

Webhook URL for Asynchronous Results and Events

For operations returning a 202 (Accepted) status code, the final result will be delivered asynchronously via a webhook. Your system will receive a POST request at the specified URL with the following parameters sent as application/x-www-form-urlencoded data:

• object: Event data in JSON format.
• timestamp: The Unix timestamp (in milliseconds) representing the time when the webhook notification was sent.
• signature: A signature generated using the HMAC-SHA256 algorithm. This signature is created by concatenating the object (event data in JSON format) and timestamp as a string. The resulting string is then signed with your webhook_secret key using the HMAC-SHA256 algorithm. The final signature will be returned in hexadecimal format (lowercase letters).

Codes

List of possible result and error codes returned by this API

• 440000 - UNKNOWN
• 441000 - SUCCESS
• 441001 - PENDING
• 442001 - ERROR_REMOTE
• 442002 - ERROR_EXCEPTION
• 442003 - ERROR_FORBIDDEN
• 442006 - ERROR_UNKNOWN_STATUS
• 442007 - ERROR_NOT_FOUND
• 442008 - ERROR_STATUS_PROHIBITED
• 442009 - ERROR_PARAM_VALUE_POLICY
• 442010 - ERROR_INVALID_PARAM_VALUE
• 442011 - ERROR_PARAM_VALUE_REQUIRED
• 442012 - ERROR_UNAUTHORIZED

Statuses

List of possible status codes returned by this API

• new – The order has been created but not yet paid.
• active – The order is active and operational.
• expired – The order has expired and is no longer active. Renewal is required to restore it.
• pendingUpdate – A order update request is in progress.
• arrested – The order has been restricted or suspended due to policy violation, legal action, or administrative hold.
• redemptionPeriod – The order has expired and is in the redemption grace period. It can still be restored for an additional fee.
• closed – The order has been deleted and cannot be restored.
• pendingRegistrantEmailVerification – The domain is awaiting email verification by the registrant. A confirmation request has been sent but not yet completed.
• lockRegistrantEmailVerification – The domain is locked because the registrant's email address has not been verified.
• lockExpiration – The domain is locked due to expiration and requires renewal.
• lockTransfer – The domain is locked to prevent transfer to another registrar.
• lockRegistrant60 – The domain is locked and prevents changes to the registrant’s information for 60 days.
• lockTransfer60 – The domain is locked and prevents transfer to another registrar for 60 days.
• tokenized - The domain is represented as a digital token.
• unknown – The order is in an undefined or undocumented state. This may indicate an internal error or an unexpected status value.