Api
====

Real Time API
`````````````````

**Request Method :** GET

**Endpoint :** https://emailvalidators.com/api/v1/single/check?api={api_key}&username={username}&email={email}&timeout=10


Parameters
^^^^^^^^^^^^^


.. list-table:: 
   :widths: 10 20 20 20
   :header-rows: 1

   * - Name
     - Type 
     - Description
     - Required
   * - | api
     - | String
     - | The api key of your account
     - | True

   * - | username
     - | String
     - | The username of your account
     - | True

   * - | email
     - | String
     - | Email Address Which Need to verify
     - | True

   * - | timeout
     - | Number
     - | Max Request validity time
     - | True
     
     

Api Results
^^^^^^^^^^^^^

.. list-table:: 
   :widths: 10 20 
   :header-rows: 1

   * - Name
     - Result

   * - | email
     - | the email address you had tested

   * - | status
     - | success|fail

   * - | result
     - | Valid, CatchAll, Unknown, Disposable, Bounce
     
   * - | role
     - | True|False, if true it indicates the email address is not directly
       | linked to a person but a role, like sales, support...

   * - | error
     - | (if status was fail) describes why the query failed,
       | -Required parameter missing or invalid.
       | -User authentication failed. Wrong API Key or username.
       | -Email Format is not correct.
       | -The request was refused due to insufficent credit.



Curl
^^^^^^^^^^^^

.. code-block:: bash

        curl --request GET 'https://emailvalidators.com/api/v1/single/check?api=your_api_key&username=your_username&email=sampleuser@example.com&timeout=10'


Java
^^^^^^^^^

.. code-block:: bash

        OkHttpClient client = new OkHttpClient().newBuilder()
        .build();
        Request request = new Request.Builder()
        .url("https://emailvalidators.com/api/v1/single/check?api=your_api_key&username=your_username&email=sampleuser@example.com&timeout=10")
        .method("GET", null)
        .build();
        Response response = client.newCall(request).execute();



Php
^^^^^^^^^^^^

.. code-block:: bash

        <?php
        require_once 'HTTP/Request2.php';
        $request = new HTTP_Request2();
        $request->setUrl('https://emailvalidators.com/api/v1/single/check?api=your_api_key&username=your_username&email=sampleuser@example.com&timeout=10');
        $request->setMethod(HTTP_Request2::METHOD_GET);
        $request->setConfig(array(
        'follow_redirects' => TRUE
        ));
        try {
        $response = $request->send();
        if ($response->getStatus() == 200) {
        echo $response->getBody();
        }
        else {
        echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
        $response->getReasonPhrase();
        }
        }
        catch(HTTP_Request2_Exception $e) {
        echo 'Error: ' . $e->getMessage();
        }


Python
^^^^^^^^^

.. code-block:: bash

        import http.client
        import mimetypes
        conn = http.client.HTTPSConnection("emailvalidators.com")
        payload = {}
        headers = {}
        conn.request("GET", "/api/v1/single/check?api=your_api_key&username=your_username&email=sampleuser@example.com&timeout=10", payload, headers)
        res = conn.getresponse()
        data = res.read()
        print(data.decode("utf-8"))


Nodejs
^^^^^^^^^

.. code-block:: bash


                var request = require('request');
                var options = {
                'method': 'GET',
                'url': 'https://emailvalidators.com/api/v1/single/check?api=your_api_key&username=your_username&email=sampleuser@example.com&timeout=10',
                };
                request(options, function (error, response) {
                if (error) throw new Error(error);
                console.log(response.body);
                });


File Transfer API
```````````````````

Upload & Process Files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Request Method :** GET

**Endpoint :** https://emailvalidators.com/api/v1/jobs/create?api={api_key}&username={username}&file_name={remote_url}&timeout=10


Parameters
-----------------------

.. list-table:: 
   :widths: 10 20 20 20
   :header-rows: 1

   * - Name
     - Type 
     - Description
     - Required
   * - | api
     - | String
     - | The api key of your account
     - | True

   * - | username
     - | String
     - | The username of your account
     - | True

   * - | file_name
     - | String
     - | Downloadable remote hosted file
     - | True

   * - | timeout
     - | Number
     - | Max Request validity time
     - | True

     
    

