Introduction

This guide will help you get started with Email Warrant! There isn't much to getting started; we have worked to make everything as simple as possible, but should you have any questions, always feel free to reach out to [email protected].

How does it work?

Email Warrant takes an email domain you send to us and checks it against our database of verified domains.

If the domain you sent us matches one in our database, we will send back the response Verified along with the type of domain (Current this is only going to be student, but we are working on adding military and health care).

Verification Types

Using Email Warrant, you can check to see if an email domain belongs to:

1. Students / Teachers

2. Military Personnel - Coming June 2020.

We started with student email verification as we know it best due to our years of experience running the student discount site, Student App Centre.

What does the API look like?

Sending the initial API request is simple and only requires your User Id, API Key, and of course the domain. Here is an example of what the request should look like:

https://api.emailwarrant.com/v1/verify.php?userID=43254353&apiKey=4545634&domain=canterbury.ac.uk

In response to my request above, I will be sent the following:

{
	"status": "success",
	"result": {
		"domain": "verified",
		"type": "student",
		"usage": {
			"remainingCalls": 95281,
			"usedCalls": 4719,
			"totalCalls": "100000",
			"renewalDate": "2020-06-12"
		}
	}
}

How to try out the api?

Getting started with using the API couldn't be simpler. All you need to do is make a GET request in the below formate:

https://api.emailwarrant.com/v1/verify.php?userID=<Enter your User ID>&apiKey=<Enter your API Key>&domain=<Enter the domain to be tested>

You can even test out your request by pasting it right into your browsers address bar. Once the page has loaded, you will be shown the response to your request.

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