checkDomain — Checking if a domain already exists

The checkDomain method checks if a domain already exists on SiteLock.

The API endpoint is:

https://api.sitelock.com/v1/partner

Request format

SiteLockOnlineRequest: This element is used to delineate the full API request.
- authentication: The partner’s username, password, and branding
  - username: The partner’s API username
  - password: The partner’s API password
  - partner: (Optional) The brand name to use in messaging
- checkDomain: The method name
  - domain: The domain name to check. A naked domain (example.com) and a domain with the www part (www.example.com) are treated as the same domain.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <checkDomain>
        <domain>example.com</domain>
    </checkDomain>
</SiteLockOnlineRequest>XML

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- checkDomain: The method name
  - domain: The domain name that was checked
  - message: The detailed success or error message
  - status: The status of the request. The value can be one of the following:
    
    ok: The request was successful. In the given context, this means no such domain exists on SiteLock.
    
    error: An error occurred. The message element provides more detail.

Example success response

<SiteLockOnlineResponse>
    <checkDomain>
        <domain>example.com</domain>
        <message>domain is available</message>
        <status>ok</status>
    </checkDomain>
</SiteLockOnlineResponse>XML

Example error response

<SiteLockOnlineResponse>
    <checkDomain>
          <domain>example.com</domain>
          <account_id>570</account_id>
          <message>domain already exists</message>
          <site_id>1090</site_id>
          <status>error</status>
    </checkDomain>
</SiteLockOnlineResponse>XML