REST API Model

Definitions of objects used in the SheerID REST API

Account

Name Type Description
accountId string
company string
firstName string
lastName string

Affiliation

Name Type Description
attributes string[]
end Unix timestamp (ms)
organizationId long
organizationName string
sourcePersonId string
start Unix timestamp (ms)
type AffiliationType Values: "STUDENT_COLLEGE_BOUND" "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" "CONTRACTOR"
updated Unix timestamp (ms)

AmbiguousOrganizationVerificationError

Name Type Description
code int
message string
organizations Organization[]
propertyName string

Asset

Name Type Description
assetType AssetType Values: "ID_CARD" "DATED_ID_CARD" "OFFICIAL_LETTER" "OTHER" "PAY_STUB" "ACCEPTANCE_LETTER" "CLASS_SCHEDULE" "TRANSCRIPT" "TUITION_RECEIPT" "REGISTRATION_RECEIPT" "INSURANCE_CARD" "DD214" "IRS_SCHEDULE_G_FORM_1120" "IRS_SCHEDULE_K1_FORM_1120S" "IRS_SCHEDULE_K1_FORM_1065" "IRS_SCHEDULE_C_OR_CEZ_PAGE_1" "IRS_SCHEDULE_B1_FORM_1065" "REPORT_CARD" "DBA_REGISTRATION" "BUSINESS_TAX_FORM_PAGE1" "ARTICLES_OF_INCORPORATION" "SECRETARY_OF_STATE_FILING" "VENDOR_STATEMENT" "LEASE_AGREEMENT" "LETTER_OF_AUTHORIZATION" "POWER_OF_ATTORNEY"
assetTypeDescription string
comments Comment[]
created Unix timestamp (ms)
errors Error[]
expires Unix timestamp (ms)
id string
issued Unix timestamp (ms)
name string
purged boolean Values: true false null
reviewer string
size long
status AssetStatus Values: "ACCEPTED" "PENDING_REVIEW" "REJECTED"
type string

AuthorizedVerificationRequest

Name Type Description
expires Unix timestamp (ms)
fields Field[]
id string

BulkCertificationTask

Name Type Description
bulkAllBatchRecordsProcessed boolean Values: true false null
bulkBatchId string
bulkBatchRecordCount integer
bulkBatchRecordsProcessed integer
bulkErrors Map[]
bulkTaskStatus string
created string
type string

CertificationPropertyError

Name Type Description
code int
message string
propertyName string

CertificationRequest

Name Type Description
attribute Attribute
config CertificationRequestConfig
metadata Map of string → string pairs
timestamp Unix timestamp (ms)

CertificationRequestConfig

Name Type Description
consolationRewardIds string[]
metadata Map of string → string pairs
rewardIds string[]

CertificationResponse

Name Type Description
errors Error[]
metadata Map of string → string pairs
request CertificationRequest
requestId string
result boolean Values: true false null
status VerificationStatus Values: "NEW" "OPEN" "PENDING" "COMPLETE"
timestamp Unix timestamp (ms)

ChallengeQuestion

Name Type Description
choices string[]
id string
questionText string

ChallengeQuestionSet

Name Type Description
id string
questions ChallengeQuestion[]

Comment

Name Type Description
created Unix timestamp (ms)
text string
userId string

ConfigurationEntry

Name Type Description
key string
value string

Coupon

Name Type Description
id string
state TokenState Values: "ACTIVE" "EXPIRED" "USED"

Dataset

Name Type Description
affiliationType AffiliationType Values: "STUDENT_COLLEGE_BOUND" "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" "CONTRACTOR"
fields string[]
id string
name string
orgParameters string[]
organization Organization
updated Unix timestamp (ms)

DatasetEntry

Name Type Description
affiliationType AffiliationType Values: "STUDENT_COLLEGE_BOUND" "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" "CONTRACTOR"
expirationDate Unix timestamp (ms)
id string
metadata Map of string → string pairs
organizationId long

DatasetWithStats

Name Type Description
affiliationType AffiliationType Values: "STUDENT_COLLEGE_BOUND" "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" "CONTRACTOR"
entryCount long
fields string[]
id string
name string
orgParameters string[]
organization Organization
updated Unix timestamp (ms)

Error

Name Type Description
code int
message string
propertyName string

ExpiringToken

Name Type Description
expires Unix timestamp (ms)
token string

Field

Name Type Description
name string
required boolean

FieldConfig

Name Type Description
defaultValue string
editable boolean
multiple boolean
name string
pattern Pattern
required boolean
type string
value string
values string[]

FieldNumberRange

Name Type Description
name string
required boolean
type string
values Range

