Create Dataset

Create a new dataset to use for verification

Request Details

HTTP Method(s)

POST

Resource URI

https://services-sandbox.sheerid.com/rest/0.5/dataset

Accepted Content Type(s)

application/x-www-form-urlencoded

Parameters

Name Type Description
affiliationType AffiliationType the type of affiliation represented by this dataset, will be added to the verification response upon successful match
Possible values: STUDENT_FULL_TIME, STUDENT_PART_TIME, GRADUATE, ALUMNUS, FACULTY, EMPLOYEE, RESELLER, NON_PROFIT, ACTIVE_DUTY, VETERAN, RESERVIST, MILITARY_FAMILY, MILITARY_RETIREE, DISABLED_VETERAN, CIVILIAN_EMPLOYEE, FIREFIGHTER, POLICE, EMT, NURSE, MEMBER, CUSTOMER, OWNER, BUSINESS, BUSINESS_CONTACT
fields PersonFieldAccessor[] a list of fields that will be used to define a unique dataset entry
matchName boolean false to disable matching of organizationName. If organizationId is supplied or organizationName is not supplied, this parameter is ignored.
name string a reference name for this dataset
orgParameters OrganizationParameter[]
organizationId long an optional organization id, see List Organizations
organizationName string an organization name supplied when the ID is not known. If organizationId is supplied, this parameter is ignored.
organizationType OrganizationType an organization type (see List Organization Types) to help when matching the organization name. If organizationId is supplied or organizationName is not supplied, this parameter is ignored.
Possible values: UNIVERSITY, MEMBERSHIP, MILITARY, FIRST_RESPONDER, MEDICAL, NON_PROFIT, CORPORATE, K12

Response Details

Expected Response

A single Dataset object

Response Content Type(s)

application/json