Api Results (Json)
-----------------------

.. list-table:: 
   :widths: 10 20 
   :header-rows: 1

   * - Name
     - Result

   * - | status
     - | success|fail

   * - | job_id
     - | a unique id to access job result in future
     
   * - | error
     - | (if status was fail) describes why the query failed,
       | - Required parameter missing or invalid.
       | - User authentication failed. Wrong API Key or username.
       | - The request was refused due to insufficent credit.
       | - File is not downloadable.
       | - File Format is not correct.



Curl
-----------------------

.. code-block:: bash

        curl --request GET 'https://emailvalidators.com/api/v1/jobs/create?api=your_api_key&username=your_username&file_name=remote_file_url&timeout=10'


Java
-----------------------

.. code-block:: bash

        OkHttpClient client = new OkHttpClient().newBuilder()
        .build();
        Request request = new Request.Builder()
          .url("https://emailvalidators.com/api/v1/jobs/create?api=your_api_key&username=your_username&file_name=remote_file_url&timeout=10")
          .build();
        Response response = client.newCall(request).execute();


Php 
-----------------------

.. code-block:: bash

        <?php
        require_once 'HTTP/Request2.php';
        $request = new HTTP_Request2();
        $request->setUrl('https://emailvalidators.com/api/v1/jobs/create?api=your_api_key&username=your_username&file_name=remote_file_url&timeout=10');
        $request->setMethod(HTTP_Request2::METHOD_GET);
        $request->setConfig(array(
        'follow_redirects' => TRUE
        ));
        try {
          $response = $request->send();
          if ($response->getStatus() == 200) {
            echo $response->getBody();
          }
          else {
            echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
            $response->getReasonPhrase();
          }
        }
        catch(HTTP_Request2_Exception $e) {
          echo 'Error: ' . $e->getMessage();
        }


Python
-----------------------

.. code-block:: bash

        import requests

        url = "https://emailvalidators.com/api/v1/jobs/create?api=your_api_key&username=your_username&file_name=remote_file_url&timeout=10"
        payload = {}
        headers = {}
        response = requests.request("GET", url, headers=headers, data = payload)
        print(response.text.encode('utf8'))

NODEJS
-----------------------

.. code-block:: bash



        var request = require('request');
        var options = {
        'method': 'GET',
        'url': 'https://emailvalidators.com/api/v1/jobs/create?api=your_api_key&username=your_username&file_name=remote_file_url&timeout=10',
        };
        request(options, function (error, response) {
        if (error) throw new Error(error);
        console.log(response.body);
        });


Check Status
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Request Method :** GET

**Endpoint :** https://emailvalidators.com/api/v1/jobs/status?api={api_key}&username={username}&job_id={job_id}


PARAMETERS
-----------------------

.. list-table:: 
   :widths: 10 20 20 20
   :header-rows: 1

   * - Name
     - Type 
     - Description
     - Required
   * - | api
     - | String
     - | The api key of your account
     - | True

   * - | username
     - | String
     - | The username of your account
     - | True.

   * - | job_id
     - | Number
     - | JobId to check status
     - | True

     
    

Api Results (Json)
-----------------------

.. list-table:: 
   :widths: 10 20 
   :header-rows: 1

   * - Name
     - Result

   * - | status
     - | success|processing|fail

   * - | error
     - | (if status was fail) describes why the query failed,
       | - This Job Id not associated to your users.
       | - Required parameter missing or invalid
       | - User authentication failed. Wrong API Key or username.



Curl
-----------------------

.. code-block:: bash

        curl --request GET 'https://emailvalidators.com/api/v1/jobs/status?api=your_api_key&username=your_username&job_id=your_job_id'


Java
-----------------------

.. code-block:: bash

        OkHttpClient client = new OkHttpClient().newBuilder()
        .build();
        Request request = new Request.Builder()
          .url("https://emailvalidators.com/api/v1/jobs/status?api=your_api_key&username=your_username&job_id=your_job_id")
          .method("GET", null)
          .build();
        Response response = client.newCall(request).execute();


Php
-----------------------

