Table of Contents

Function

The ContactVerificationList task inquires the data of several verification jobs.

You can find more information about list queries here.

Description

Route: POST /contact/verification/_search

Query parameters

The data of the following keywords can be queried with the query parameter ?keys[]=:

  • status
  • deactivation
  • verification_mail
  • comment
  • action
Request 
{
    "filters": [
        {
            "key": "handle.id",
            "value": "233*",
            "operator": "LIKE"
        }
    ],
    "view": {
        "children": 1,
        "limit": 10
    }
}
Response 
{
    "stid": "20210805-app-94766",
    "status": {
        "code": "S0345",
        "text": "The domain contact verification requests were inquired successfully.",
        "type": "SUCCESS"
    },
    "object": {
        "type": "ContactVerification",
        "summary": 2
    },
    "data": [
        {
            "created": "2021-04-23T11:04:11.000+0200",
            "updated": "2021-05-08T11:05:47.000+0200",
            "messageSend": "2021-06-09T12:40:34.000+0200",
            "failed": "2021-05-23T11:04:12.000+0200",
            "domains": [
                {
                    "name": "example.de",
                    "status": "SUCCESS",
                    "deactivation": "2021-05-08T11:04:11.000+0200"
                }
            ],
            "contact": {
                "id": 23302422,
                "alias": "customer2"
            }
        },
        {
            "created": "2021-07-09T15:08:01.000+0200",
            "updated": "2021-07-24T15:08:24.000+0200",
            "messageSend": "2021-07-21T15:09:33.000+0200",
            "domains": [
                {
                    "name": "example.com",
                    "status": "SUCCESS",
                    "deactivation": "2021-07-24T15:08:01.000+0200"
                }
            ],
            "contact": {
                "id": 23322185,
                "alias": "customer1"
            }
        }
    ]
}

Task code: 0345
Uses Contact Verification object

Keywords

The following keywords are returned by default:

  • confirmed
  • created
  • name
  • failed
  • handle.id
  • message_sent
  • updated
  • domain

The data of the following keywords can be queried with the keyword <key>:

  • status
  • deactivation
  • verification_mail
  • comment
  • action
Request 
<request>
	<auth>
		<user>customer</user>
		<password>password</password>
		<context>4</context>
	</auth>
	<task>
		<code>0345</code>
		<view>
			<offset>0</offset>
			<limit>10</limit>
			<children>0</children>
		</view>
		<where>
			<key>handle.id</key>
			<operator>like</operator>
			<value>233*</value>
		</where>
	</task>
</request>
Response 
<response>
    <result>
        <data>
            <summary>2</summary>
            <handle_verification>
                <handle>
                    <alias>customer2</alias>
                    <id>23302422</id>
                </handle>
                <message_sent>2021-06-09 12:40:34</message_sent>
                <failed>2021-05-23 11:04:12</failed>
                <domain>
                    <name>example.de</name>
                    <status>SUCCESS</status>
                    <deactivation>2021-05-08 11:04:11</deactivation>
                </domain>
                <created>2021-04-23 11:04:11</created>
                <updated>2021-05-08 11:05:47</updated>
            </handle_verification>
            <handle_verification>
                <handle>
                    <alias>customer1</alias>
                    <id>23322185</id>
                </handle>
                <message_sent>2021-07-21 15:09:33</message_sent>
                <domain>
                    <name>example.com</name>
                    <status>SUCCESS</status>
                    <deactivation>2021-07-24 15:08:01</deactivation>
                </domain>
                <created>2021-07-09 15:08:01</created>
                <updated>2021-07-24 15:08:24</updated>
            </handle_verification>
        </data>
        <status>
            <code>S0345</code>
            <text>The domain contact verification requests were inquired successfully.</text>
            <type>success</type>
        </status>
    </result>
    <stid>20210805-app-94974</stid>
</response>