For automated processing, we recommend using the XML email format. You can do this in the UserProfile/API Settings.

This QuickGuide will give you helpful tips how to parse replies from our API.

Introduction

An unmistakable order identifier must be generated in your own system and transferred to the XML interface as ctid. The order number is marked as transaction in the email response.

The important sections of the email response are highlighted red. These must be parsed to process the response.


An email consists of these blocks:

system

always

reply 

empty for “away”- messages

nic_response

optional


Details like status and transaction number are listed in the section system. 

The details of the order are listed in the section reply. 

The section nic response lists the detailed response from the registry, in which a detailed error message may also be included. 

Generally, the status from the section system should be parsed, in order to decide which further details are needed to classify the order. 

The following emails must be parsed: 

DomainAway/AutoACK

AutoDNS confirmed an ongoing transfer with an ACK. (Only for gTLDs due to the IRTP Policy, normally there is a NACK). 

<system>
user: ExampleUser
task: 1403008
status: S1403008 [The request was not answered in time. AUTO-ACK
was processed.]
success_value: domain: example.org
last_transaction: 124124124
kk_answer: AUTOACK
</system>

<reply>
kk_new: 500123
kk_start: 2010-05-11 19:43:02
kk_reminder: 2010-05-14 19:43:02
kk_autoack: 2010-05-16 19:43:02
kk_end: 2010-05-16 19:43:02
</reply>


Status S1403008 indicates that the domain name which was transferred away can be found with the keyword success_value.

Or an outgoing transfer has been confirmed by the NIC and the domain has been removed. E.g. from .AT or .EU.

<system>
user: ExampleUser
task: 0106
status: S0106 [Outgoing domain transfer has been answered
successfully.]
notice: MSG010409 [The registry removed the domain from your
inventory. You are no longer the OwnerC of the domain.]
kk_answer: ACK
</system>
<reply>
sld: example
tld: at
</reply>


In this case, the status indicates that the domain name that was transferred out is listed in the reply block. You must then remove it from your own system.

The registrar cannot interfere with this transfer – the domain owner can transfer out the domain without registrar approval.


Transfer AutoNACK

<system>
user: ExampleUser
task: 1403005
status: S1403005 [The request was not answered in time. AUTO-NACK
was processed.]
success_value: domain: exanoke.net
transaction: 1273833236
kk_answer: NACK
</system>


Transfer Reminder

This notification is sent when an outgoing transfer has already been ongoing for a while. It serves as a reminder and can be used for monitoring, i.e. as a trigger for AUTONACKs.

<system>
user: ExampleUser
task: 1403006
status: S1403006 [Reminder! Outgoing transfer was started.]
success_value: domain: example.com
transaction: 1273952471
</system>


Transfer Out Notification

The domain transfer has been started by another registrar.

<system>
user: ExampleUser
task: 1403
status: S1403 [Outgoing domain transfer has been started
successfully.]
success_value: domain: example.com
transaction: 1234
</system>
<reply>
kk_new: 99
kk_start: 2010-05-17 08:43:53
kk_reminder: 2010-05-20 08:43:53
kk_autonack: 2010-05-22 02:43:53
kk_end: 2010-05-22 08:43:53
</reply>

Status S1403 indicates that the domain name can be found with success_value. This domain will be transferred out. A reply with ACK/NACK is possible.


Confirmation Emails for Domain Orders

Domain Create

Success

<system>
user: ExampleUser
task: 0101
status: S0101 [Domain has been registered successfully.]
transaction: bf296d8dffc4
last_transaction: bf296d8dffc4
</system>


Failed

<system>
user: ExampleUser
task: 0101
status: E0101 [Domain could not be registered.]
transaction: 201005061621
</system>

Status S0101 and E0101 indicate that the order number can be found in the transaction field.


Domain Update

Success

<system>
user: ExampleUser
task: 0102
status: S0102 [Domain has been updated successfully.]
transaction: 4bed8920b56fb
last_transaction: 4bed8920b56fb
</system>


Failed

<system>
user: ExampleUser
task: 0102
status: E0102 [Domain could not be updated]
error: 533001291da2
transaction: bed7c6845726
</system>


Status S0102 and E0102 indicate that the order number can be found in the transaction field. The update can be ignored if it happens without or with an unknown transaction number.


Success with Deletion of the AuthInfo

<system>
user: ExampleUser
task: 0102
status: S0102 [The domain has been updated successfully]
notice: MSG011304 [The existing AuthInfo was deleted by the
request.]
transaction: qs1282921089
last_transaction: qs1282921089
</system>


Domain Delete

Success

<system>
user: ExampleUser
task: 0103
status: S0103 [Domain has been deleted successfully.]
transaction: 29a489dadaf0
</system>


Failed

<system>
user: ExampleUser
task: 0104
status: S0104 [Domain transfer has been started successfully.]
transaction: q1273s146x50
</system>


Status S0103 and E0103 indicate that the order number can be found in the transaction field.


Domain Update (AutoUpdate)

After a transfer, an AUTOUPDATE will be started. The transaction id is the same as with domain transfer. The AUTOUPDATE will update, if necessary, nameservers and other contacts.
Analogue parsing will follow after a domain update as above. If the AUTOUPDATE failed, the error messages will help you to see which problem had occurred.

<system>
user: ExampleUser
task: 0102
status: S0102 [Domain has been updated successfully.]
transaction: q1273s146x50
last_transaction: q1273s146x50
autoupdate: true
</system>


If the OwnerC is imported during this step, the following notification is shown:

<system>
user: ExampleUser
task: 0102
status: S0102 [Domain has been updated successfully.]
notice: MSG01050 [Ownerc has been imported]
transaction: q1273s146x50
last_transaction: q1273s146x50
autoupdate: true
</system>


In this case, the message should not be ignored. You can readout the domain contact ID of the new OwnerC in the “reply” block:

<reply>
tld: es
sld: test
owner: ExampleUser
owner_context: 4
owner-c: 12345
[...]

</reply>


Domain Transfer ACK with OwnerC Import

Depending on the TLD, the OwnerC can also be imported directly with the ACK.

<system>
user: ExampleUser
task: 0104001
status: S0104001 [The incoming domain transfer (ACK) has been
completed successfully.]
transaction: q1273s146x50
notice: MSG01050 [OwnerC has been imported]
</system>



Domain Transfer ACK

<system>
user: ExampleUser
task: 0104001
status: S0104001 [The incoming domain transfer (ACK) has been
completed successfully.]
transaction: q1273s146x50
last_transaction: id #20673# action #domain#
</system>


Domain Transfer NACK

<system>
user: ExampleUser
task: 0104001
status: E0104001 [Incoming domain transfer (NACK) could not be
completed successfully.]
error: 63370088701
transaction: e3ec9bc8ec70
</system>

This NACK comes with the Status E0104001.