NAV Navbar

CoReg API Overview

Last Updated: 4/20/2020

Welcome to the CoReg API documentation. This API verifies if an email address is valid by checking email format, as well as checking if the email address already exists in our system and/or exists on email address lists submitted by CoRegs.

You can run the requests included in this documentation using Postman, a third-party tool. Download Postman prior to clicking the button below.

Run in Postman

Base URL

The base URL for the CoReg API is https://www.surveyjunkie.com/api

Requests

The CoReg API is RESTful and uses the methods POST and GET.

Responses

Responses are returned in JSON format.

Authentication

The following is a sample request using ApiKey authentication.

curl -X GET \
'https://www.surveyjunkie.com/api/v1/coreg/precheck?email=example@example.com' \
-H 'Authorization: ApiKey {uniqueApiKey}'

All requests must be authenticated using an API Key handed in cURL requests as a header.

How to Obtain an API Key

An API Key will be provided to use the API. If one has not been provided, contact your account manager.

Errors

The CoReg API uses standard HTTP status codes.

HTTP Status Message Description
401 Unauthorized The request must include valid authentication. Refer to the Authentication section for more information.
422 Unprocessable Entity The request cannot be processed.

PreCheck

The CoReg API verifies if an email address is valid. PreCheck requests check if the email address is valid, exists in our system, and exists in the list of email addresses submitted by CoRegs.

To validate the email against Email Oversight in addition to all of the criteria listed above, use one of the Email request instead.

PreCheck Object

The following is a 200 response example.

{
    "status": "success",
    "reason": null
}

This request returns a status and reason.

status

Possible statuses returned are failed and success.

reason

Possible reasons returned are system offline, null, and duplicate. The value null is returned for reason when the status is success.

Create PreCheck

The following POST request will check the validity of an email address.

curl -X POST \
'https://www.surveyjunkie.com/api/v1/coreg/precheck' \
-d '{"email": "example@example.com"}' \
-H 'Content-Type:application/json' \
-H 'Authorization:ApiKey {uniqueApiKey}'

This request checks the validity of an email address using a POST request.

Method URL
POST /v1/coreg/precheck

Body Arguments

Attribute Type Description
device_platform string The device that a user initially signed up on. Refer to the table below for more information.
email required string The email address to be checked.
first_name string The first name of the individual who owns the email address.
last_name string The last name of the individual who owns the email address.
ip string The IP address associated with the email address. This IP address must be in ipv4 format. ipv6 format is not accepted.
sub_affiliate string The name of the secondary affiliate.

device_platform

This optional field abides by WURFL standard. Note that requests with the device_platform value Robot will be rejected.

Values
Desktop
Feature Phone
Smart-TV
Smartphone
Tablet
Other Mobile
Robot

Get PreCheck

The following GET request will check the validity of an email address.

curl -X GET \
'https://www.surveyjunkie.com/api/v1/coreg/precheck?email=example@example.com' \
-H 'Authorization:ApiKey {uniqueApiKey}'

This request checks the validity of an email address using a GET request.

Method URL
GET /v1/coreg/precheck

URL Parameters

Attribute Type Description
device_platform string The device that a user initially signed up on. Refer to the table below for more information.
email required string The email address to be checked.
first_name string The first name of the individual who owns the email address.
last_name string The last name of the individual who owns the email address.
ip string The IP address associated with the email address. This IP address must be in ipv4 format. ipv6 format is not accepted.
sub_affiliate string The name of the secondary affiliate.

device_platform

This optional field abides by WURFL standard. Note that requests with the device_platform value Robot will be rejected.

Values
Desktop
Feature Phone
Smart-TV
Smartphone
Tablet
Other Mobile
Robot

Email

The CoReg API verifies if an email address is valid. PreCheck requests check if the email address is valid, exists in our system, and exists email address lists submitted by CoRegs.

In addition to this, the following POST and GET requests also check the email address against Email Oversight.

Email Object

The following is a 200 response example.

{
    "status": "success",
    "reason": null
}

Requests to the Email endpoint return a response that includes status and reason.

status

Possible statuses returned are failed and success.

reason

Possible reasons returned are system offline, null, and duplicate. The value null is returned when the status is success.

Create Email

The following POST request will check the validity of an email address.

curl -X POST \
'https://www.surveyjunkie.com/api/v1/coreg/email' \
-d '{"email": "example@example.com", "ip": "11.111.111.11"}' \
-H 'Content-Type:application/json' \
-H 'Authorization:ApiKey {uniqueApiKey}'

This request checks the validity of an email address using a POST request.

Method URL
POST /v1/coreg/email

Body Arguments

Attribute Type Description
device_platform string The device that a user initially signed up on. Refer to the table below for more information.
email required string The email address to be checked.
first_name string The first name of the individual who owns the email address.
last_name string The last name of the individual who owns the email address.
ip required string The IP address associated with the email address. This IP address must be in ipv4 format. ipv6 format is not accepted.
sub_affiliate string The name of the secondary affiliate.

device_platform

This optional field abides by WURFL standard. Note that requests with the device_platform value Robot will be rejected.

Values
Desktop
Feature Phone
Smart-TV
Smartphone
Tablet
Other Mobile
Robot

Get Email

The following GET request will check the validity of an email address.

curl -X GET \
'https://www.surveyjunkie.com/api/v1/coreg/email?email=example@example.com&ip=11.111.111.11' \
-H 'Authorization:ApiKey {uniqueApiKey}'

This request checks the validity of an email address using a GET request.

Method URL
GET /v1/coreg/email

URL Parameters

Attribute Type Description
device_platform string The device that a user initially signed up on. Refer to the table below for more information.
email required string The email address to be checked.
first_name string The first name of the individual who owns the email address.
last_name string The last name of the individual who owns the email address.
ip required string The IP address associated with the email address. This IP address must be in ipv4 format. ipv6 format is not accepted.
sub_affiliate string The name of the secondary affiliate.

device_platform

This optional field abides by WURFL standard. Note that requests with the device_platform value Robot will be rejected.

Values
Desktop
Feature Phone
Smart-TV
Smartphone
Tablet
Other Mobile
Robot