API Queries - Request EPP

The request_epp API function fetches the EPP code for a particular domain. Domains also need to be unlocked using the Unlock API function before they can be transferred to another registrar. Additional parameters are required for this function.

Additional Parameters

• domain - Domain name you are requesting the EPP code for. Note: http://www. should not be included.

Your API key is required and all values should be correctly URL encoded.

Example

In the below example, we will request the EPP code for the domain "books.com" (domain=books.com).

Query

https://www.above.com/registrar/api/query.html?key=APIKEY&query=request_epp&domain=books.com

Response

<results code="100">
             <epp_code>8t^KslDOayG</epp_code>
            </results>
            

Example 2

If the domain is not valid or not in your Above.com Registrar account, you will receive a 509 - Specified domain is not in your account error. In this example, we will request the EPP code for the domain "paper.com" (domain=paper.com).

Query

https://www.above.com/registrar/api/query.html?key=APIKEY&query=request_epp&domain=paper.com

Response

<results code="509">
             <msg>Specified domain is not in your account</msg>
            </results>
            

Example 3 - .BE Domains

.BE domains' EPP codes can only be sent directly to the domain registrant via email. Due to this restirction, the API response is slightly different when using the request_epp function with a .BE domain. In this example, we will request the EPP code for the domain "business.be" (domain=business.be).

Query

https://www.above.com/registrar/api/query.html?key=APIKEY&query=request_epp&domain=business.be

Response

<results code="100">
             <msg>Sent to registrant email</msg>
            </results>
            

The EPP code will be sent from the registry to the registrant's email address. This can sometimes take a while, so please be patient.

Error Codes

Possible error responses for this function are:

• 509 - Specified domain is not in your account
• 510 - Domain not specified or invalid domain
• 1601 - EPP code unsupported by registry
• General errors, such as 401 - Invalid API key or 500 - System unavailable.