Glossary

Definitions of the terms and fields you’ll encounter across the SheerID API, verification flows, and reports.

Account ID

An identifier for the account that submitted the request.

Confirmed Affiliation Types

The types of affiliations that the individual was determined to have.

currentStep

The current step in the verification.

Data Updated Date

The date the affiliation information was most recently updated by the data source.

document upload

A step in the verification flow that you proceed to if an instant verification fails.

errorIds

If applicable, an array of error IDs indicating a problem with the verification.

Errors

A list of errors encountered during the verification process for this request.

flows

The series of steps you take to complete a verification

Organization Country

The Country(location)of the requested organization

Organization Name

The name of the requested organization.

Organization State

The State(location)of the requested organization

OrganizationEntity ID

The identifier for the requested organization.

OrganizationEntity Type

The type of organization represented by the request.

Period Begin Date

The start of the most recent affiliation status period.

Period End Date

The end of the most recent affiliation status period.

Person ID

A unique string which represents an individual’s identifying data. Can be used to recognize duplicate submissions with the same data.

Request ID

A unique identifier for the request.

Request Timestamp

The date and time of the original request or its most recent revision.

Requested Affiliation Types

The types of affiliations that the request was attempting to verify.

Result

• true — if the individual has been matched in at least one Verification Source and currently has at least one of the requested affiliation types.
• false — if the individual has been matched in at least one Verification Source and does not currently have at least one of the requested affiliation types.

segment

The primary segment of the program, e.g., student, military. This value does not vary but is returned for convenience.

statusUrl

The URL to poll to determine the result of the document review.

submissionUrl

The URL where you will submit the required information for the the next step in the verification, e.g., docUpload.

subSegment

The subsegment for the current verification, e.g., activeDuty is a possible subsegment in a military verification. This varies by the choice a user makes during a verification, but will always be one of the available subSegments configured for your program.

User ID

An identifier for the user that submitted the request.

Username

The username of the user that submitted the request.

Verification Types

The type(s) of verification used to obtain a verification result.

verificationId

Unique identifier for the ongoing verification.