Create a new request | Documentation | Email Verification Bulk API | WhoisXML API

创建一个新请求

POST https://emailverification.whoisxmlapi.com/api/bevService/request

CURL 请求示例

curl https://emailverification.whoisxmlapi.com/api/bevService/request -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "version": 3, "emails": ["alex@hotmail.edu", "bob@google.com", "mila@yahoo.com"], "format": "json"}'

POST 请求正文示例

{
    "apiKey": "YOUR_API_KEY",
    "version": 3,
    "emails": [
        "alex@hotmail.edu",
        "bob@google.com",
        "mila@yahoo.com"
    ],
    "format": "json"
}

输入参数

API密钥

必填。在我的产品页面获取个人 API KEY。

emails

Required. Array.

Contains array of email addresses for verification.

version

Optional. Number.

Defines the version of the Email Verification API to be used.

Allowed values: 2 and 3.

Default value: 2. Please use version 3 of the API after April 30, 2024.

NOTE: Email Verification API version 2 is being deprecated following the launch of version 3, which provides better stability and more accurate results. To learn more about the new version, please visit this specifications page. After April 30 2024, the v2 API will be discontinued and queries will no longer be served.

格式

选填。字符串。

用于指定响应格式。

允许的值:“xml”、“json”、“csv”。

默认值:“json”。

样本输出

{
    "response": {
        "id": 5
    }
}

Code: 200 OK.
{
    "response": {
        "errors": [
            "The format field should have one of the following values: json, xml."
        ]
    }
}

Code: 400 Bad Request.
{
    "response": {
        "error": "Authorisation or authentication failed"
    }
}

Code: 401 Unauthorized.
{
    "response": {
        "error": "Insufficient balance"
    }
}

Code: 402 Payment Required.
响应

响应对象。

Contains the integer 'id' field on success.

如果出现错误,则会在“错误”字段中包含其描述。如果存在多个错误,则它们的描述将在“errors”数组中返回。

ID

Integer.

Newly created verification request ID.

error

String.

Error description.

errors

Array.

Multiple error messages.