.. code-block:: bash

        <?php
        require_once 'HTTP/Request2.php';
        $request = new HTTP_Request2();
        $request->setUrl('https://emailvalidators.com/api/v1/jobs/status?api=your_api_key&username=your_username&job_id=your_job_id');
        $request->setMethod(HTTP_Request2::METHOD_GET);
        $request->setConfig(array(
        'follow_redirects' => TRUE
        ));

        try {
          $response = $request->send();
          if ($response->getStatus() == 200) {
            echo $response->getBody();
          }
          else {
            echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
            $response->getReasonPhrase();
          }
        }
        catch(HTTP_Request2_Exception $e) {
          echo 'Error: ' . $e->getMessage();
        }


Python
-----------------------

.. code-block:: bash

        import requests

        url = "https://emailvalidators.com/api/v1/jobs/status?api=your_api_key&username=your_username&job_id=your_job_id"

        payload = {}
        headers = {}
        response = requests.request("GET", url, headers=headers, data = payload)

        print(response.text.encode('utf8'))

NODEJS
-----------------------

.. code-block:: bash



        var request = require('request');
        var options = {
        'method': 'GET',
        'url': 'https://emailvalidators.com/api/v1/jobs/status?api=your_api_key&username=your_username&job_id=your_job_id',
        };
        request(options, function (error, response) {
        if (error) throw new Error(error);
        console.log(response.body);
        });


Download Results
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Request Method :** GET

**Endpoint :** https://emailvalidators.com/api/v1/jobs/download?api={api_key}&username={username}&job_id={job_id}


Parameters
-----------------------

.. list-table:: 
   :widths: 10 20 20 20
   :header-rows: 1

   * - NAME
     - Type 
     - Description
     - Required
   * - | api
     - | String
     - | The api key of your account
     - | True

   * - | username
     - | String
     - | The username of your account
     - | True

   * - | job_id
     - | Number
     - | JobId to download results
     - | True

     
    

Api Results (Json)
-----------------------

.. list-table:: 
   :widths: 10 20 
   :header-rows: 1

   * - Name
     - Result

   * - | status
     - | success|fail

   * - | result
     - | It will return emaillist.csv file with "Email","Name","Status","Role Based Emails" columns.
     
   * - | error
     - | (if status was fail) describes why the query failed,
       | - This Job Id not associated to your users.
       | - List is currently Processing. Please wait some times.
       | - Required parameter missing or invalid
       | - User authentication failed. Wrong API Key or username.



Curl
-----------------------

.. code-block:: bash

        curl --request GET 'https://emailvalidators.com/api/v1/jobs/download?api=your_api_key&username=your_username&job_id=your_job_id'


Java
-----------------------

.. code-block:: bash

        OkHttpClient client = new OkHttpClient().newBuilder()
        .build();
        Request request = new Request.Builder()
          .url("https://emailvalidators.com/api/v1/jobs/download?api=your_api_key&username=your_username&job_id=your_job_id")
          .method("GET", null).build();
        Response response = client.newCall(request).execute();


Php 
-----------------------

.. code-block:: bash


        <?php
        require_once 'HTTP/Request2.php';
        $request = new HTTP_Request2();
        $request->setUrl('https://emailvalidators.com/api/v1/jobs/download?api=your_api_key&username=your_username&job_id=your_job_id');
        $request->setMethod(HTTP_Request2::METHOD_GET);
        $request->setConfig(array(
        'follow_redirects' => TRUE
        ));
        try {
          $response = $request->send();
          if ($response->getStatus() == 200) {
            echo $response->getBody();
          }
          else {
            echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
            $response->getReasonPhrase();
          }
        }
        catch(HTTP_Request2_Exception $e) {
          echo 'Error: ' . $e->getMessage();
        }


Python
-----------------------

.. code-block:: bash

        import requests

        url = "https://emailvalidators.com/api/v1/jobs/download?api=your_api_key&username=your_username&job_id=your_job_id"

        payload = {}
        headers = {}
        response = requests.request("GET", url, headers=headers, data = payload)

        print(response.text.encode('utf8'))

Nodejs
-----------------------

.. code-block:: bash


        var request = require('request');
        var options = {
        'method': 'GET',
        'url': 'https://emailvalidators.com/api/v1/jobs/download?api=your_api_key&username=your_username&job_id=your_job_id',
        };
        request(options, function (error, response) {
        if (error) throw new Error(error);
        console.log(response.body);
        });