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.

Base URL

The base URL for the CoReg API is https://coreg.us.sjapis.com/api.

Requests

The CoReg API is RESTful.

Responses

Responses are returned in JSON format.

Authentication

The following is a sample request using ApiKey authentication.

curl -X GET \
'https://coreg.us.sjapis.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.

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 duplicate is returned if the user is already registered to Survey Junkie or is already coregistered. 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://coreg.us.sjapis.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.

Body Arguments

device_platform

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

Get PreCheck

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

curl -X GET \
'https://coreg.us.sjapis.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.

URL Parameters

device_platform

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

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.

The following also checks 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 duplicate is returned if the user is already registered to Survey Junkie or already is coregistered. 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://coreg.us.sjapis.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.

Body Arguments

device_platform

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

Get Email

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

curl -X GET \
'https://coreg.us.sjapis.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.

URL Parameters

device_platform

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