checkdomain GmbHDevelopers

Reference

Contacts

GET /v1/contacts

List domain contacts

This can be used to get a list of available domain contacts. Use the query parameter to filter the list.

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       https://api.checkdomain.de/v1/contacts
Response
HTTP/1.1 200 OK
{
    "page": 1,
    "limit": 25,
    "pages": 1,
    "total": 1,
    "_links": {
        "self": {
            "href": "/v1/contacts?page=1&limit=25"
        },
        "first": {
            "href": "/v1/contacts?page=1&limit=25"
        },
        "last": {
            "href": "/v1/contacts?page=1&limit=25"
        }
    },
    "_embedded": {
        "contacts": [
            {
                "id": 1,
                "identifier": "CD1101-001",
                "company": null,
                "gender": "M",
                "first_name": "John",
                "last_name": "Doe",
                "street": "Große Burgstraße 27/29",
                "postal_code": "23552",
                "city": "Lübeck",
                "additional": null,
                "country": {
                    "iso": "DE",
                    "name": "Deutschland"
                },
                "email": "john.doe@example.com",
                "phone": "+49 451 709970",
                "fax": null,
                "_links": {
                    "self": {
                        "href": "/v1/contacts/1"
                    }
                }
            }
        ]
    }
}
Filters
Name Type Required Description
query string Query to search for a specific contact
page integer Page to retrieve
limit integer Number of elements to retrieve
GET /v1/contacts/{contact}

Get a domain contact

Use this to get a specific domain contact by its ID.

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       https://api.checkdomain.de/v1/contacts/{contact}
Response
HTTP/1.1 200 OK
{
    "id": 1,
    "identifier": "CD1101-001",
    "company": null,
    "gender": "M",
    "first_name": "John",
    "last_name": "Doe",
    "street": "Große Burgstraße 27/29",
    "postal_code": "23552",
    "city": "Lübeck",
    "additional": null,
    "country": {
        "iso": "DE",
        "name": "Deutschland"
    },
    "email": "john.doe@example.com",
    "phone": "+49 451 709970",
    "fax": null,
    "_links": {
        "self": {
            "href": "/v1/contacts/1"
        }
    }
}
Requirements
Name Type Required Description
contact integer The contact identifier
Status-Codes
Code Description
200 Ok
404 Contact not found

Post

Create a domain contact

POST /v1/contacts

Create a domain contact

With this endpoint you are able to create new domain contacts for your account to use when registering new domains or updating existing domains.

Attention

Please note, that you have to prefix your contact identifier with your customer number. In the example below the customer number is CD1101. In this case the identifier has to start with CD1101.

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       --header "Content-Type: application/json" \
       --data "{Request Data}" \
       --request POST \
       https://api.checkdomain.de/v1/contacts
Request Data
{
    "type": "Owner",
    "identifier": "CD1101-001",
    "gender": "M",
    "first_name": "John",
    "last_name": "Doe",
    "street": "Große Burgstraße 27/29",
    "postal_code": "23552",
    "city": "Lübeck",
    "country": "DE",
    "email": "john.doe@example.com",
    "phone": "+49 451 709970"
}
Response
HTTP/1.1 200 OK
{
    "id": 1,
    "identifier": "CD1101-001",
    "type": "Owner",
    "gender": "M",
    "company": null,
    "title": null,
    "first_name": "John",
    "last_name": "Doe",
    "additional": null,
    "street": "Große Burgstraße 27/29",
    "city": "Lübeck",
    "postal_code": "23552",
    "country": {
        "iso": "DE",
        "name": "Germany"
    },
    "state": null,
    "email": "info@api.checkdomain.de",
    "phone": "+49 451 709970",
    "mobile_phone": null,
    "fax": null,
    "_links": {
        "self": {
            "href": "/v1/contacts/1"
        }
    }
}
Parameters
Name Type Required Description
identifier string Yes Custom alphanumeric identifier prefixed with your customer number.
Choices for identifier
type string Yes Type (Owner, Admin)
Choices for type
gender string Yes Gender (M: Male, F: Female)
Choices for gender
company string Company name
title string Title
first_name string Yes First name
last_name string Yes Last name
additional string Additional address information
street string Yes Street
city string Yes City
postal_code string Yes Postal Code
country string Yes Country ISO Code
state string State/Province
email string Yes eMail Address
phone string Yes Phone number
mobile_phone string Mobile phone number
fax string Fax number
Status-Codes
Code Description
200 Ok
400 Validation failed
PATCH /v1/contacts/{contact}

