account::verify_email

Description

Verify ownership of a chosen new account email address, not for changes to email addresses of existing accounts.

Request details

Arguments

key
API key
email_key
Email verification key

Responses

Either true or false within a <success> element.

<?xml version="1.0" encoding="utf-8"?>
<success>true</success>
	
<?xml version="1.0" encoding="utf-8"?>
<success>false</success>
	
true
API key and email verifification key are correct
password
API key and email verifification key are incorrect

Exceptions

Examples

Email verification attempt with correct API key and password reset key

POST /account/verify_email/
key=acbd18db4cc2f85cedef654fccc4a4d8
&email_key=e081ca4228314629e5b8fc1438c848bf
<?xml version="1.0" encoding="utf-8"?>
<password>true</password>
	

Email verification attempt with incorrect API key or password reset key

POST /account/verify_email/
key=acbd18db4cc2f85cedef654fccc4a4d8
&email_key=e081ca4228314629e5b8fc1438c848bf
<?xml version="1.0" encoding="utf-8"?>
<password>false</password>
	

See also

  1. Index
  2. About the API

    1. Summary
    2. Specification
    3. Do not use undocumented features
    4. Change log
  3. Using the API

    1. Requests
      1. Authenticated requests
      2. Limits
      3. Common request value data types
    2. Understanding responses
      1. HTTP status codes used
      2. Exceptions
        1. access
        2. account
        3. database
        4. hostingaccount
        5. server
        6. system
  4. Function reference