FieldText

Name Type Description
name string
pattern Pattern
required boolean

FieldType

Name Type Description
name string
required boolean
type string

FieldValidator

Name Type Description
name string
required boolean

Namespace

Name Type Description
name string
templateId string

Notification

Name Type Description
eventType EventType Values: "CREATE" "SYNCHRONOUS_UPDATE" "ASYNCHRONOUS_UPDATE" "DEACTIVATE" "DATA_EXPIRATION"
notifierId string
notifierType NotifierType Values: "EMAIL" "HTTP" "SYSTEM_OUT" "NEXTERNAL"
requestId string
responseId string
success boolean
timestamp Unix timestamp (ms)
verificationResponseResultCode VerificationResponseResultCode Values: "DISAPPROVED" "APPROVED" "VERIFICATION_SOURCE_UNAVAILABLE" "INSUFFICIENT_DATA" "EXPIRED" "REVOKED" "NOT_APPROVED" "INCONCLUSIVE"
verificationStatus VerificationStatus Values: "NEW" "OPEN" "PENDING" "COMPLETE"

NotificationEmail

Name Type Description
address string
eventType EventType Values: "CREATE" "SYNCHRONOUS_UPDATE" "ASYNCHRONOUS_UPDATE" "DEACTIVATE" "DATA_EXPIRATION"
notifierId string
notifierType NotifierType Values: "EMAIL" "HTTP" "SYSTEM_OUT" "NEXTERNAL"
requestId string
responseId string
subject string
success boolean
timestamp Unix timestamp (ms)
verificationResponseResultCode VerificationResponseResultCode Values: "DISAPPROVED" "APPROVED" "VERIFICATION_SOURCE_UNAVAILABLE" "INSUFFICIENT_DATA" "EXPIRED" "REVOKED" "NOT_APPROVED" "INCONCLUSIVE"
verificationStatus VerificationStatus Values: "NEW" "OPEN" "PENDING" "COMPLETE"

NotificationHttp

Name Type Description
eventType EventType Values: "CREATE" "SYNCHRONOUS_UPDATE" "ASYNCHRONOUS_UPDATE" "DEACTIVATE" "DATA_EXPIRATION"
notifierId string
notifierType NotifierType Values: "EMAIL" "HTTP" "SYSTEM_OUT" "NEXTERNAL"
requestId string
responseId string
statusCode integer
success boolean
timestamp Unix timestamp (ms)
url string
verificationResponseResultCode VerificationResponseResultCode Values: "DISAPPROVED" "APPROVED" "VERIFICATION_SOURCE_UNAVAILABLE" "INSUFFICIENT_DATA" "EXPIRED" "REVOKED" "NOT_APPROVED" "INCONCLUSIVE"
verificationStatus VerificationStatus Values: "NEW" "OPEN" "PENDING" "COMPLETE"

Notifier

Name Type Description
config Map of string → string pairs
filters NotifierFilter[]
id string
tags string[]
type string

NotifierFilter

Name Type Description
eventType EventType Values: "CREATE" "SYNCHRONOUS_UPDATE" "ASYNCHRONOUS_UPDATE" "DEACTIVATE" "DATA_EXPIRATION"
result VerificationResult Values: "TRUE" "FALSE" "UNKNOWN"
status VerificationStatus Values: "NEW" "OPEN" "PENDING" "COMPLETE"
templateId string
tier integer
verificationType VerificationType Values: "HONOR_SYSTEM" "VALIDATION" "IP_ADDRESS" "EMAIL_LOOP" "AUTHORITATIVE" "SSO" "ASSET_REVIEW"
verificationTypeOfRecord VerificationType Values: "HONOR_SYSTEM" "VALIDATION" "IP_ADDRESS" "EMAIL_LOOP" "AUTHORITATIVE" "SSO" "ASSET_REVIEW"

Organization

Name Type Description
accountId string
active boolean
aliases string[]
city string
country string
emailDomains string[]
id long
ips string[]
name string
state string
street string
tags string[]
type OrganizationType Values: "UNIVERSITY" "MEMBERSHIP" "MILITARY" "FIRST_RESPONDER" "MEDICAL" "NON_PROFIT" "CORPORATE" "K12"
zip string

Person

Name Type Description
fields Map of string → string pairs

Range

Name Type Description
max long
min long

ReferenceToken

Name Type Description
expires Unix timestamp (ms)
reference string
token string

Report

Name Type Description
id string
requestTimestamp Unix timestamp (ms)
status ReportStatus Values: "CREATED" "REPORTING" "COMPLETE" "ERROR"