Update domain contact

With this endpoint you are able to update parts of a specific domain contact.

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       --header "Content-Type: application/json" \
       --data "{Request Data}" \
       --request PATCH \
       https://api.checkdomain.de/v1/contacts/{contact}
Request Data
{
    "first_name": "Jane"
}
Response
HTTP/1.1 200 OK
{
  "id": 1,
  "identifier": "CD1101-001",
  "company": null,
  "gender": "M",
  "first_name": "Jane",
  "last_name": "Doe",
  "street": "Große Burgstraße 27/29",
  "postal_code": "23552",
  "city": "Lübeck",
  "additional": null,
  "country": {
    "iso": "DE",
    "name": "Deutschland"
  },
  "email": "john.doe@example.com",
  "phone": "+49 451 709970",
  "fax": null,
  "_links": {
    "self": {
      "href": "/v1/contacts/1"
    }
  }
}
Requirements
Name Type Required Description
contact integer The contact identifier
Parameters
Name Type Required Description
identifier string Custom alphanumeric identifier prefixed with your customer number
type string Type (Owner, Admin)
gender string Gender (M: Male, F: Female)
company string Company name
title string Title
first_name string First name
last_name string Last name
additional string Additional address information
street string Street
city string City
postal_code string Postal Code
country string Country ISO Code
state string State/Province
email string eMail Address
phone string Phone number
mobile_phone string Mobile phone number
fax string Fax number
Status-Codes
Code Description
200 Ok
400 Validation failed
403 Occurs when you try to update a domain contact which has currently active domains linked to it.
PUT /v1/contacts/{contact}

Replace a domain contact

Use this to completely replace an existing domain contact with new values

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       --header "Content-Type: application/json" \
       --data "{Request Data}" \
       --request PUT \
       https://api.checkdomain.de/v1/contacts/{contact}
Request Data
{
    "identifier": "CD1101-001",
    "gender": "F",
    "first_name": "Jane",
    "last_name": "Doe",
    "street": "Große Burgstraße 27/29",
    "postal_code": "23552",
    "city": "Lübeck",
    "country": "DE",
    "email": "jane.doe@example.com",
    "phone": "+49 451 709970"
}
Response
HTTP/1.1 200 OK
{
    "id": 1,
    "identifier": "CD1101-001",
    "company": null,
    "gender": "F",
    "first_name": "Jane",
    "last_name": "Doe",
    "street": "Große Burgstraße 27/29",
    "postal_code": "23552",
    "city": "Lübeck",
    "additional": null,
    "country": {
        "iso": "DE",
        "name": "Deutschland"
    },
    "email": "jane.doe@example.com",
    "phone": "+49 451 709970",
    "fax": null,
    "_links": {
       "self": {
           "href": "/v1/contacts/1"
       }
   }
}
Requirements
Name Type Required Description
contact integer The contact identifier
Parameters
Name Type Required Description
identifier string Custom alphanumeric identifier prefixed with your customer number
type string Type (Owner, Admin)
gender string Gender (M: Male, F: Female)
company string Company name
title string Title
first_name string First name
last_name string Last name
additional string Additional address information
street string Street
city string City
postal_code string Postal Code
country string Country ISO Code
state string State/Province
email string eMail Address
phone string Phone number
mobile_phone string Mobile phone number
fax string Fax number
Status-Codes
Code Description
200 Ok
400 Validation failed
403 Occurs when you try to replace a domain contact which has currently active domains linked to it.
DELETE /v1/contacts/{contact}

Delete domain contact

This deletes an existing contact if it is not linked to any domain. As long as the contact is linked to a domain this will fail and the response code will be 403 (Forbidden).

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       --request DELETE \
       https://api.checkdomain.de/v1/contacts/{contact}
Response
HTTP/1.1 204 No Content
Requirements
Name Type Required Description
contact integer Yes The contact identifier
Status-Codes
Code Description
204 Ok
403 Occurs when you try to delete a domain contact which has currently active domains linked to it.