Making requests

Postman collection

Postman is a desktop and web application that allows you to make requests to an API from a graphical user interface. We recommend using Postman with WhoisXML APIs endpoints when exploring the APIs functionality, as well as when you are troubleshooting issues with your application.

The WhoisXML API Postman collection is available at the following links:

• https://www.postman.com/whoisxmlapi-llc?tab=collections
• postman.whois.xml.api.zip

The collection includes a preconfigured environment. You will need to set up the api_key variable to fire each request. Get your personal API KEY on the My products page. If you have questions related to the API, contact us.

Create a new request

In order to check lists of emails with the Bulk API, first upload the emails to the server which will create a request and return its ID to you. Then you can use this ID to query the request's status, download results etc.

The API expects parameters to be JSON-encoded in the body of each request.

CURL request sample

curl https://emailverification.whoisxmlapi.com/api/bevService/request -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "emails": ["[email protected]", "[email protected]", "[email protected]"], "format": "json"}'

POST request body sample

{
    "apiKey": "YOUR_API_KEY",
    "emails": [
        "[email protected]",
        "[email protected]",
        "[email protected]"
    ],
    "format": "json"
}

Input parameters

Sample output

{
    "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.