get_registrant_verification_status
When a domain is registered or transferred, or when the registrant contact
information is changed, the registrant must reply to an email requesting
them to confirm that the submitted contact information is correct. This
command returns the current state of the verification request.
Request parameters for get_registrant_verification_status
Standard parameters
- action = get_registrant_verification_status
- object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter name | Obligation | Definition / Value |
---|---|---|
domain | Required | The relevant domain. |
Response parameters for get_registrant_verification_status
Standard parameters
- action = reply
- object = domain
- is_success = a Boolean is returned, indicating success or failure of the
request - response_code = response code indicating outcome of the request
- response_text = message describing the outcome of the request
Attributes
Parameters within the attributes associative array are described below.
Parameter name | Obligation | Definition/Value |
---|---|---|
days_to_suspend | Returned if is_success = true | The number of days remaining until the domain is suspended if the registrant information is not Note: This parameter is returned only if the value |
email_bounced | Returned if is_success = true | Returns 1 if the verification email was triggered |
registrant_verification_status | Returned if is_success = true | The current status of the verification. Allowed values are:
|
verification_deadline | Returned if is_success = true | The date by which the domain will be suspended, format: Note: This parameter is returned only if the value |
Examples for get_registrant_verification_status
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get_registrant_verification_status</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="response_text">Command Successful</item>
<item key="attributes">
<dt_assoc>
<item key="registrant_verification_status">suspended</item>
<item key="verification_deadline">2013-11-02
00:00:00</item>
<item key="email_bounced">1</item>
<item key="days_to_suspend">2</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Updated about 3 years ago