Reference

Development resources for the SheerID REST API and JavaScript library.

API Reference

For an introduction to the SheerID REST API, take a look at REST API.

For the complete reference, see:

Required Fields

We strive to keep the number of required fields to a minimum for each verification type.

Some fields may not be used as determinative factors in a verification, yet may still be required. For example, we don’t need a person’s email address to identify their student status, but we do need it to send them an offer code. Or a field may not be used in an instant verification, but we will need it if the verification requires a manual review.

This reference will help you determine the minimum number of fields you need to capture per targeted segment. If you are running multiple offers across differrent segments, you may wish to gather fields that are optional for one segment but required for another, to assist in your retargeting activities.

Student

Submit data for a student verification. (API Reference)
Field Required? Description
firstName Yes The first name of the person being verified.
lastName Yes The last name of the person being verified.
email Yes The email address of the person being verified.
birthDate Yes The date of birth of the person being verified (format YYYY-MM-DD). Date must be greater than 1900-01-01.
organization Yes An organization that can be used for instant verification of various segments (Student, Teacher, Military, etc.).
ipAddress No Strongly recommended. Including end-user IP Address greatly enhances fraud prevention.
metadata No A collection of custom metadata to be stored with the verification. Learn more: Metadata Options
marketConsent No Whether marketing consent is accepted. Learn more: Marketing Consent

Active Military

The active military and branch of service data collected from the user to be verified (API Reference)
Field Required? Description
firstName Yes The first name of the person being verified.
lastName Yes The last name of the person being verified.
email Yes The email address of the person being verified.
birthDate Yes The date of birth of the person being verified (format YYYY-MM-DD). Date must be greater than 1900-01-01.
organization Yes An organization that can be used for instant verification of various segments (Student, Teacher, Military, etc.).
ipAddress No Strongly recommended. Including end-user IP Address greatly enhances fraud prevention.
metadata No A collection of custom metadata to be stored with the verification. Learn more: Metadata Options
marketConsent No Whether marketing consent is accepted. Learn more: Marketing Consent

Inactive Military

The inactive duty and branch of service data collected from the user to be verified (API Reference)
Field Required? Description
firstName Yes The first name of the person being verified.
lastName Yes The last name of the person being verified.
email Yes The email address of the person being verified.
birthDate Yes The date of birth of the person being verified (format YYYY-MM-DD). Date must be greater than 1900-01-01.
organization Yes An organization that can be used for instant verification of various segments (Student, Teacher, Military, etc.)
dischargeDate Yes The date the person being verified was discharged from the military.
ipAddress No Strongly recommended. Including end-user IP Address greatly enhances fraud prevention.
metadata No A collection of custom metadata to be stored with the verification. Learn more: Metadata Options
marketConsent No Whether marketing consent is accepted. Learn more: Marketing Consent

Teacher

A teacher to be verified. (API Reference)
Field Required? Description
firstName Yes The first name of the person being verified.
lastName Yes The last name of the person being verified.
email Yes The email address of the person being verified.
organization Yes An organization that can be used for instant verification of various segments (Student, Teacher, Military, etc.).
birthDate No The date of birth of the person being verified (format YYYY-MM-DD). Date must be greater than 1900-01-01.
ipAddress No Strongly recommended. Including end-user IP Address greatly enhances fraud prevention.
metadata No A collection of custom metadata to be stored with the verification. Learn more: Metadata Options
marketConsent No Whether marketing consent is accepted. Learn more: Marketing Consent

Senior

A senior to be verified. (API Reference)
Field Required? Description
firstName Yes The first name of the person being verified.
lastName Yes The last name of the person being verified.
email Yes The email address of the person being verified.
birthDate Yes The date of birth of the person being verified (format YYYY-MM-DD). Date must be greater than 1900-01-01.
postalCode Yes The postal code for the person being verified.
ipAddress No Strongly recommended. Including end-user IP Address greatly enhances fraud prevention.
metadata No A collection of custom metadata to be stored with the verification. Learn more: Metadata Options
marketConsent No Whether marketing consent is accepted. Learn more: Marketing Consent

First Responder

A first responder to be verified. (API Reference)
Field Required? Description
firstName Yes The first name of the person being verified.
lastName Yes The last name of the person being verified.
email Yes The email address of the person being verified.
organization Yes An organization that can be used for instant verification of various segments (Student, Teacher, Military, etc.).
birthDate No The date of birth of the person being verified (format YYYY-MM-DD). Date must be greater than 1900-01-01.
status No The first responder status. One of "POLICE", "EMT", or "FIREFIGHTER."
ipAddress No Strongly recommended. Including end-user IP Address greatly enhances fraud prevention.
metadata No A collection of custom metadata to be stored with the verification. Learn more: Metadata Options
marketConsent No Whether marketing consent is accepted. Learn more: Marketing Consent

Medical Professional

A medical professional to be verified. (API Reference)
Field Required? Description
firstName Yes The first name of the person being verified.
lastName Yes The last name of the person being verified.
email Yes The email address of the person being verified.
birthDate Yes The date of birth of the person being verified (format YYYY-MM-DD). Date must be greater than 1900-01-01.
postalCode Yes The postal code for the person being verified.
organization Yes An organization that can be used for instant verification of various segments (Student, Teacher, Military, etc.).
status No The medical professional status. Currently, "NURSE" is the only allowed status.
ipAddress No Strongly recommended. Including end-user IP Address greatly enhances fraud prevention.
metadata No A collection of custom metadata to be stored with the verification. Learn more: Metadata Options
marketConsent No Whether marketing consent is accepted. Learn more: Marketing Consent

JavaScript Library Reference

For an introduction to the SheerID Javascript library, take a look at our JavaScript Library getting started guide.

For details on the available functions and methods, see: JavaScript Library Reference

Flow Diagrams

Verification flows conform to the same basic principles, regardless of the segment. However, certain steps may vary slightly, as information requirements are different from segment to segment. The diagrams below show the specific flow diagrams for segments supported by the SheerID self-service app and corresponding 2.0 JavaScript and REST APIs.

US Student

Verify US college student status from our data sources including over 20 million students.

Student Flow

Military

Verify active military, veterans and retirees in the US from our database of over 28 million.

Military Flow

Senior (Age Verification)

Verify US seniors from our data sources including over 108 million US persons over 50. Available for any age over 18.

Senior Flow

First Responder

Verify First Responders from our database of over 1.5 million police, EMTs, and firefighters in the US.

First Responder Flow

Teacher

Verify users from our database of over 3 million teachers and 1 million faculty members at institutions of higher learning.

Teacher Flow

Medical Professional

Verify Medical Professionals from our database of over 4 million registered nurses in the US.

Medical Professional Flow