ReportBreakdown

Name Type Description
accountId string
count long
date string
error string
organizationType string
result string
verificationType string

ResultWrapper

Name Type Description
result boolean

Reward

Name Type Description
data Map of string → string pairs
id string
name string

RewardPool

Name Type Description
id string
name string
warnThreshold int

RewardPoolEntryResult

Name Type Description
entriesAdded int

RewardPoolWithStats

Name Type Description
id string
name string
remainingEntries int
totalEntries int
warnThreshold int

SearchResult

Name Type Description
results object[]
totalCount int

Statement

Name Type Description
fieldType string
id string
label string
operator string
value string

ThinOrganization

Name Type Description
id long
name string

ThinOrganizationWithLocation

Name Type Description
city string
id long
name string
state string
zip string

Token

Name Type Description
token string

URLReference

Name Type Description
name string
url string

User

Name Type Description
accountId string
email string
firstName string
friendlyName string
id string
lastName string
roles UserRole[] Values: "ACCOUNT_OWNER" "CONFIGURATION_ADMIN" "DEVELOPER" "MICROCENTER_ADMIN" "PRODUCTION_USER" "PUPPET_MASTER" "PUPPET" "PURGER" "REPORTER" "RESOURCE_MANAGER" "REST_USER" "REVIEWER" "REVIEWER_ADMIN" "REVIEWER_MANAGER" "REVIEW_REPORTER" "REWARD_ADMIN" "STAFF_REVIEW_REPORTER" "STAFF" "TEMPLATE_ADMIN" "USER" "USER_ADMIN" "BULK_VERIFIER" "PERSON_DATA" "MSHUP" "ORGANIZATION_MANAGER" "PROMOTION_MANAGER" "CUSTOMER_SERVICE" "TRIAL_USER"
username string

VerificationRequest

Name Type Description
active boolean Values: true false null
assetMap Map of string → string pairs
config VerificationRequestConfig
expirationDate Unix timestamp (ms)
metadata Map of string → string pairs
organization Organization
personId string
revisions integer
timestamp Unix timestamp (ms)
userId string

VerificationRequestConfig

Name Type Description
affiliationTypes AffiliationType[] Values: "STUDENT_COLLEGE_BOUND" "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" "CONTRACTOR"
assetTypes AssetType[] Values: "ID_CARD" "DATED_ID_CARD" "OFFICIAL_LETTER" "OTHER" "PAY_STUB" "ACCEPTANCE_LETTER" "CLASS_SCHEDULE" "TRANSCRIPT" "TUITION_RECEIPT" "REGISTRATION_RECEIPT" "INSURANCE_CARD" "DD214" "IRS_SCHEDULE_G_FORM_1120" "IRS_SCHEDULE_K1_FORM_1120S" "IRS_SCHEDULE_K1_FORM_1065" "IRS_SCHEDULE_C_OR_CEZ_PAGE_1" "IRS_SCHEDULE_B1_FORM_1065" "REPORT_CARD" "DBA_REGISTRATION" "BUSINESS_TAX_FORM_PAGE1" "ARTICLES_OF_INCORPORATION" "SECRETARY_OF_STATE_FILING" "VENDOR_STATEMENT" "LEASE_AGREEMENT" "LETTER_OF_AUTHORIZATION" "POWER_OF_ATTORNEY"
consolationRewardIds string[]
locale Locale
metadata Map of string → string pairs Shim to return VerificationModel logic name in metadata when overridden so that it does not get reverted on template update
notifierIds string[]
rewardIds string[]
verificationTypes VerificationType[] Values: "HONOR_SYSTEM" "VALIDATION" "IP_ADDRESS" "EMAIL_LOOP" "AUTHORITATIVE" "SSO" "ASSET_REVIEW"

VerificationRequestTemplate

Name Type Description
active boolean
begins Unix timestamp (ms)
config VerificationRequestConfig
created Unix timestamp (ms)
expires Unix timestamp (ms)
id string
metadata Map of string → string pairs
name string

VerificationResponse

Name Type Description
affiliations Affiliation[]
errors Error[]
inactiveAffiliations Affiliation[]
metadata Map of string → string pairs
request VerificationRequest
requestId string
result boolean Values: true false null
status VerificationStatus Values: "NEW" "OPEN" "PENDING" "COMPLETE"
timestamp Unix timestamp (ms)

VerificationUserResponse

Name Type Description
type string

VerificationUserResponseData

Name Type Description
data Map of string → string pairs
type string

VerificationUserResponseResult

Name Type Description
data boolean
type string

VerificationUserResponseUploadToken

Name Type Description
data Token
type string