> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Our Email Validation API allows retail system integrators the capability to validate one or many email addresses in real time. We offer two options for email validation - frontend (pre-transaction) or backend (post-transaction).
Base URLs:
* https://api-test.flexreceipts-lab.com
* https://api.flexreceipts.com
Email: FlexEngage Support
# Authentication
- HTTP Authentication, scheme: basic All requests are secured with basic authentication. Credentials
are provided with your account information.
Default
## get__email-validation
> Code samples
```shell
# You can also use wget
curl -X GET https://api-test.flexreceipts-lab.com/email-validation?emailAddress=string \
-H 'Accept: application/json'
```
```java
URL obj = new URL("https://api-test.flexreceipts-lab.com/email-validation?emailAddress=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```
```csharp
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <>
/// Example of Http Client
/// <>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <>
/// Setup http client
/// <>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://api-test.flexreceipts-lab.com/email-validation";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
```
```python
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api-test.flexreceipts-lab.com/email-validation', params={
'emailAddress': [
"string"
]
}, headers = headers)
print(r.json())
```
`GET /email-validation`
Parameters
|Name|In|Type|Required|Description|
|---|---|---|---|---|
|emailAddress|query|array[string]|true|List of email addresses to validate.|
> Example responses
> Contains status of the email address validation. Below is a list of email status codes that can be returned in the API response. Emails that have a status of “valid” or “unknown” are recommended for sending emails.
- valid - Email address has been verified to be real and currently accepting emails
- invalid - Email address has been verified to be bad and is not accepting emails
- unknown - Email address’s status cannot be definitely determined.
```json
{
"test@test,com": {
"status": "invalid"
}
}
```
```json
{
"test@test.com": {
"status": "valid"
}
}
```
```json
{
"test@test.com": {
"status": "unknown"
}
}
```
> 403 Response
```json
{
"message": "string",
"code": "string",
"referenceId": "string",
"errors": {
"property1": [
{
"code": "string",
"message": "string"
}
],
"property2": [
{
"code": "string",
"message": "string"
}
]
}
}
```
Responses
|Status|Meaning|Description|Schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Contains status of the email address validation. Below is a list of email status codes that can be returned in the API response. Emails that have a status of “valid” or “unknown” are recommended for sending emails.
- valid - Email address has been verified to be real and currently accepting emails
- invalid - Email address has been verified to be bad and is not accepting emails
- unknown - Email address’s status cannot be definitely determined.|[EmailValidationResponse](#schemaemailvalidationresponse)|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Unauthorized access|[ErrorResponse](#schemaerrorresponse)|
|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|Error will be returned for validation errors.|[ErrorResponse](#schemaerrorresponse)|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Error will be thrown for internal exceptions.|[ErrorResponse](#schemaerrorresponse)|
# Schemas