> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.xynta.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# API Documentation: Domains Module

**This article describes all available actions within the `domains` module of the xYnta API. Each action lists its required parameters and the possible status values returned in the response.**

|| Before the API can be used, API access must be activated and the IP address must be whitelisted. See [Connecting to the API for the first time](https://help.xynta.com/en/article/connecting-to-the-api-for-the-first-time-17w04zd/). For a complete list of status codes, see [API status codes overview](https://help.xynta.com/en/article/api-status-codes-overview-1oabcn5/).

## Table of contents

**Domain actions**

* [check — Check availability](#3-check-check-availability)
* [list — Retrieve domain overview](#3-list-retrieve-domain-overview)
* [order — Order or transfer domain](#3-order-order-or-transfer-domain)
* [show — Retrieve domain details](#3-show-retrieve-domain-details)
* [del — Cancel domain](#3-del-cancel-domain)
* [edit-contact — Modify WHOIS details](#3-edit-contact-modify-whois-details)
* [edit-nameserver — Modify nameservers](#3-edit-nameserver-modify-nameservers)
* [lock — Lock domain](#3-lock-lock-domain)
* [unlock — Unlock domain](#3-unlock-unlock-domain)
* [get-authkey — Retrieve transfer code](#3-get-authkey-retrieve-transfer-code)

**Contact actions**

* [list, t: contact — Contacts overview](#3-list-t-contact-contacts-overview)
* [show, t: contact — View contact details](#3-show-t-contact-view-contact-details)
* [add, t: contact — Add contact](#3-add-t-contact-add-contact)
* [edit, t: contact — Modify contact](#3-edit-t-contact-modify-contact)
* [check, t: contact — Check contact](#3-check-t-contact-check-contact)
* [del, t: contact — Delete contact](#3-del-t-contact-delete-contact)

**DNS actions**

* [show-dns-zone — View DNS zone](#3-show-dns-zone-view-dns-zone)
* [edit-dns-zone — Modify DNS zone](#3-edit-dns-zone-modify-dns-zone)

### check — Check availability

```
m: domains, a: check
```

Checks whether a domain name is available for registration.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Domain` | Yes | Full domain name, e.g. `example.nl` |

Status values:

* `available` — the domain name is available.
* `unavailable` — the domain name is already registered.

### list — Retrieve domain overview

```
m: domains, a: list
```

Retrieves an overview of all domain names linked to the account.

No parameters required.

Status values:

* `success` — the domain overview was retrieved successfully.

### order — Order or transfer domain

```
m: domains, a: order
```

Orders or transfers a domain name. See also: [Ordering domain names in real time via the API](https://help.xynta.com/en/article/ordering-domain-names-in-real-time-via-the-api-td8qei/).

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Domain` | Yes | Domain name without extension, e.g. `example` |
| `Tld` | Yes | Extension without dot, e.g. `nl` |
| `OwnerHandle` | Yes | Unique ID of the holder |
| `AdminHandle` | Yes | Unique ID of the administrative contact |
| `TechHandle` | Yes | Unique ID of the technical contact |
| `DNS1` | Yes | First nameserver |
| `DNS2` | Yes | Second nameserver |
| `DNS3` | No | Third nameserver |
| `DNS4` | No | Fourth nameserver |
| `DNS5` | No | Fifth nameserver |
| `AuthKey` | No | Transfer code, if required for the transfer |

Status values:

* `success` — the domain name was ordered successfully.
* `not-authorized` — post-payment billing is not enabled.
* `not-found-service` — the extension is not supported.
* `not-found-contact` — one or more contacts were not found.
* `not-available` — the domain name has already been ordered.
* `validation-domain` — invalid domain name format.

### show — Retrieve domain details

```
m: domains, a: show
```

Retrieves the details of a specific domain name.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Domain` | Yes | Domain name without extension |
| `Tld` | Yes | Extension without dot |

Status values:

* `success` — the domain was found.
* `not-authorized` — no access to this domain.
* `not-found` — the domain does not exist.

### del — Cancel domain

```
m: domains, a: del, t: cancel / cancel-direct / undo
```

Cancels a domain name. Use `t: cancel` to cancel at the end of the contract period, `t: cancel-direct` for immediate cancellation, or `t: undo` to reverse a pending cancellation.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Domain` | Yes | Domain name without extension |
| `Tld` | Yes | Extension without dot |

Status values:

* `success` — the domain was cancelled.
* `pending-deletion` — the cancellation was already active.
* `not-supported` — cancellation is not possible for this extension.
* `not-authorized` — no access to this domain.
* `not-found` — the domain does not exist.

### edit-contact — Modify WHOIS details

```
m: domains, a: edit-contact
```

Modifies the contacts (holder, administrative and technical) linked to a domain name.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Domain` | Yes | Domain name without extension |
| `Tld` | Yes | Extension without dot |
| `OwnerHandle` | Yes | Unique ID of the holder |
| `AdminHandle` | Yes | Unique ID of the administrative contact |
| `TechHandle` | Yes | Unique ID of the technical contact |

Status values:

* `success` — the contacts were modified.
* `error` — modification failed.
* `not-authorized` — no access to this domain.
* `not-found` — the domain does not exist.

### edit-nameserver — Modify nameservers

```
m: domains, a: edit-nameserver
```

Modifies the nameservers of a domain name.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Domain` | Yes | Domain name without extension |
| `Tld` | Yes | Extension without dot |
| `DNS1` | Yes | First nameserver |
| `DNS2` | Yes | Second nameserver |
| `DNS3` | No | Third nameserver |
| `DNS4` | No | Fourth nameserver |
| `DNS5` | No | Fifth nameserver |

Status values:

* `success` — the nameservers were modified.
* `warning` — the nameservers were not changed.
* `error` — modification failed.
* `not-authorized` — no access to this domain.
* `not-found` — the domain does not exist.

### lock — Lock domain

```
m: domains, a: lock
```

Activates a transfer lock on the domain name to prevent unauthorised transfer.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Domain` | Yes | Domain name without extension |
| `Tld` | Yes | Extension without dot |

Status values:

* `success` — the domain was locked.
* `not-supported` — not supported for this extension.
* `not-authorized` — no access to this domain.
* `not-found` — the domain does not exist.

### unlock — Unlock domain

```
m: domains, a: unlock
```

Removes the transfer lock from a domain name.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Domain` | Yes | Domain name without extension |
| `Tld` | Yes | Extension without dot |

Status values:

* `success` — the domain was unlocked.
* `not-supported` — not supported for this extension.
* `not-authorized` — no access to this domain.
* `not-found` — the domain does not exist.

### get-authkey — Retrieve transfer code

```
m: domains, a: get-authkey
```

Retrieves the transfer code (EPP code / authcode) for a domain name.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Domain` | Yes | Domain name without extension |
| `Tld` | Yes | Extension without dot |

Status values:

* `success` — the transfer code was retrieved.
* `warning` — no transfer code available.
* `error` — retrieval failed.
* `not-supported` — not supported for this extension.
* `not-authorized` — no access to this domain.
* `not-found` — the domain does not exist.

### list, t: contact — Contacts overview

```
m: domains, a: list, t: contact
```

Retrieves an overview of all contacts linked to the account.

No parameters required.

Status values:

* `success` — the contacts were retrieved.
* `pending` — processing is still in progress.
* `not-authorized` — no access.
* `not-found` — no contacts found.

### show, t: contact — View contact details

```
m: domains, a: show, t: contact
```

Retrieves the details of a specific contact.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Handle` | Yes | Unique ID of the contact |

Status values:

* `success` — the contact was found.
* `pending` — processing is still in progress.
* `not-authorized` — no access.
* `not-found` — the contact was not found.

### add, t: contact — Add contact

```
m: domains, a: add, t: contact
```

Creates a new contact. Uses the same parameters as [edit, t: contact](#3-edit-t-contact-modify-contact).

Status values:

* `success` — the contact was added.
* `error-processing` — the contact could not be added.
* `validation-handle` — invalid Handle.
* `validation-emailaddress` — invalid email address.
* `validation-address` — invalid address.
* `validation-phonenumber` — invalid phone number.
* `not-found` — the contact was not found.

### edit, t: contact — Modify contact

```
m: domains, a: edit, t: contact
```

Modifies the details of an existing contact.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Handle` | Yes | Unique ID of the contact |
| `CompanyName` | No | Company name |
| `CompanyNumber` | No | Chamber of Commerce number, Dutch companies only |
| `TaxNumber` | No | VAT number, EU companies only |
| `Initials` | Yes | Initials or first name |
| `SurName` | Yes | Last name |
| `Address` | Yes | Street and house number — PO boxes are not permitted |
| `ZipCode` | Yes | Postal code, e.g. `1234AB` |
| `City` | Yes | City — letters and spaces only |
| `Country` | Yes | ISO 3166-1 country code, e.g. `NL` |
| `EmailAddress` | Yes | Valid email address |
| `PhoneNumber` | Yes | Phone number, digits only |

Status values:

* `success` — the contact was modified.
* `error-processing` — modification failed.
* `validation-handle` — invalid Handle.
* `validation-emailaddress` — invalid email address.
* `validation-address` — invalid address.
* `validation-phonenumber` — invalid phone number.
* `pending-processing` — processing in progress.
* `pending-modification` — contact is being modified.
* `pending-deletion` — contact is being deleted.
* `not-found` — the contact was not found.

### check, t: contact — Check contact

```
m: domains, a: check, t: contact
```

Checks whether a contact already exists based on name.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Initials` | Yes | Initials or first name |
| `SurName` | Yes | Last name |
| `CompanyName` | No | Company name |

Status values:

* `success` — the contact exists.
* `not-found` — the contact was not found.

### del, t: contact — Delete contact

```
m: domains, a: del, t: contact
```

Deletes an existing contact.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Handle` | Yes | Unique ID of the contact |

Status values:

* `success` — the contact was deleted.
* `pending-processing` — processing started.
* `pending-modification` — contact under modification.
* `pending-deletion` — contact already being deleted.
* `not-found` — the contact was not found.

### show-dns-zone — View DNS zone

```
m: domains, a: show-dns-zone
```

Retrieves the DNS zone of a domain name.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Domain` | Yes | Domain name without extension |
| `Tld` | Yes | Extension without dot |

Status values:

* `success` — the DNS zone was found.
* `not-found` — the zone was not found.

### edit-dns-zone — Modify DNS zone

```
m: domains, a: edit-dns-zone
```

Modifies the DNS zone of a domain name.

| Variable | Required | Description |
| -------- | -------- | ----------- |
| `Domain` | Yes | Domain name without extension |
| `Tld` | Yes | Extension without dot |
| `DNSZone` | Yes | Modified zone as an array |

Status values:

* `success` — the DNS zone was modified.
* `error-processing` — modification failed.
* `not-found` — the zone was not found.

---

Issues or questions about a specific call? See [API call troubleshooting](https://help.xynta.com/en/article/api-call-troubleshooting-s3i2s8/) or [get in touch](https://www.xynta.com/en/support/contact).