Domains-domainName-contactverification:GET

From Hostway API Documentation
Jump to: navigation, search

GET /domains/{domainName}/contactverification

Get the status of the contactverification for {domainName} Or Get will send a verification email for {domainName}

  • [This page requires more explanatory detail and examples]*

Contents

Request

GET /domains/{domainName}/contactverification

Parameters

action
The action GET will take.
info | sendVerificationEmail

URI Parameters

domainName - string
The domain name. IE: example.com is a valid domain name, whereas http://www.example.com or www.example.com are not. If the domain name is invalid, or is otherwise not registerable such as for a non-existent or non-supported TLD, an error will be returned. Domain names are case insensitive. The domain name must be an open or suspended product under the authenticated franchise.

Request Headers

None.

Request Body

None.

Response

Status Code

200 OK
Returns contact verification status when action=info
204 No Content
when action=sendVerificationEmail

Response Body

{
   "verificationStatus":"pending"
}
 

Response parameters

verificationStatus - string
"Verified", "Cancelled", "Queued, Pending Verification", "Queue Expired", "Pending Suspension", "Suspended"

Example getting contact verification status for a domain.

Request

GET /domains/example.com/contactverification?action=info
 

Response

200 OK
Content-Type: application/json; charset=UTF-8
{"verificationStatus": "pending"}
 

Example sending contact verification for a domain.

Request

GET /domains/example.com/contactverification?action=sendVerificationEmail
 

Response

204 No Content
 

See also


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox