<- Back to Email Warrant
Pricing
Introduction
Sending an API Request
Example Code
PHP
JavaScript + JQuery
Node
More Information
Changelog
Powered by GitBook

Sending an API Request

Getting started with your first API request to Email Warrant

We have worked to make the Email Warrant API as simple and straightforward as possible. You could be sending your first API request in a matter of minutes.

get
Verify a Domain

https://api.emailwarrant.com/v1/verify.php?/domain=<domain>&userID=<userID>&apiKey=<apiKey>
Request
Response
Request
Query Parameters
domain
required
string
The is the domain you want us to verify.
userID
required
string
This is your unique id and can be found on your account page.
apiKey
required
string
An API Key is kind of like a password, and so you should keep this private. Your API key can be found on your account page.
Response
200: OK
If everything goes smoothly, you will be sent back the following:
// If the domain is verified you will be sent the following back:
{
   "status":"success",
   "result":{
      "domain":"verified",
      "type":"student",
      "usage":{
         "remainingCalls":45,
         "usedCalls":5,
         "totalCalls":50,
         "renewalDate":"May 22 2029"
      }
   }
}
​
// If the domain is NOT verified you will be sent the following back:
{
   "status":"success",
   "result":{
      "domain":"rejected",
      "type":"unknown",
      "usage":{
         "remainingCalls":45,
         "usedCalls":5,
         "totalCalls":50,
         "renewalDate":"May 22 2029"
      }
   }
}
400: Bad Request
If you have forgotten to include any of the query parameters we will send you back and error along with a list of what was missing.
{
   "status":"error",
   "issue":"query parameters missing"
}
401: Unauthorized
If you have included both an API Key and User ID, but they don't match, we will send you back a 401 error to inform you of the issue.
{
   "status":"error",
   "issue":"user id or api key is incorrect"
}
403: Forbidden
If you have reached your API limit for the current period, we will return a Forbidden error to you along with a message explaining the issue.
{
   "status":"error",
   "issue":"no api credits remaining"
}

Don't have an API Key? Get one here.

​

Previous
Introduction
Next - Example Code
PHP
Last updated 5 months ago