Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ActiveMilitaryPersonalInfoRequest

ActiveMilitaryPersonalInfoRequest: { birthDate: BirthDate; country?: Country } & WithOrganization & WithCoreFields
description

The request to submit when verification is on the step "collectActiveMilitaryPersonalInfo"

ActiveMilitaryPersonalInfoResponse

ActiveMilitaryPersonalInfoResponse: { currentStep: "collectActiveMilitaryPersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "military"; submissionUrl: string } & VerificationResponse
description

Response from REST API indicating that StudentPersonalInfoViewModel is expected to be submitted next.

ActiveMilitaryPersonalInfoViewModel

AddSchoolRequestRowProps

AddSchoolRequestRowProps: { locale: Locale; programId: DatabaseId; urlAddSchoolForm: string }

Type declaration

AddSchoolRequestViewModel

AddSchoolRequestViewModel: { email: string; firstName: string; lastName: string; programId: string; schoolCountry: Country; schoolDomain: string; schoolName: string; trackingId?: string }

Type declaration

  • email: string
  • firstName: string
  • lastName: string
  • programId: string
  • schoolCountry: Country
  • schoolDomain: string
  • schoolName: string
  • Optional trackingId?: string

AgePersonalInfoRequest

AgePersonalInfoRequest: { birthDate: BirthDate; country: Country; phoneNumber: PhoneNumber; postalCode: string } & WithCoreFields
description

The request to submit when verification is on the step "collectAgePersonalInfo"

AgePersonalInfoResponse

AgePersonalInfoResponse: { currentStep: "collectAgePersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; maxAge?: number; minAge?: number; segment: "age"; subSegment: null; submissionUrl: string } & VerificationResponse
description

Response from REST API indicating that AgePersonalInfoViewModel is expected to be submitted next.

AgePersonalInfoViewModel

AllResponseTypes

BirthDate

BirthDate: string
example

2013-03-06

template

'YYYY-MM-DD'

BoundAction

BoundAction: (...args: any[]) => Promise<object>

Type declaration

    • (...args: any[]): Promise<object>
    • Parameters

      • Rest ...args: any[]

      Returns Promise<object>

BoundActionCreator

BoundActionCreator: (dispatch: Dispatch, getState?: Function) => BoundAction
description

Create a bound action (wrapped in Redux's dispatch and ready to call)

Type declaration

    • (dispatch: Dispatch, getState?: Function): BoundAction
    • Parameters

      • dispatch: Dispatch
      • Optional getState: Function

      Returns BoundAction

ConversionRequest

ConversionRequest: { amount?: number; currency?: string; tags?: string[] }
description

The shape of the request payload to send when calling a conversion endpoint.

Type declaration

  • Optional amount?: number
  • Optional currency?: string
  • Optional tags?: string[]

ConversionResources

ConversionResources: { base: string }
description

URLs related to conversion endpoints.

Type declaration

  • base: string

ConversionResponse

ConversionResponse: { id: string }
description

The shape of the response object after calling a conversion endpoint.

Type declaration

  • id: string

CookieOptions

CookieOptions: { domain?: string; enabled: boolean; expires: number; path?: string; sameSite?: "lax" | "strict" | "none"; secure: boolean }
description

Control how cookies behave

field

expires Number of days for cookie to expire in. Use 0 to expire in same browser session.

field

secure Whether the cookie is set securely.

Type declaration

  • Optional domain?: string
  • enabled: boolean
  • expires: number
  • Optional path?: string
  • Optional sameSite?: "lax" | "strict" | "none"
  • secure: boolean

Countries

Countries: { AD: string; AE: string; AF: string; AG: string; AI: string; AL: string; AM: string; AN: string; AO: string; AR: string; AS: string; AT: string; AU: string; AW: string; AZ: string; BA: string; BB: string; BD: string; BE: string; BF: string; BG: string; BH: string; BI: string; BJ: string; BM: string; BN: string; BO: string; BR: string; BS: string; BT: string; BV: string; BW: string; BY: string; BZ: string; CA: string; CD: string; CF: string; CG: string; CH: string; CI: string; CK: string; CL: string; CM: string; CN: string; CO: string; CR: string; CU: string; CV: string; CY: string; CZ: string; DE: string; DJ: string; DK: string; DM: string; DO: string; DZ: string; EC: string; EE: string; EG: string; EH: string; ER: string; ES: string; ET: string; FI: string; FJ: string; FK: string; FM: string; FO: string; FR: string; GA: string; GB: string; GD: string; GE: string; GF: string; GH: string; GI: string; GL: string; GM: string; GN: string; GP: string; GQ: string; GR: string; GS: string; GT: string; GU: string; GW: string; GY: string; HK: string; HM: string; HN: string; HR: string; HT: string; HU: string; ID: string; IE: string; IL: string; IN: string; IO: string; IQ: string; IR: string; IS: string; IT: string; JM: string; JO: string; JP: string; KE: string; KG: string; KH: string; KI: string; KM: string; KN: string; KP: string; KR: string; KW: string; KY: string; KZ: string; LA: string; LB: string; LC: string; LI: string; LK: string; LR: string; LS: string; LT: string; LU: string; LV: string; LY: string; MA: string; MC: string; MD: string; ME: string; MG: string; MH: string; MK: string; ML: string; MM: string; MN: string; MO: string; MP: string; MQ: string; MR: string; MS: string; MT: string; MU: string; MV: string; MW: string; MX: string; MY: string; MZ: string; NA: string; NC: string; NE: string; NF: string; NG: string; NI: string; NL: string; NO: string; NP: string; NR: string; NU: string; NZ: string; OM: string; PA: string; PE: string; PF: string; PG: string; PH: string; PK: string; PL: string; PM: string; PN: string; PR: string; PS: string; PT: string; PW: string; PY: string; QA: string; RE: string; RO: string; RS: string; RU: string; RW: string; SA: string; SB: string; SC: string; SD: string; SE: string; SG: string; SH: string; SI: string; SK: string; SL: string; SM: string; SN: string; SO: string; SR: string; SS: string; ST: string; SV: string; SY: string; SZ: string; TC: string; TD: string; TF: string; TG: string; TH: string; TJ: string; TK: string; TL: string; TM: string; TN: string; TO: string; TR: string; TT: string; TV: string; TW: string; TZ: string; UA: string; UG: string; UM: string; US: string; UY: string; UZ: string; VA: string; VC: string; VE: string; VG: string; VI: string; VN: string; VU: string; WF: string; WS: string; XK: string; YE: string; YT: string; ZA: string; ZM: string; ZW: string }

Type declaration

  • AD: string
  • AE: string
  • AF: string
  • AG: string
  • AI: string
  • AL: string
  • AM: string
  • AN: string
  • AO: string
  • AR: string
  • AS: string
  • AT: string
  • AU: string
  • AW: string
  • AZ: string
  • BA: string
  • BB: string
  • BD: string
  • BE: string
  • BF: string
  • BG: string
  • BH: string
  • BI: string
  • BJ: string
  • BM: string
  • BN: string
  • BO: string
  • BR: string
  • BS: string
  • BT: string
  • BV: string
  • BW: string
  • BY: string
  • BZ: string
  • CA: string
  • CD: string
  • CF: string
  • CG: string
  • CH: string
  • CI: string
  • CK: string
  • CL: string
  • CM: string
  • CN: string
  • CO: string
  • CR: string
  • CU: string
  • CV: string
  • CY: string
  • CZ: string
  • DE: string
  • DJ: string
  • DK: string
  • DM: string
  • DO: string
  • DZ: string
  • EC: string
  • EE: string
  • EG: string
  • EH: string
  • ER: string
  • ES: string
  • ET: string
  • FI: string
  • FJ: string
  • FK: string
  • FM: string
  • FO: string
  • FR: string
  • GA: string
  • GB: string
  • GD: string
  • GE: string
  • GF: string
  • GH: string
  • GI: string
  • GL: string
  • GM: string
  • GN: string
  • GP: string
  • GQ: string
  • GR: string
  • GS: string
  • GT: string
  • GU: string
  • GW: string
  • GY: string
  • HK: string
  • HM: string
  • HN: string
  • HR: string
  • HT: string
  • HU: string
  • ID: string
  • IE: string
  • IL: string
  • IN: string
  • IO: string
  • IQ: string
  • IR: string
  • IS: string
  • IT: string
  • JM: string
  • JO: string
  • JP: string
  • KE: string
  • KG: string
  • KH: string
  • KI: string
  • KM: string
  • KN: string
  • KP: string
  • KR: string
  • KW: string
  • KY: string
  • KZ: string
  • LA: string
  • LB: string
  • LC: string
  • LI: string
  • LK: string
  • LR: string
  • LS: string
  • LT: string
  • LU: string
  • LV: string
  • LY: string
  • MA: string
  • MC: string
  • MD: string
  • ME: string
  • MG: string
  • MH: string
  • MK: string
  • ML: string
  • MM: string
  • MN: string
  • MO: string
  • MP: string
  • MQ: string
  • MR: string
  • MS: string
  • MT: string
  • MU: string
  • MV: string
  • MW: string
  • MX: string
  • MY: string
  • MZ: string
  • NA: string
  • NC: string
  • NE: string
  • NF: string
  • NG: string
  • NI: string
  • NL: string
  • NO: string
  • NP: string
  • NR: string
  • NU: string
  • NZ: string
  • OM: string
  • PA: string
  • PE: string
  • PF: string
  • PG: string
  • PH: string
  • PK: string
  • PL: string
  • PM: string
  • PN: string
  • PR: string
  • PS: string
  • PT: string
  • PW: string
  • PY: string
  • QA: string
  • RE: string
  • RO: string
  • RS: string
  • RU: string
  • RW: string
  • SA: string
  • SB: string
  • SC: string
  • SD: string
  • SE: string
  • SG: string
  • SH: string
  • SI: string
  • SK: string
  • SL: string
  • SM: string
  • SN: string
  • SO: string
  • SR: string
  • SS: string
  • ST: string
  • SV: string
  • SY: string
  • SZ: string
  • TC: string
  • TD: string
  • TF: string
  • TG: string
  • TH: string
  • TJ: string
  • TK: string
  • TL: string
  • TM: string
  • TN: string
  • TO: string
  • TR: string
  • TT: string
  • TV: string
  • TW: string
  • TZ: string
  • UA: string
  • UG: string
  • UM: string
  • US: string
  • UY: string
  • UZ: string
  • VA: string
  • VC: string
  • VE: string
  • VG: string
  • VI: string
  • VN: string
  • VU: string
  • WF: string
  • WS: string
  • XK: string
  • YE: string
  • YT: string
  • ZA: string
  • ZM: string
  • ZW: string

Country

Country: keyof Countries
description

List of countries supported by SheerID

CountryComponentWrapperProps

CountryComponentWrapperProps: { intl: InjectedIntl; nextFocusField?: string; verificationService: VerificationService; viewModel: ViewModel; viewModelDraftDecorator?: (draft: ViewModel, countryChoice?: FormSelectChoice<Country, string>) => void }

Type declaration

CreateUpdateProps

CreateUpdateProps: (dispatch: Dispatch, programId: DatabaseId) => BoundAction

Type declaration

DatabaseId

DatabaseId: string
example

5bbd127d9781852f68e14ddc

template

digit hexadecimal

DateTimeMessages

DateTimeMessages: { 20_MIN: string; 24_HRS: string; 2_DAY: string; 2_HRS: string; 2_MIN: string; 3_DAY: string; A_FEW_DAYS: string; A_FEW_HOURS: string; A_FEW_MINUTES: string; A_HALF_HOUR: string; april: string; august: string; day: string; december: string; february: string; january: string; july: string; june: string; march: string; may: string; month: string; november: string; october: string; september: string; year: string }

Type declaration

  • 20_MIN: string
  • 24_HRS: string
  • 2_DAY: string
  • 2_HRS: string
  • 2_MIN: string
  • 3_DAY: string
  • A_FEW_DAYS: string
  • A_FEW_HOURS: string
  • A_FEW_MINUTES: string
  • A_HALF_HOUR: string
  • april: string
  • august: string
  • day: string
  • december: string
  • february: string
  • january: string
  • july: string
  • june: string
  • march: string
  • may: string
  • month: string
  • november: string
  • october: string
  • september: string
  • year: string

DefaultMessages

DefaultMessages: { ACTIVE_DUTY: string; DOCTOR: string; EMT: string; FIREFIGHTER: string; HOME_BUYER: string; MILITARY_FAMILY: string; MILITARY_RETIREE: string; NURSE: string; OTHER_HEALTH_WORKER: string; OTHER_MOVER: string; POLICE: string; RESERVIST: string; VETERAN: string; address: string; addressPlaceholder: string; birthDate: string; branchOfService: string; branchOfServicePlaceholder: string; changeLanguage: string; city: string; cityPlaceholder: string; company: string; companyPlaceholder: string; copied: string; countries: Countries; country: string; countryPlaceholder: string; dateTime: DateTimeMessages; dischargeDate: string; driverLicenseNumber: string; driverLicenseNumberPlaceholder: string; driverLicenseState: string; emailAddress: string; emailAddressPlaceholder: string; error: string; errorId: {}; firstName: string; firstNamePlaceholder: string; firstResponderInfoShared: string; getHelp: string; howDoesReviewWork: string; howDoesVerifyingWork: string; infoShared1: string; infoShared2: string; informationTransferredToUS: string; lastName: string; lastNamePlaceholder: string; limitExceededError: string; loading: string; locales: {}; lowRewardPool: string; memberId: string; memberIdPlaceholder: string; militaryFamilyCardNote: string; militaryInfoShared: string; militaryStatus: string; noOptions: string; optional: string; organization: string; organizationPlaceholder: string; personalInformation: any; personalOrSchoolIsFine: string; phoneNumber: string; phoneNumberExplanation: string; phoneNumberWarnMessage1: string; phoneNumberWarnMessage2: string; phoneUsPlaceholder: string; postalCode: string; postalCodeExplanation: string; postalCodePlaceholder: string; poweredBy: string; privacyPolicy: string; proceed: string; requestSchool: string; requiredFields: string; school: string; schoolName: string; schoolNamePlaceholder: string; sheeridFaqs: string; smsCodePlaceholder: string; ssn: string; ssnPlaceholder: string; state: string; statePlaceholder: string; states: States; status: string; statusPlaceholder: string; step: { collectSocialSecurityNumber: { selectOption: string; title: string; uploadDoc: string; uploadInstead: string; useSsn: string }; docUpload: { acceptableUploadExamples: string; acceptableUploads: { age: { birthCertificate: string; driversLicense: string; passport: string; stateId: string }; employment: { employeeIdCard: string; officialLetter: string; payStub: string }; firstResponder: { idCard: string; letter: string; payStub: string }; licensedProfessional: { license: string }; medical: { idCard: string; licenseCertificate: string; photoPayStub: string }; member: { idCard: string; payStub: string }; military: { activeDuty: string; dependent: string; reservistA: string; retiree: string; veteran: string }; recentMover: { changeOfAddress: string; mortgageDeed: string; rentalAgreement: string }; senior: { birthCertificate: string; driversLicense: string; passport: string; stateId: string }; student: { classSchedule: string; idCard: string; tuitionReceipt: string }; teacher: { idCard: string; payStub: string } }; acceptedTypes: string; addFile: string; cancelButtonLabel: string; fileInstructions: string; nameChanged: string; rejectedSubtitle: string; rejectionReasons: {}; submitButtonLabel: string; uploadInfo: { affiliation: string; age: { birthDate: string }; employment: { company: string; currentAffiliation: string }; firstResponder: { currentAffiliation: string; license: string; organization: string }; fullName: string; identity: { validDate: string }; licensedProfessional: { licenseStatus: string; validDate: string }; medical: { status: string; validDate: string }; military: { currentAffiliation: string; dischargeDate: string; serviceBranch: string; uploadInstructionsDependent: string }; organization: string; recentMover: { address: string; validDate: string }; senior: { birthDate: string }; student: { enrollmentDate: string; school: string }; teacher: { currentSchoolYear: string; school: string } } }; emailLoop: { errors: { resend: string }; resendButton: string; skipEmail: string; skipEmail2: string; skipEmailCTA: string; subtitle2: string; subtitleWithEmail: string; subtitleWithoutEmail: string; successResend: string; title: string }; error: ProgramThemeMessages["step"]["error"]; pending: { docDiffLang: string; subtitle: string; subtitle2: string; subtitle3: string; subtitleAlt: string; subtitleCountdown: string; titleCountdown: string; titleReview: string; turnaroundTime: string }; smsLoop: { errors: { codeExpired: string; codeResendLimit: string; codeVerification: string; resend: string }; incorrectNumber: { incorrectNumber1: string; incorrectNumber2: string; incorrectNumber3: string }; resendButton: string; submitButton: string; successResend: string; titleWithNumber: string; titleWithoutNumber: string; verificationCode: string }; sso: { cancel: string; login: string; subtitle: string; subtitle2: string; title: string }; success: { copyCouponCode: string; emailNotification: string; verificationOnly: string } }; studentInfoShared: string; tryAgain: string; universityName: string; verificationPurposesOnly: string; verifyAndContinue: string; verifyMyEmploymentStatus: string; verifyMyFirstResponderStatus: string; verifyMyIdentityStatus: string; verifyMyLicensedProfessionalStatus: string; verifyMyMedicalProfessionalStatus: string; verifyMyMembershipStatus: string; verifyMyMilitaryStatus: string; verifyMyMoverStatus: string; verifyMyStudentStatus: string; verifyMyTeacherStatus: string }
description

These strings are provided by default

Type declaration

  • ACTIVE_DUTY: string
  • DOCTOR: string
  • EMT: string
  • FIREFIGHTER: string
  • HOME_BUYER: string
  • MILITARY_FAMILY: string
  • MILITARY_RETIREE: string
  • NURSE: string
  • OTHER_HEALTH_WORKER: string
  • OTHER_MOVER: string
  • POLICE: string
  • RESERVIST: string
  • VETERAN: string
  • address: string
  • addressPlaceholder: string
  • birthDate: string
  • branchOfService: string
  • branchOfServicePlaceholder: string
  • changeLanguage: string
  • city: string
  • cityPlaceholder: string
  • company: string
  • companyPlaceholder: string
  • copied: string
  • countries: Countries
  • country: string
  • countryPlaceholder: string
  • dateTime: DateTimeMessages
  • dischargeDate: string
  • driverLicenseNumber: string
  • driverLicenseNumberPlaceholder: string
  • driverLicenseState: string
  • emailAddress: string
  • emailAddressPlaceholder: string
  • error: string
  • errorId: {}
  • firstName: string
  • firstNamePlaceholder: string
  • firstResponderInfoShared: string
  • getHelp: string
  • howDoesReviewWork: string
  • howDoesVerifyingWork: string
  • infoShared1: string
  • infoShared2: string
  • informationTransferredToUS: string
  • lastName: string
  • lastNamePlaceholder: string
  • limitExceededError: string
  • loading: string
  • locales: {}
  • lowRewardPool: string
  • memberId: string
  • memberIdPlaceholder: string
  • militaryFamilyCardNote: string
  • militaryInfoShared: string
  • militaryStatus: string
  • noOptions: string
  • optional: string
  • organization: string
  • organizationPlaceholder: string
  • personalInformation: any
  • personalOrSchoolIsFine: string
  • phoneNumber: string
  • phoneNumberExplanation: string
  • phoneNumberWarnMessage1: string
  • phoneNumberWarnMessage2: string
  • phoneUsPlaceholder: string
  • postalCode: string
  • postalCodeExplanation: string
  • postalCodePlaceholder: string
  • poweredBy: string
  • privacyPolicy: string
  • proceed: string
  • requestSchool: string
  • requiredFields: string
  • school: string
  • schoolName: string
  • schoolNamePlaceholder: string
  • sheeridFaqs: string
  • smsCodePlaceholder: string
  • ssn: string
  • ssnPlaceholder: string
  • state: string
  • statePlaceholder: string
  • states: States
  • status: string
  • statusPlaceholder: string
  • step: { collectSocialSecurityNumber: { selectOption: string; title: string; uploadDoc: string; uploadInstead: string; useSsn: string }; docUpload: { acceptableUploadExamples: string; acceptableUploads: { age: { birthCertificate: string; driversLicense: string; passport: string; stateId: string }; employment: { employeeIdCard: string; officialLetter: string; payStub: string }; firstResponder: { idCard: string; letter: string; payStub: string }; licensedProfessional: { license: string }; medical: { idCard: string; licenseCertificate: string; photoPayStub: string }; member: { idCard: string; payStub: string }; military: { activeDuty: string; dependent: string; reservistA: string; retiree: string; veteran: string }; recentMover: { changeOfAddress: string; mortgageDeed: string; rentalAgreement: string }; senior: { birthCertificate: string; driversLicense: string; passport: string; stateId: string }; student: { classSchedule: string; idCard: string; tuitionReceipt: string }; teacher: { idCard: string; payStub: string } }; acceptedTypes: string; addFile: string; cancelButtonLabel: string; fileInstructions: string; nameChanged: string; rejectedSubtitle: string; rejectionReasons: {}; submitButtonLabel: string; uploadInfo: { affiliation: string; age: { birthDate: string }; employment: { company: string; currentAffiliation: string }; firstResponder: { currentAffiliation: string; license: string; organization: string }; fullName: string; identity: { validDate: string }; licensedProfessional: { licenseStatus: string; validDate: string }; medical: { status: string; validDate: string }; military: { currentAffiliation: string; dischargeDate: string; serviceBranch: string; uploadInstructionsDependent: string }; organization: string; recentMover: { address: string; validDate: string }; senior: { birthDate: string }; student: { enrollmentDate: string; school: string }; teacher: { currentSchoolYear: string; school: string } } }; emailLoop: { errors: { resend: string }; resendButton: string; skipEmail: string; skipEmail2: string; skipEmailCTA: string; subtitle2: string; subtitleWithEmail: string; subtitleWithoutEmail: string; successResend: string; title: string }; error: ProgramThemeMessages["step"]["error"]; pending: { docDiffLang: string; subtitle: string; subtitle2: string; subtitle3: string; subtitleAlt: string; subtitleCountdown: string; titleCountdown: string; titleReview: string; turnaroundTime: string }; smsLoop: { errors: { codeExpired: string; codeResendLimit: string; codeVerification: string; resend: string }; incorrectNumber: { incorrectNumber1: string; incorrectNumber2: string; incorrectNumber3: string }; resendButton: string; submitButton: string; successResend: string; titleWithNumber: string; titleWithoutNumber: string; verificationCode: string }; sso: { cancel: string; login: string; subtitle: string; subtitle2: string; title: string }; success: { copyCouponCode: string; emailNotification: string; verificationOnly: string } }
    • collectSocialSecurityNumber: { selectOption: string; title: string; uploadDoc: string; uploadInstead: string; useSsn: string }
      • selectOption: string
      • title: string
      • uploadDoc: string
      • uploadInstead: string
      • useSsn: string
    • docUpload: { acceptableUploadExamples: string; acceptableUploads: { age: { birthCertificate: string; driversLicense: string; passport: string; stateId: string }; employment: { employeeIdCard: string; officialLetter: string; payStub: string }; firstResponder: { idCard: string; letter: string; payStub: string }; licensedProfessional: { license: string }; medical: { idCard: string; licenseCertificate: string; photoPayStub: string }; member: { idCard: string; payStub: string }; military: { activeDuty: string; dependent: string; reservistA: string; retiree: string; veteran: string }; recentMover: { changeOfAddress: string; mortgageDeed: string; rentalAgreement: string }; senior: { birthCertificate: string; driversLicense: string; passport: string; stateId: string }; student: { classSchedule: string; idCard: string; tuitionReceipt: string }; teacher: { idCard: string; payStub: string } }; acceptedTypes: string; addFile: string; cancelButtonLabel: string; fileInstructions: string; nameChanged: string; rejectedSubtitle: string; rejectionReasons: {}; submitButtonLabel: string; uploadInfo: { affiliation: string; age: { birthDate: string }; employment: { company: string; currentAffiliation: string }; firstResponder: { currentAffiliation: string; license: string; organization: string }; fullName: string; identity: { validDate: string }; licensedProfessional: { licenseStatus: string; validDate: string }; medical: { status: string; validDate: string }; military: { currentAffiliation: string; dischargeDate: string; serviceBranch: string; uploadInstructionsDependent: string }; organization: string; recentMover: { address: string; validDate: string }; senior: { birthDate: string }; student: { enrollmentDate: string; school: string }; teacher: { currentSchoolYear: string; school: string } } }
      • acceptableUploadExamples: string
      • acceptableUploads: { age: { birthCertificate: string; driversLicense: string; passport: string; stateId: string }; employment: { employeeIdCard: string; officialLetter: string; payStub: string }; firstResponder: { idCard: string; letter: string; payStub: string }; licensedProfessional: { license: string }; medical: { idCard: string; licenseCertificate: string; photoPayStub: string }; member: { idCard: string; payStub: string }; military: { activeDuty: string; dependent: string; reservistA: string; retiree: string; veteran: string }; recentMover: { changeOfAddress: string; mortgageDeed: string; rentalAgreement: string }; senior: { birthCertificate: string; driversLicense: string; passport: string; stateId: string }; student: { classSchedule: string; idCard: string; tuitionReceipt: string }; teacher: { idCard: string; payStub: string } }
        • age: { birthCertificate: string; driversLicense: string; passport: string; stateId: string }
          • birthCertificate: string
          • driversLicense: string
          • passport: string
          • stateId: string
        • employment: { employeeIdCard: string; officialLetter: string; payStub: string }
          • employeeIdCard: string
          • officialLetter: string
          • payStub: string
        • firstResponder: { idCard: string; letter: string; payStub: string }
          • idCard: string
          • letter: string
          • payStub: string
        • licensedProfessional: { license: string }
          • license: string
        • medical: { idCard: string; licenseCertificate: string; photoPayStub: string }
          • idCard: string
          • licenseCertificate: string
          • photoPayStub: string
        • member: { idCard: string; payStub: string }
          • idCard: string
          • payStub: string
        • military: { activeDuty: string; dependent: string; reservistA: string; retiree: string; veteran: string }
          • activeDuty: string
          • dependent: string
          • reservistA: string
          • retiree: string
          • veteran: string
        • recentMover: { changeOfAddress: string; mortgageDeed: string; rentalAgreement: string }
          • changeOfAddress: string
          • mortgageDeed: string
          • rentalAgreement: string
        • senior: { birthCertificate: string; driversLicense: string; passport: string; stateId: string }
          • birthCertificate: string
          • driversLicense: string
          • passport: string
          • stateId: string
        • student: { classSchedule: string; idCard: string; tuitionReceipt: string }
          • classSchedule: string
          • idCard: string
          • tuitionReceipt: string
        • teacher: { idCard: string; payStub: string }
          • idCard: string
          • payStub: string
      • acceptedTypes: string
      • addFile: string
      • cancelButtonLabel: string
      • fileInstructions: string
      • nameChanged: string
      • rejectedSubtitle: string
      • rejectionReasons: {}
      • submitButtonLabel: string
      • uploadInfo: { affiliation: string; age: { birthDate: string }; employment: { company: string; currentAffiliation: string }; firstResponder: { currentAffiliation: string; license: string; organization: string }; fullName: string; identity: { validDate: string }; licensedProfessional: { licenseStatus: string; validDate: string }; medical: { status: string; validDate: string }; military: { currentAffiliation: string; dischargeDate: string; serviceBranch: string; uploadInstructionsDependent: string }; organization: string; recentMover: { address: string; validDate: string }; senior: { birthDate: string }; student: { enrollmentDate: string; school: string }; teacher: { currentSchoolYear: string; school: string } }
        • affiliation: string
        • age: { birthDate: string }
          • birthDate: string
        • employment: { company: string; currentAffiliation: string }
          • company: string
          • currentAffiliation: string
        • firstResponder: { currentAffiliation: string; license: string; organization: string }
          • currentAffiliation: string
          • license: string
          • organization: string
        • fullName: string
        • identity: { validDate: string }
          • validDate: string
        • licensedProfessional: { licenseStatus: string; validDate: string }
          • licenseStatus: string
          • validDate: string
        • medical: { status: string; validDate: string }
          • status: string
          • validDate: string
        • military: { currentAffiliation: string; dischargeDate: string; serviceBranch: string; uploadInstructionsDependent: string }
          • currentAffiliation: string
          • dischargeDate: string
          • serviceBranch: string
          • uploadInstructionsDependent: string
        • organization: string
        • recentMover: { address: string; validDate: string }
          • address: string
          • validDate: string
        • senior: { birthDate: string }
          • birthDate: string
        • student: { enrollmentDate: string; school: string }
          • enrollmentDate: string
          • school: string
        • teacher: { currentSchoolYear: string; school: string }
          • currentSchoolYear: string
          • school: string
    • emailLoop: { errors: { resend: string }; resendButton: string; skipEmail: string; skipEmail2: string; skipEmailCTA: string; subtitle2: string; subtitleWithEmail: string; subtitleWithoutEmail: string; successResend: string; title: string }
      • errors: { resend: string }
        • resend: string
      • resendButton: string
      • skipEmail: string
      • skipEmail2: string
      • skipEmailCTA: string
      • subtitle2: string
      • subtitleWithEmail: string
      • subtitleWithoutEmail: string
      • successResend: string
      • title: string
    • error: ProgramThemeMessages["step"]["error"]
    • pending: { docDiffLang: string; subtitle: string; subtitle2: string; subtitle3: string; subtitleAlt: string; subtitleCountdown: string; titleCountdown: string; titleReview: string; turnaroundTime: string }
      • docDiffLang: string
      • subtitle: string
      • subtitle2: string
      • subtitle3: string
      • subtitleAlt: string
      • subtitleCountdown: string
      • titleCountdown: string
      • titleReview: string
      • turnaroundTime: string
    • smsLoop: { errors: { codeExpired: string; codeResendLimit: string; codeVerification: string; resend: string }; incorrectNumber: { incorrectNumber1: string; incorrectNumber2: string; incorrectNumber3: string }; resendButton: string; submitButton: string; successResend: string; titleWithNumber: string; titleWithoutNumber: string; verificationCode: string }
      • errors: { codeExpired: string; codeResendLimit: string; codeVerification: string; resend: string }
        • codeExpired: string
        • codeResendLimit: string
        • codeVerification: string
        • resend: string
      • incorrectNumber: { incorrectNumber1: string; incorrectNumber2: string; incorrectNumber3: string }
        • incorrectNumber1: string
        • incorrectNumber2: string
        • incorrectNumber3: string
      • resendButton: string
      • submitButton: string
      • successResend: string
      • titleWithNumber: string
      • titleWithoutNumber: string
      • verificationCode: string
    • sso: { cancel: string; login: string; subtitle: string; subtitle2: string; title: string }
      • cancel: string
      • login: string
      • subtitle: string
      • subtitle2: string
      • title: string
    • success: { copyCouponCode: string; emailNotification: string; verificationOnly: string }
      • copyCouponCode: string
      • emailNotification: string
      • verificationOnly: string
  • studentInfoShared: string
  • tryAgain: string
  • universityName: string
  • verificationPurposesOnly: string
  • verifyAndContinue: string
  • verifyMyEmploymentStatus: string
  • verifyMyFirstResponderStatus: string
  • verifyMyIdentityStatus: string
  • verifyMyLicensedProfessionalStatus: string
  • verifyMyMedicalProfessionalStatus: string
  • verifyMyMembershipStatus: string
  • verifyMyMilitaryStatus: string
  • verifyMyMoverStatus: string
  • verifyMyStudentStatus: string
  • verifyMyTeacherStatus: string

DischargeDate

DischargeDate: string
description

TODO

DocUploadRequest

DocUploadRequest: { file1: File; file2?: File; file3?: File; metadata?: Metadata }
description

The request to submit when verification is on the step "docUpload"

Type declaration

  • file1: File
  • Optional file2?: File
  • Optional file3?: File
  • Optional metadata?: Metadata

DocUploadResponse

DocUploadResponse: { currentStep: "docUpload"; errorIds?: [ErrorId]; estimatedReviewTime?: EstimatedReviewTime; maxReviewTime?: MaxReviewTime; rejectionReasons?: RejectionReasons[]; submissionUrl: string; verificationId: DatabaseId } & WithLocaleAndCountryChoiceAndSegment
description

Response from REST API indicating that DocUploadRequest is expected to be submitted next.

DocUploadViewModel

DocUploadViewModel: DocUploadRequest & { erroredFileNames?: string[] } & WithLocaleAndCountry & WithFieldsToSkipValidation

DriverLicensePersonalInfoRequest

DriverLicensePersonalInfoRequest: { driverLicenseNumber: string; state: string } & WithCoreFields
description

The request to submit when verification is on the step "collectDriverLicensePersonalInfo"

DriverLicensePersonalInfoResponse

DriverLicensePersonalInfoResponse: { currentStep: "collectDriverLicensePersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "identity"; submissionUrl: string } & VerificationResponse
description

Response from REST API indicating that DriverLicensePersonalInfoViewModel is expected to be submitted next.

DriverLicensePersonalInfoViewModel

Email

Email: string
todo

document constraints here

EmailLoopResponse

EmailLoopResponse: { canResendEmailLoop: boolean; cancelUrl: string; currentStep: "emailLoop"; errorIds?: [ErrorId]; submissionUrl: string; verificationId: DatabaseId } & WithLocaleAndCountryChoiceAndSegment

EmailLoopVerificationRequest

EmailLoopVerificationRequest: { deviceFingerprintHash?: string; emailToken: string }

Type declaration

  • Optional deviceFingerprintHash?: string
  • emailToken: string

EmailLoopViewModel

EmailLoopViewModel: { deviceFingerprintHash?: string; emailToken: string; metadata?: Metadata } & WithLocaleAndCountry & WithFieldsToSkipValidation

EmploymentPersonalInfoRequest

EmploymentPersonalInfoRequest: { phoneNumber?: PhoneNumber; postalCode: string; shouldCollectAddress?: Boolean } & WithAddress & WithOrganization & WithCoreFields
description

The request to submit when verification is on the step "collectEmployeePersonalInfo"

EmploymentPersonalInfoResponse

EmploymentPersonalInfoResponse: { currentStep: "collectEmployeePersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "employment"; subSegment: null; submissionUrl: string } & VerificationResponse

EmploymentPersonalInfoViewModel

ErrorId

ErrorId: "apiRateLimitExceeded" | "dischargeDateBeforeBirthDate" | "docReviewLimitExceeded" | "inactiveProgram" | "expiredProgram" | "expiredEmailLoopToken" | "expiredSMSCode" | "expiredVerification" | "fraudRulesReject" | "futureBirthDate" | "futureDischargeDate" | "internalServerError" | "invalidAddress" | "invalidApiToken" | "invalidBirthDate" | "invalidCity" | "invalidCountry" | "invalidDischargeDate" | "invalidDocUploadToken" | "invalidEmail" | "invalidFileSizeEmpty" | "invalidFileSizeMax" | "invalidFirstName" | "invalidFirstResponderStatus" | "invalidLastName" | "invalidMemberId" | "invalidMilitaryStatus" | "invalidNumberOfFiles" | "invalidOptIn" | "invalidOrganization" | "invalidPhoneNumber" | "invalidPostalCode" | "invalidProgram" | "invalidRequest" | "invalidSMSCode" | "invalidSocialSecurityNumber" | "invalidState" | "invalidStatus" | "invalidStatuses" | "invalidDriverLicenseNumber" | "invalidStep" | "marketConsentRequired" | "maxMetadataLengthExceeded" | "maxMetadataValuesExceeded" | "maxSMSCodeLimitExceeded" | "incorrectSMSCodeAttemptLimitExceeded" | "noProgram" | "noRemainingRewardCodes" | "notApproved" | "notFound" | "noValidFiles" | "noVerification" | "outsideAgePerson" | "simulatedError" | "unauthorizedDomain" | "underagePerson" | "unknownError" | "unsupportedDocMimeType" | "verificationLimitExceeded" | "invalidEmailLoopToken" | NetworkErrorId

ErrorResponse

ErrorResponse: { currentStep: "error"; errorIds: [ErrorId]; redirectUrl: string | null; subSegment: SubSegment | null; verificationId: DatabaseId } & WithLocaleAndCountryChoiceAndSegment
description

Response from REST API. Unrecoverable error. No further requests are expected. Recommend starting over.

EstimatedReviewTime

EstimatedReviewTime: "A_FEW_MINUTES" | "A_HALF_HOUR" | "A_FEW_HOURS" | "A_FEW_DAYS"

ExtendedErrorId

ExtendedErrorId: string | undefined

ExtendedFieldId

ExtendedFieldId: FieldId | string
description

TODO

ExtendedFieldValidationErrors

ExtendedFieldValidationErrors: StringMap
description

TODO

FaqUrl

FaqUrl: string

FetchOrganizationResponse

FetchOrganizationResponse: Promise<OrganizationSearchResp | undefined>

FieldContent

FieldContent: string | number | File | FormSelectChoice<Country, string> | Organization | boolean
description

TODO

FieldId

FieldId: "firstName" | "lastName" | "memberId" | "organization" | "birthDate" | "email" | "phoneNumber" | "postalCode" | "address1" | "city" | "state" | "dischargeDate" | "status" | "statuses" | "docUpload" | "country" | "smsCode" | "socialSecurityNumber" | "marketConsentValue" | "carrierConsentValue" | "driverLicenseNumber"
description

All possible fields

FieldRef

FieldRef: { fieldId: FieldId | ExtendedFieldId; ref: HTMLElement }
description

Configurable refs that can be defined when rendering FormField components.

Type declaration

FieldValidationErrors

FieldValidationErrors: {}
description

The object that contains all possible field ids for setting & displaying field errors, if any

Type declaration

FirstResponderPersonalInfoRequest

FirstResponderPersonalInfoRequest: { birthDate: BirthDate; country?: Country; postalCode?: string; status: FirstResponderStatus; statuses?: FirstResponderStatus[] } & WithOrganization & WithCoreFields
description

The request to submit when verification is on the step "collectFirstResponderPersonalInfo" Provide postalCode when organization.id = 0 for better verification results.

FirstResponderPersonalInfoResponse

FirstResponderPersonalInfoResponse: { availableStatuses?: [FirstResponderStatus]; currentStep: "collectFirstResponderPersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "firstResponder"; submissionUrl: string } & VerificationResponse

FirstResponderPersonalInfoViewModel

FirstResponderStatus

FirstResponderStatus: "FIREFIGHTER" | "EMT" | "POLICE"
description

TODO

FormSelectChoice

FormSelectChoice<v, l>: { label: l; value: v }
description

A model to back many of this library's <select> elements. For compatibility, a default for value of string or number is allowed. Made generic to allow arbitrary types (e.g. FormSelectChoice<Locale, string>)

Type parameters

  • v

  • l

Type declaration

  • label: l
  • value: v

FormValidationOptions

FormValidationOptions: { currentStep?: VerificationStep; maxAge?: number; minAge?: number; smsLoopEnabled?: boolean; viewModel?: ViewModel }

Type declaration

  • Optional currentStep?: VerificationStep
  • Optional maxAge?: number
  • Optional minAge?: number
  • Optional smsLoopEnabled?: boolean
  • Optional viewModel?: ViewModel

GeneralIdentityPersonalInfoRequest

GeneralIdentityPersonalInfoRequest: { birthDate: BirthDate; postalCode: string } & WithAddress & WithCoreFields

GeneralIdentityPersonalInfoResponse

GeneralIdentityPersonalInfoResponse: { currentStep: "collectGeneralIdentityPersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "identity"; submissionUrl: string } & VerificationResponse

GeneralIdentityPersonalInfoViewModel

Hook

Hook: { callback: (verificationResponse: VerificationResponse) => void; name: "ON_VERIFICATION_READY" } | { callback: (verificationResponse: SuccessResponse) => void; name: "ON_VERIFICATION_SUCCESS" } | { callback: (verificationResponse: SuccessResponse) => void; name: "ON_VERIFICATION_STEP_CHANGE" }
description

Defines a list of hooks names that are available. Certain events throughout the software will call an arbitrary callback, by this name. These names are meant to be descriptive, to indicate when the callback (hook) will be called.

HookName

HookName: "ON_VERIFICATION_READY" | "ON_VERIFICATION_SUCCESS" | "ON_VERIFICATION_STEP_CHANGE"

HowDoesVerifyingWorkMessages

HowDoesVerifyingWorkMessages: Record<Segment, Messages>

HybridIdentityPersonalInfoRequest

HybridIdentityPersonalInfoRequest: { birthDate: BirthDate; driverLicenseNumber: string; postalCode: string } & WithAddress & WithCoreFields

HybridIdentityPersonalInfoResponse

HybridIdentityPersonalInfoResponse: { currentStep: "collectHybridIdentityPersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "identity"; submissionUrl: string } & VerificationResponse

HybridIdentityPersonalInfoViewModel

IframeOptions

IframeOptions: { className: string }

Type declaration

  • className: string

IframeUserConfiguration

IframeUserConfiguration: { closeButtonText?: string; mobileRedirect?: boolean; mobileThreshold?: string | number; stopPropagation?: boolean }
description

Configuration for a verification being displayed on an iframe.

Type declaration

  • Optional closeButtonText?: string
  • Optional mobileRedirect?: boolean
  • Optional mobileThreshold?: string | number
  • Optional stopPropagation?: boolean

InactiveMilitaryPersonalInfoRequest

InactiveMilitaryPersonalInfoRequest: { birthDate: BirthDate; country?: Country; dischargeDate: DischargeDate } & WithOrganization & WithCoreFields
description

The request to submit when verification is on the step "collectInactiveMilitaryPersonalInfo"

InactiveMilitaryPersonalInfoResponse

InactiveMilitaryPersonalInfoResponse: { currentStep: "collectInactiveMilitaryPersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "military"; submissionUrl: string } & VerificationResponse
description

Response from REST API indicating that StudentPersonalInfoViewModel is expected to be submitted next.

InactiveMilitaryPersonalInfoViewModel

InputSelectOnKeyDown

InputSelectOnKeyDown: (event: KeyboardEvent<HTMLInputElement>) => void

Type declaration

    • (event: KeyboardEvent<HTMLInputElement>): void
    • Parameters

      • event: KeyboardEvent<HTMLInputElement>

      Returns void

InputTextProps

InputTextProps: { ariaDescribedBy?: string; ariaLabel?: string; className?: string; hidePlaceholder?: boolean; id: string; isErrored: boolean; onChange?: React.ChangeEventHandler; onKeyDown?: React.ChangeEventHandler; ref?: never; refId?: string; required?: boolean; type?: "text" | "email" | "password" | "search" | "url" | "tel" } & AllHTMLAttributes<HTMLInputElement> & InjectedIntlProps

Intl

Intl: any
deprecated

LicensedProfessionalPersonalInfoRequest

LicensedProfessionalPersonalInfoRequest: { birthDate: BirthDate; postalCode: string; statuses: LicensedProfessionalStatus[] } & WithCoreFields & WithOrganization
description

The request to submit when verification is on the step "collectLicensedProfessionalPersonalInfo"

LicensedProfessionalPersonalInfoResponse

LicensedProfessionalPersonalInfoResponse: { availableStatuses?: LicensedProfessionalStatus[]; currentStep: "collectLicensedProfessionalPersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "licensedProfessional"; submissionUrl: string } & VerificationResponse

LicensedProfessionalPersonalInfoViewModel

LicensedProfessionalStatus

LicensedProfessionalStatus: string

Locale

Locale: "ar" | "bg" | "cs" | "da" | "de" | "el" | "en-GB" | "en-US" | "es-ES" | "es" | "fi" | "fr-CA" | "fr" | "ga" | "hr" | "hu" | "id" | "it" | "iw" | "ja" | "ko" | "lo" | "lt" | "ms" | "nl" | "no" | "pl" | "pt-BR" | "pt" | "ru" | "sk" | "sl" | "sr" | "sv" | "th" | "tr" | "zh-HK" | "zh"
description

List of locales supported by SheerID

LogLevel

LogLevel: "info" | "log" | "warn" | "error"

MarketConsentOptions

MarketConsentOptions: { enabled: boolean; message: string; required: boolean }

Type declaration

  • enabled: boolean
  • message: string
  • required: boolean

MaxReviewTime

MaxReviewTime: "2_MIN" | "20_MIN" | "2_HRS" | "24_HRS" | "2_DAY" | "3_DAY"

MedicalProfessionalPersonalInfoRequest

MedicalProfessionalPersonalInfoRequest: { birthDate: BirthDate; country: Country; postalCode: string; status: MedicalProfessionalStatus } & WithOrganization & WithCoreFields
description

The request to submit when verification is on the step "collectMedicalProfessionalPersonalInfo"

MedicalProfessionalPersonalInfoResponse

MedicalProfessionalPersonalInfoResponse: { availableStatuses?: [MedicalProfessionalStatus]; currentStep: "collectMedicalProfessionalPersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "medical"; submissionUrl: string } & VerificationResponse

MedicalProfessionalPersonalInfoViewModel

MedicalProfessionalStatus

MedicalProfessionalStatus: "NURSE" | "DOCTOR" | "OTHER_HEALTH_WORKER"

MedicalStatusRequest

MedicalStatusRequest: { status: MedicalProfessionalStatus }

Type declaration

MemberId

MemberId: string
example

1234567 | A01205257

MemberPersonalInfoRequest

MemberPersonalInfoRequest: { birthDate?: BirthDate; memberId?: MemberId; phoneNumber?: PhoneNumber } & WithOrganization & WithCoreFields
description

The request to submit when verification is on the step "collectMemberPersonalInfo"

MemberPersonalInfoResponse

MemberPersonalInfoResponse: { currentStep: "collectMemberPersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "member"; subSegment: null; submissionUrl: string } & VerificationResponse

MemberPersonalInfoViewModel

Messages

Messages: { default: string; docUpload: string }

Type declaration

  • default: string
  • docUpload: string

Metadata

Metadata: {}
example

{ 'someKey': 'someValue' }

Type declaration

  • [key: string]: string | boolean

MetadataConfig

MetadataConfig: { enabled: boolean; keys: string[] }

Type declaration

  • enabled: boolean
  • keys: string[]

MilitaryStatus

MilitaryStatus: "ACTIVE_DUTY" | "VETERAN" | "RESERVIST" | "MILITARY_RETIREE" | "MILITARY_FAMILY"
description

TODO

MilitaryStatusRequest

MilitaryStatusRequest: { status: MilitaryStatus }
description

The request to submit when verification is on the step "collectMilitaryStatus"

Type declaration

MilitaryStatusResponse

MilitaryStatusResponse: { availableStatuses?: [MilitaryStatus]; currentStep: "collectMilitaryStatus"; errorIds?: [ErrorId]; segment: "military"; submissionUrl: string } & VerificationResponse
description

Response from REST API indicating that StudentPersonalInfoViewModel is expected to be submitted next.

MockStep

MockStep: VerificationStep | "loading"

MoverPersonalInfoRequest

MoverPersonalInfoRequest: { address1: string; postalCode: string; statuses: RecentMoverStatus[] } & WithCoreFields
description

The request to submit when verification is on the step "collectMoverPersonalInfo"

MoverPersonalInfoResponse

MoverPersonalInfoResponse: { availableStatuses?: RecentMoverStatus[]; currentStep: "collectMoverPersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "recentMover"; submissionUrl: string } & VerificationResponse

MoverPersonalInfoViewModel

NetworkErrorId

NetworkErrorId: "failedToFetch" | "requestTimeout"

NewVerificationRequest

NewVerificationRequest: { installPageUrl?: string; programId: DatabaseId; trackingId?: string }

Type declaration

  • Optional installPageUrl?: string
  • programId: DatabaseId
  • Optional trackingId?: string

Options

Options: { cookies?: CookieOptions; customCss?: ProgramTheme["customCss"]; customMetadata?: MetadataConfig; doFetchTheme?: boolean; httpRequestTimeout?: number; installPageUrl?: string; locale?: Locale; logLevel?: LogLevel; logoUrl?: ProgramTheme["logoUrl"]; marketConsent?: MarketConsentOptions; messages?: object; messagesWithLocale?: object; minimumOrganizationSearchLength?: number; mockErrorId?: ErrorId; mockPreviousStep?: VerificationStep; mockResponse?: VerificationResponse; mockSegment?: Segment; mockStep?: MockStep; mockSubSegment?: SubSegment; privacyPolicyUrl?: ProgramTheme["privacyPolicyUrl"]; restApi?: RestApiOptions; urlAddSchoolFaq?: string; urlAddSchoolForm?: string; urlAgeFaq?: string; urlEmploymentFaq?: string; urlFaq?: string; urlFirstResponderFaq?: string; urlIdentityFaq?: string; urlLicensedProfessionalFaq?: string; urlMedicalFaq?: string; urlMemberFaq?: string; urlMilitaryFaq?: string; urlSeniorFaq?: string; urlStudentFaq?: string; urlTeacherFaq?: string; useFingerprinting?: boolean; verificationId?: string }
description

Configurable options that can be passed when initializing this library.

Type declaration

  • Optional cookies?: CookieOptions
  • Optional customCss?: ProgramTheme["customCss"]
  • Optional customMetadata?: MetadataConfig
  • Optional doFetchTheme?: boolean
  • Optional httpRequestTimeout?: number
  • Optional installPageUrl?: string
  • Optional locale?: Locale
  • Optional logLevel?: LogLevel
  • Optional logoUrl?: ProgramTheme["logoUrl"]
  • Optional marketConsent?: MarketConsentOptions
  • Optional messages?: object
  • Optional messagesWithLocale?: object
  • Optional minimumOrganizationSearchLength?: number
  • Optional mockErrorId?: ErrorId
  • Optional mockPreviousStep?: VerificationStep
  • Optional mockResponse?: VerificationResponse
  • Optional mockSegment?: Segment
  • Optional mockStep?: MockStep
  • Optional mockSubSegment?: SubSegment
  • Optional privacyPolicyUrl?: ProgramTheme["privacyPolicyUrl"]
  • Optional restApi?: RestApiOptions
  • Optional urlAddSchoolFaq?: string
  • Optional urlAddSchoolForm?: string
  • Optional urlAgeFaq?: string
    deprecated

    since version 1.63

  • Optional urlEmploymentFaq?: string
    deprecated

    since version 1.63

  • Optional urlFaq?: string
  • Optional urlFirstResponderFaq?: string
    deprecated

    since version 1.63

  • Optional urlIdentityFaq?: string
    deprecated

    since version 1.63

  • Optional urlLicensedProfessionalFaq?: string
    deprecated

    since version 1.63

  • Optional urlMedicalFaq?: string
    deprecated

    since version 1.63

  • Optional urlMemberFaq?: string
    deprecated

    since version 1.63

  • Optional urlMilitaryFaq?: string
    deprecated

    since version 1.63

  • Optional urlSeniorFaq?: string
    deprecated

    since version 1.63

  • Optional urlStudentFaq?: string
    deprecated

    since version 1.63

  • Optional urlTeacherFaq?: string
    deprecated

    since version 1.63

  • Optional useFingerprinting?: boolean
  • Optional verificationId?: string

OrganizationId

OrganizationId: number
description

TODO

OrganizationName

OrganizationName: string
description

TODO

OrganizationType

OrganizationType: "UNIVERSITY" | "POST_SECONDARY" | "MEMBERSHIP" | "MILITARY" | "FIRST_RESPONDER" | "MEDICAL" | "NON_PROFIT" | "CORPORATE" | "K12" | "AGE_ID" | "HIGH_SCHOOL" | "NONE"

OverrideableComponentName

OverrideableComponentName: "StepStudentPersonalInfoComponent" | "StepSeniorPersonalInfoComponent" | "StepAgePersonalInfoComponent" | "StepTeacherPersonalInfoComponent" | "StepMemberPersonalInfoComponent" | "StepCollectMilitaryStatusComponent" | "StepActiveMilitaryPersonalInfoComponent" | "StepInactiveMilitaryPersonalInfoComponent" | "StepFirstResponderPersonalInfoComponent" | "StepMedicalProfessionalPersonalInfoComponent" | "StepEmploymentPersonalInfoComponent" | "StepDriverLicensePersonalInfoComponent" | "StepGeneralIdentityPersonalInfoComponent" | "StepHybridIdentityPersonalInfoComponent" | "StepLicensedProfessionalPersonalInfoComponent" | "StepMoverPersonalInfoComponent" | "StepSuccessComponent" | "StepDocUploadComponent" | "StepPendingComponent" | "StepPendingEmailLoopComponent" | "StepErrorComponent" | "StepSSOComponent" | "StepSMSLoopComponent" | "StepEmailLoopComponent" | "StepSocialSecurity" | "RequestOrganizationSuccessComponent" | "RequestOrganizationErrorComponent" | "RequestOrganizationSearchComponent"

PendingResponse

PendingResponse: { currentStep: "pending"; estimatedReviewTime?: EstimatedReviewTime; maxReviewTime?: MaxReviewTime; statusUrl: string; verificationId: DatabaseId } & WithLocaleAndCountryChoiceAndSegment
description

Response from REST API. Poll statusUrl for updates while document is reviewed.

PersonalInfoResponse

description

Intersection type for all *PersonalInfo responses

PersonalInfoViewModel

PhoneNumber

PhoneNumber: string
example

(111) 222-3333 | 1112223333 | 111-222-3333 TODO - Update this when PhoneNumberValidator regex changes.

PostMessagesOptions

PostMessagesOptions: { interval: number; origin: VerificationUrl }
description

Options for the message events send by a verification loaded on an iframe. These event are used to resize a modal containing a verification.

Type declaration

PostalCodeMatchers

PostalCodeMatchers: Partial<{}>

ProgramResources

ProgramResources: { base: string; organization: string; theme: string }

Type declaration

  • base: string
  • organization: string
  • theme: string

ProgramTheme

ProgramTheme: { config: { countries: Country[]; customFaqLink: FaqUrl; customMetadata: MetadataConfig; estimatedReviewTime: EstimatedReviewTime; excludedOrganizationIds: number[]; locales: Locale[]; marketConsent: MarketConsentOptions; maxReviewTime: MaxReviewTime; offerType: "noCode" | "staticCode" | "rewardPool" | undefined; orgRemoteSource?: OrganizationRemoteSource; orgSearchCountryTags?: {}; orgSearchUrl: string; orgTypes: OrganizationType[]; states?: State[] }; customCss: string; idCheckAddOnEnabled?: boolean; intl: { locale: Locale; messages: ProgramThemeMessages }; ipqsDeviceFingerprintEnabled?: boolean; isSmsNotifierConfigured?: boolean; isTestMode?: boolean; logoUrl?: string; openOrgSearchEnabled?: boolean; privacyPolicyUrl?: string; remainingRewardCodes?: number | null; smsLoopEnabled?: boolean; threatMetrixEnabled?: boolean }
description

Theme information about the Program that was created at my.sheerid.com

Type declaration

  • config: { countries: Country[]; customFaqLink: FaqUrl; customMetadata: MetadataConfig; estimatedReviewTime: EstimatedReviewTime; excludedOrganizationIds: number[]; locales: Locale[]; marketConsent: MarketConsentOptions; maxReviewTime: MaxReviewTime; offerType: "noCode" | "staticCode" | "rewardPool" | undefined; orgRemoteSource?: OrganizationRemoteSource; orgSearchCountryTags?: {}; orgSearchUrl: string; orgTypes: OrganizationType[]; states?: State[] }
  • customCss: string
  • Optional idCheckAddOnEnabled?: boolean
  • intl: { locale: Locale; messages: ProgramThemeMessages }
  • Optional ipqsDeviceFingerprintEnabled?: boolean
  • Optional isSmsNotifierConfigured?: boolean
  • Optional isTestMode?: boolean
  • Optional logoUrl?: string
  • Optional openOrgSearchEnabled?: boolean
  • Optional privacyPolicyUrl?: string
  • Optional remainingRewardCodes?: number | null
  • Optional smsLoopEnabled?: boolean
  • Optional threatMetrixEnabled?: boolean

ProgramThemeMessages

ProgramThemeMessages: { companyName: string; errorId: { noRemainingRewardCodes: string; verificationLimitExceeded: string }; lowRewardPool: string | null; step: { docUpload: { subtitle: string; title: string }; error: { errorId: { expiredProgram: { buttonText: string; title: string }; inactiveProgram: { buttonText: string; title: string }; noRemainingRewardCodes: { buttonText: string; title: string }; verificationLimitExceeded: { title: string } } }; personalInfo: { title: string }; success: { redirectButtonText: string; redirectUrl: string; subtitle: string; title: string } } }
description

These strings are set by a user editing your program in my.sheerid.com

Type declaration

  • companyName: string
  • errorId: { noRemainingRewardCodes: string; verificationLimitExceeded: string }
    • noRemainingRewardCodes: string
    • verificationLimitExceeded: string
  • lowRewardPool: string | null
  • step: { docUpload: { subtitle: string; title: string }; error: { errorId: { expiredProgram: { buttonText: string; title: string }; inactiveProgram: { buttonText: string; title: string }; noRemainingRewardCodes: { buttonText: string; title: string }; verificationLimitExceeded: { title: string } } }; personalInfo: { title: string }; success: { redirectButtonText: string; redirectUrl: string; subtitle: string; title: string } }
    • docUpload: { subtitle: string; title: string }
      • subtitle: string
      • title: string
    • error: { errorId: { expiredProgram: { buttonText: string; title: string }; inactiveProgram: { buttonText: string; title: string }; noRemainingRewardCodes: { buttonText: string; title: string }; verificationLimitExceeded: { title: string } } }
      • errorId: { expiredProgram: { buttonText: string; title: string }; inactiveProgram: { buttonText: string; title: string }; noRemainingRewardCodes: { buttonText: string; title: string }; verificationLimitExceeded: { title: string } }
        • expiredProgram: { buttonText: string; title: string }
          • buttonText: string
          • title: string
        • inactiveProgram: { buttonText: string; title: string }
          • buttonText: string
          • title: string
        • noRemainingRewardCodes: { buttonText: string; title: string }
          • buttonText: string
          • title: string
        • verificationLimitExceeded: { title: string }
          • title: string
    • personalInfo: { title: string }
      • title: string
    • success: { redirectButtonText: string; redirectUrl: string; subtitle: string; title: string }
      • redirectButtonText: string
      • redirectUrl: string
      • subtitle: string
      • title: string

RecentMoverStatus

RecentMoverStatus: "HOME_BUYER" | "OTHER_MOVER"

RejectionReasons

RejectionReasons: "DOCUMENT_UNREADABLE" | "DOCUMENT_PASSWORD_PROTECTED" | "DOCUMENT_LIKELY_FRAUD" | "DOCUMENT_UNSUPPORTED" | "DOCUMENT_HANDWRITTEN" | "MISSING_INFORMATION" | "MISSING_INFORMATION_PERSON_NAME" | "MISSING_INFORMATION_ORGANIZATION_NAME" | "DOCUMENT_EXPIRED" | "DOCUMENT_OUTDATED" | "MISMATCH_PERSON_NAME" | "MISMATCH_ORGANIZATION" | "MISMATCH_STATUS" | "INELIGIBLE_ORGANIZATION" | "MISSING_INFORMATION_UNIVERSITY_ENROLLMENT" | "INELIGIBLE_PERSON_HIGH_SCHOOL_STUDENT" | "MISSING_INFORMATION_AFFILIATION_US_ARMED_FORCES" | "MISMATCH_COMPANY_NAME_OR_ADDRESS" | "PAYSTUB_OUTDATED_LAST_30_DAYS" | "MISSING_INFORMATION_BIRTHDATE" | "MISMATCH_BIRTHDATE" | "DOCUMENT_OUTDATED_FACULTY" | "MISSING_OR_MISMATCH_JOB_TITLE" | "OTHER_CONTACT_US"

RequestOrganizationMessages

RequestOrganizationMessages: { changeLanguage?: DefaultMessages["changeLanguage"]; completeRequest: string; copied: string; countries?: DefaultMessages["countries"]; country?: DefaultMessages["country"]; description: string; eligibleOrgs: string; errorId: { invalidCountry: DefaultMessages["errorId"]["invalidCountry"]; invalidEmail: DefaultMessages["errorId"]["invalidEmail"]; invalidField: string; invalidFirstName: DefaultMessages["errorId"]["invalidFirstName"]; invalidLastName: DefaultMessages["errorId"]["invalidLastName"]; invalidUrl: string; requiredField: string; tooManyResults: string }; faq: string; fields: { countryPlaceholder: string; domainLabel: string; domainPlaceholder: string; orgNameLabel: string; orgNamePlaceholder: string }; ineligibleOrgs: string; locales?: DefaultMessages["locales"]; noCountry: string; none: string; poweredBy?: DefaultMessages["poweredBy"]; searchByOrgName: string; step: { error: { contactUs: string; description: string; seeingProblem: string; title: string }; success: { description: string; title: string } }; submit: string; title: string }
description

These strings are provided for the Request Organization Form

Type declaration

  • Optional changeLanguage?: DefaultMessages["changeLanguage"]
  • completeRequest: string
  • copied: string
  • Optional countries?: DefaultMessages["countries"]
  • Optional country?: DefaultMessages["country"]
  • description: string
  • eligibleOrgs: string
  • errorId: { invalidCountry: DefaultMessages["errorId"]["invalidCountry"]; invalidEmail: DefaultMessages["errorId"]["invalidEmail"]; invalidField: string; invalidFirstName: DefaultMessages["errorId"]["invalidFirstName"]; invalidLastName: DefaultMessages["errorId"]["invalidLastName"]; invalidUrl: string; requiredField: string; tooManyResults: string }
    • invalidCountry: DefaultMessages["errorId"]["invalidCountry"]
    • invalidEmail: DefaultMessages["errorId"]["invalidEmail"]
    • invalidField: string
    • invalidFirstName: DefaultMessages["errorId"]["invalidFirstName"]
    • invalidLastName: DefaultMessages["errorId"]["invalidLastName"]
    • invalidUrl: string
    • requiredField: string
    • tooManyResults: string
  • faq: string
  • fields: { countryPlaceholder: string; domainLabel: string; domainPlaceholder: string; orgNameLabel: string; orgNamePlaceholder: string }
    • countryPlaceholder: string
    • domainLabel: string
    • domainPlaceholder: string
    • orgNameLabel: string
    • orgNamePlaceholder: string
  • ineligibleOrgs: string
  • Optional locales?: DefaultMessages["locales"]
  • noCountry: string
  • none: string
  • Optional poweredBy?: DefaultMessages["poweredBy"]
  • searchByOrgName: string
  • step: { error: { contactUs: string; description: string; seeingProblem: string; title: string }; success: { description: string; title: string } }
    • error: { contactUs: string; description: string; seeingProblem: string; title: string }
      • contactUs: string
      • description: string
      • seeingProblem: string
      • title: string
    • success: { description: string; title: string }
      • description: string
      • title: string
  • submit: string
  • title: string

RequestOrganizationViewModel

RequestOrganizationViewModel: { completeRequest: boolean; countryChoice: FormSelectChoice<Country, string>; displayResults: boolean; eligibleOrgs: Organization[]; email: string; emailError: string; firstName: string; firstNameError: string; ineligibleOrgs: Organization[]; isSearching: boolean; lastName: string; lastNameError: string; localeChoice: FormSelectChoice<Locale, string>; orgCountryError: string; orgDomain: string; orgDomainError: string; orgName: string; orgNameError: string; searchByOrgName: boolean }

Type declaration

  • completeRequest: boolean
  • countryChoice: FormSelectChoice<Country, string>
  • displayResults: boolean
  • eligibleOrgs: Organization[]
  • email: string
  • emailError: string
  • firstName: string
  • firstNameError: string
  • ineligibleOrgs: Organization[]
  • isSearching: boolean
  • lastName: string
  • lastNameError: string
  • localeChoice: FormSelectChoice<Locale, string>
  • orgCountryError: string
  • orgDomain: string
  • orgDomainError: string
  • orgName: string
  • orgNameError: string
  • searchByOrgName: boolean

RestApiOptions

RestApiOptions: { resources: RestResources; serviceUrl: string }

Type declaration

RestResources

RestResources: { conversion: ConversionResources; program: ProgramResources; verification: string }

Type declaration

SMSLoopResponse

SMSLoopResponse: { currentStep: "smsLoop"; errorIds?: [ErrorId]; submissionUrl: string; verificationId: DatabaseId } & WithLocaleAndCountryChoiceAndSegment

SMSLoopVerificationRequest

SMSLoopVerificationRequest: { deviceFingerprintHash?: string; smsCode: string }

Type declaration

  • Optional deviceFingerprintHash?: string
  • smsCode: string

SMSLoopViewModel

SMSLoopViewModel: { deviceFingerprintHash?: string; metadata?: Metadata; phoneNumber: string; smsCode: string } & WithLocaleAndCountry & WithFieldsToSkipValidation

SSOResponse

SSOResponse: { cancelUrl: string; currentStep: "sso"; errorIds?: [ErrorId]; loginUrl: string; verificationId: DatabaseId } & WithLocaleAndCountryChoiceAndSegment
description

Response from REST API indicating that SSO is expected to be submitted next.

SSOViewModel

SSOViewModel: { isSSOActive: boolean; metadata?: Metadata } & WithLocaleAndCountry & WithFieldsToSkipValidation

Segment

Segment: "student" | "military" | "teacher" | "member" | "senior" | "age" | "firstResponder" | "medical" | "employment" | "identity" | "licensedProfessional" | "recentMover"

SegmentSpecificMessages

SegmentSpecificMessages: { emailExplanation: string; schoolName?: string; step: { docUpload: { howDoesVerifyingWorkDetails: string; subtitle: string; title: string; uploadInstructions: string }; personalInfo: { howDoesVerifyingWorkDetails: string; subtitle: string; title: string; tryAgain: { subtitle: string; title: string } }; sso?: { cancel?: string; login?: string; subtitle?: string; subtitle2?: string; title?: string }; success: { redirectButtonText: string; subtitle: string; title: string } } }
description

These strings vary by program segment

Type declaration

  • emailExplanation: string
  • Optional schoolName?: string
  • step: { docUpload: { howDoesVerifyingWorkDetails: string; subtitle: string; title: string; uploadInstructions: string }; personalInfo: { howDoesVerifyingWorkDetails: string; subtitle: string; title: string; tryAgain: { subtitle: string; title: string } }; sso?: { cancel?: string; login?: string; subtitle?: string; subtitle2?: string; title?: string }; success: { redirectButtonText: string; subtitle: string; title: string } }
    • docUpload: { howDoesVerifyingWorkDetails: string; subtitle: string; title: string; uploadInstructions: string }
      • howDoesVerifyingWorkDetails: string
      • subtitle: string
      • title: string
      • uploadInstructions: string
    • personalInfo: { howDoesVerifyingWorkDetails: string; subtitle: string; title: string; tryAgain: { subtitle: string; title: string } }
      • howDoesVerifyingWorkDetails: string
      • subtitle: string
      • title: string
      • tryAgain: { subtitle: string; title: string }
        • subtitle: string
        • title: string
    • Optional sso?: { cancel?: string; login?: string; subtitle?: string; subtitle2?: string; title?: string }
      • Optional cancel?: string
      • Optional login?: string
      • Optional subtitle?: string
      • Optional subtitle2?: string
      • Optional title?: string
    • success: { redirectButtonText: string; subtitle: string; title: string }
      • redirectButtonText: string
      • subtitle: string
      • title: string

SeniorPersonalInfoRequest

SeniorPersonalInfoRequest: { birthDate: BirthDate; postalCode: string } & WithCoreFields
description

The request to submit when verification is on the step "collectSeniorPersonalInfo"

SeniorPersonalInfoResponse

SeniorPersonalInfoResponse: { currentStep: "collectSeniorPersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "senior"; subSegment: null; submissionUrl: string } & VerificationResponse
description

Response from REST API indicating that SeniorPersonalInfoViewModel is expected to be submitted next.

SeniorPersonalInfoViewModel

SocialSecurityRequest

SocialSecurityRequest: { socialSecurityNumber: number }

Type declaration

  • socialSecurityNumber: number

SocialSecurityResponse

SocialSecurityResponse: { cancelUrl: string; currentStep: "collectSocialSecurityNumber"; errorIds?: [ErrorId]; submissionUrl: string; verificationId: DatabaseId } & WithLocaleAndCountryChoiceAndSegment

SocialSecurityViewModel

SocialSecurityViewModel: { metadata?: Metadata; socialSecurityNumber: string } & WithLocaleAndCountry & WithFieldsToSkipValidation

State

State: keyof States

isShowing

isShowing: boolean

States

States: { AK: string; AL: string; AR: string; AZ: string; CA: string; CO: string; CT: string; DC: string; DE: string; FL: string; GA: string; HI: string; IA: string; ID: string; IL: string; IN: string; KS: string; KY: string; LA: string; MA: string; MD: string; ME: string; MI: string; MN: string; MO: string; MS: string; MT: string; NC: string; ND: string; NE: string; NH: string; NJ: string; NM: string; NV: string; NY: string; OH: string; OK: string; OR: string; PA: string; RI: string; SC: string; SD: string; TN: string; TX: string; UT: string; VA: string; VT: string; WA: string; WI: string; WV: string; WY: string }

Type declaration

  • AK: string
  • AL: string
  • AR: string
  • AZ: string
  • CA: string
  • CO: string
  • CT: string
  • DC: string
  • DE: string
  • FL: string
  • GA: string
  • HI: string
  • IA: string
  • ID: string
  • IL: string
  • IN: string
  • KS: string
  • KY: string
  • LA: string
  • MA: string
  • MD: string
  • ME: string
  • MI: string
  • MN: string
  • MO: string
  • MS: string
  • MT: string
  • NC: string
  • ND: string
  • NE: string
  • NH: string
  • NJ: string
  • NM: string
  • NV: string
  • NY: string
  • OH: string
  • OK: string
  • OR: string
  • PA: string
  • RI: string
  • SC: string
  • SD: string
  • TN: string
  • TX: string
  • UT: string
  • VA: string
  • VT: string
  • WA: string
  • WI: string
  • WV: string
  • WY: string

StepComponent

StepComponent: FunctionComponent<{ verificationService: VerificationService }>

StudentPersonalInfoRequest

StudentPersonalInfoRequest: { birthDate: BirthDate } & WithOrganization & WithCoreFields
description

The request to submit when verification is on the step "collectStudentPersonalInfo"

StudentPersonalInfoResponse

StudentPersonalInfoResponse: { currentStep: "collectStudentPersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "student"; subSegment: null; submissionUrl: string } & VerificationResponse
description

Response from REST API indicating that StudentPersonalInfoViewModel is expected to be submitted next.

StudentPersonalInfoViewModel

SubSegment

SubSegment: "college" | "highSchool" | "police" | "emt" | "fireFighter" | "nurse" | "doctor" | "driverLicense" | "generalIdentity" | "hybridIdentity" | "licensedCosmetologists" | "licensedRealState" | "homeBuyer" | "otherMover" | SubSegmentMilitary

SubSegmentMilitary

SubSegmentMilitary: "activeDuty" | "reservist" | "veteran" | "retiree" | "militaryFamily"

SuccessResponse

SuccessResponse: { currentStep: "success"; redirectUrl?: string; rewardCode: string; rewardData?: string[]; verificationId: DatabaseId } & WithLocaleAndCountryChoiceAndSegment
description

Response from REST API. No further requests are expected.

TeacherPersonalInfoRequest

TeacherPersonalInfoRequest: { birthDate?: BirthDate; postalCode?: string } & WithOrganization & WithCoreFields
description

The request to submit when verification is on the step "collectTeacherPersonalInfo"

TeacherPersonalInfoResponse

TeacherPersonalInfoResponse: { currentStep: "collectTeacherPersonalInfo"; errorIds?: [ErrorId]; instantMatchAttempts?: number; segment: "teacher"; subSegment: null; submissionUrl: string } & VerificationResponse
description

Response from REST API indicating that TeacherPersonalInfoViewModel is expected to be submitted next.

TeacherPersonalInfoViewModel

Validator

Validator: (value: FieldContent, formOptions?: FormValidationOptions) => ErrorId | ExtendedErrorId

Type declaration

VerificationRequest

VerificationResponse

VerificationResponse: { currentStep: VerificationStep; errorIds?: ErrorId[]; lastResponse?: VerificationResponse; maxAge?: number; minAge?: number; verificationId: DatabaseId } & WithLocaleAndCountryChoiceAndSegment
description

Base type for all responses

VerificationServiceAction

VerificationStep

VerificationStep: "collectStudentPersonalInfo" | "collectTeacherPersonalInfo" | "collectMemberPersonalInfo" | "collectMilitaryStatus" | "collectActiveMilitaryPersonalInfo" | "collectInactiveMilitaryPersonalInfo" | "collectSeniorPersonalInfo" | "collectAgePersonalInfo" | "collectFirstResponderPersonalInfo" | "collectMedicalProfessionalPersonalInfo" | "collectEmployeePersonalInfo" | "collectDriverLicensePersonalInfo" | "collectGeneralIdentityPersonalInfo" | "collectHybridIdentityPersonalInfo" | "collectLicensedProfessionalPersonalInfo" | "collectMoverPersonalInfo" | "collectSocialSecurityNumber" | "cancelSocialSecurityNumber" | "docUpload" | "pending" | "docReviewLimitExceeded" | "success" | "error" | "sso" | "smsLoop" | "emailLoop" | "cancelEmailLoop"

VerificationStepMap

VerificationStepMap<T>: {}

Type parameters

  • T

Type declaration

VerificationStore

VerificationStore: Store<ReduxState, VerificationServiceAction>

VerificationUrl

VerificationUrl: string
description

URL of a verification to be displayed.

ViewModel

WithAddress

WithAddress: { address1: string; city: string; state: string }

Type declaration

  • address1: string
  • city: string
  • state: string

WithCoreFields

WithCoreFields: { deviceFingerprintHash?: string; email: Email; firstName: string; lastName: string; locale?: Locale; metadata?: Metadata; phoneNumber?: PhoneNumber }

Type declaration

  • Optional deviceFingerprintHash?: string
  • email: Email
  • firstName: string
  • lastName: string
  • Optional locale?: Locale
  • Optional metadata?: Metadata
  • Optional phoneNumber?: PhoneNumber

WithFieldsToSkipValidation

WithFieldsToSkipValidation: { fieldsToSkipValidation?: FieldId[] }

Type declaration

  • Optional fieldsToSkipValidation?: FieldId[]

WithLocaleAndCountry

WithLocaleAndCountry: { countryChoice: FormSelectChoice<Country, string>; localeChoice: FormSelectChoice<Locale, string> }

Type declaration

WithLocaleAndCountryChoiceAndSegment

WithLocaleAndCountryChoiceAndSegment: { country?: Country; locale: Locale; segment: Segment; subSegment: SubSegment }

Type declaration

WithOrganization

WithOrganization: { organization: Organization }

Type declaration

  • organization: Organization

compareLabelReturn

compareLabelReturn: 1 | -1

Variables

Const ACCEPTED_DOC_MIME_TYPES

ACCEPTED_DOC_MIME_TYPES: string[] = ['image/png','image/gif','image/jpg','image/jpeg','image/bmp','application/pdf',]

Const ADOLESCENT_AGE

ADOLESCENT_AGE: 16 = 16

Const AddressComponent

AddressComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(Address)

Const BirthDateComponent

BirthDateComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(BirthDate)

Const BranchOfServiceComponent

BranchOfServiceComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(BranchOfService)

Const ChangeLocaleComponent

ChangeLocaleComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(ChangeLocale)

Const CityComponent

CityComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(City)

Const CollegeNameComponent

CollegeNameComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(CollegeName)

Const CompanyComponent

CompanyComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(Company)

Const CountDown

CountDown: NamedExoticComponent<CountDownProps> & { type: T } = React.memo(({ countdownSeconds, onCountdownFinish, logo }: CountDownProps) => {const [timeRemaining, setTimeRemaining] = React.useState(countdownSeconds);const timeRemainingRef = React.useRef(timeRemaining);const timerRef = React.useRef(null);const tickTimer = () => {const newTime = timeRemainingRef.current - 1;setTimeRemaining(newTime);timeRemainingRef.current = newTime;if (newTime < 0) {onCountdownFinish();clearInterval(timerRef.current);}};const formatSeconds = () => {const seconds = (`0${timeRemaining}`).slice(-2);return `00:${seconds}`;};React.useEffect(() => {timerRef.current = setInterval(tickTimer, 1000);return () => clearInterval(timerRef.current);}, []);return (<div className="sid-header sid-l-horz-center" data-testid="sid-countdown-pending"><div className="sid-l-horz-center">{ logo }</div><div className="sid-header__title sid-l-horz-center sid-l-space-top-md"><FormattedHTMLMessage id="step.pending.titleCountdown" defaultMessage="Processing" /></div><div className="sid-header__subtitle-one"><FormattedHTMLMessageid="step.pending.subtitleCountdown"defaultMessage="Hang tight while we upload and scan your documents."/></div><div id="sid-step-pending" className="sid-l-container"><div className="sid-countdown">{formatSeconds()}</div></div><div className="sid-l-space-top-xl" /></div>);})

Const CountDownComponent

CountDownComponent: NamedExoticComponent<CountDownProps> & { type: T } = CountDown

Const CountryComponent

CountryComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(Country)

Const CountryComponentWrapper

CountryComponentWrapper: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(BaseCountryComponentWrapper)

Const DECIMAL_RADIX

DECIMAL_RADIX: 10 = 10

Const DEFAULT_CDN_BASE_URL

DEFAULT_CDN_BASE_URL: string = "https://cdn.jsdelivr.net/npm/@sheerid/[email protected]/"

Const DEFAULT_LOCALE

DEFAULT_LOCALE: Locale = "en-US"

Const DEFAULT_MINIMUM_ORG_SEARCH_VALUE_LENGTH

DEFAULT_MINIMUM_ORG_SEARCH_VALUE_LENGTH: number = 1

Const DEFAULT_PRIVACY_POLICY_HOST

DEFAULT_PRIVACY_POLICY_HOST: "www.sheerid.com" = "www.sheerid.com"

Const DEFAULT_PRIVACY_POLICY_URL

DEFAULT_PRIVACY_POLICY_URL: "https://www.sheerid.com/privacy-policy/" = "https://www.sheerid.com/privacy-policy/"

Const DOC_UPLOAD_POLL_DURATION

DOC_UPLOAD_POLL_DURATION: 20000 = 20000

Const DOC_UPLOAD_POLL_DURATION_DURING_COUNTDOWN

DOC_UPLOAD_POLL_DURATION_DURING_COUNTDOWN: 5000 = 5000

Const DischargeDateComponent

DischargeDateComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(DischargeDate)

Const DriverLicenseNumberComponent

DriverLicenseNumberComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(DriverLicenseNumber)

Const EMAIL_LOOP_POLL_DURATION

EMAIL_LOOP_POLL_DURATION: 10000 = 10000

Const EmailComponent

EmailComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(Email)

Const FRAME_MSG_PROPERTY

FRAME_MSG_PROPERTY: "verificationId" = "verificationId"

Const FetchOrganizationsComponent

FetchOrganizationsComponent: FetchOrganizations = FetchOrganizations

Const FieldIds

FieldIds: any = Object.values(FieldIdEnum) as any

Const FirstNameComponent

FirstNameComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(FirstName)

Const FirstResponderOrganizationComponent

FirstResponderOrganizationComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(FirstResponderOrganization)

Const FirstResponderStatusComponent

FirstResponderStatusComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(FirstResponderStatus)

Const FirstResponderStatusDefaultMessages

FirstResponderStatusDefaultMessages: any = Object.values(FirstResponderStatusDefaultMessagesEnum) as any

Const HTTP_REQUEST_TIMEOUT

HTTP_REQUEST_TIMEOUT: 10000 = 10000

Const HookNames

HookNames: any = Object.values(HookNameEnum) as any

Const InputSelectButtonComponent

InputSelectButtonComponent: InputSelectButton = InputSelectButton

Const InputSelectComponent

InputSelectComponent: InputSelect = InputSelect

Const InputSelectListComponent

InputSelectListComponent: InputSelectList = InputSelectList

Const InputTextComponent

InputTextComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(InputText)

Const LastNameComponent

LastNameComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(LastName)

Const LicensedProfessionalOrganizationComponent

LicensedProfessionalOrganizationComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(LicensedProfessionalOrganization)

Const Locales

Locales: Locale[] = ['ar', 'bg', 'cs', 'da', 'de', 'el', 'en-GB', 'en-US', 'es-ES', 'es', 'fi', 'fr-CA', 'fr', 'ga', 'hr', 'hu', 'id', 'it', 'iw', 'ja', 'ko', 'lo', 'lt', 'ms', 'nl', 'no', 'pl', 'pt-BR', 'pt', 'ru', 'sk', 'sl', 'sr', 'sv', 'th', 'tr', 'zh-HK', 'zh']
description

List of locales supported by the library, for runtime checks.

Const MAX_BIRTHYEAR

MAX_BIRTHYEAR: 3000 = 3000

Const MAX_DOC_UPLOAD_DOCS_ALLOWED

MAX_DOC_UPLOAD_DOCS_ALLOWED: number = 3

Const MAX_ITEMS

MAX_ITEMS: 25 = 25

Const MIN_BIRTHYEAR

MIN_BIRTHYEAR: 1900 = 1900

Const MedicalProfessionalOrganizationComponent

MedicalProfessionalOrganizationComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(MedicalProfessionalOrganization)

Const MedicalStatusComponent

MedicalStatusComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(MedicalStatus)

Const MedicalStatusdefaultMessages

MedicalStatusdefaultMessages: any = Object.values(MedicalProfessionalStatusDefaultMessagesEnum) as any

Const MemberIdComponent

MemberIdComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(MemberId)

Const MembershipOrganizationComponent

MembershipOrganizationComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(MembershipOrganization)

Const MilitaryStatusComponent

MilitaryStatusComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(MilitaryStatus)

Const MilitaryStatusDefaultMessages

MilitaryStatusDefaultMessages: any = Object.values(MilitaryStatusDefaultMessagesEnum) as any

Const MockSteps

MockSteps: any[] = [...Object.values(VerificationStepsEnum) as any,...Object.values(MockStepsEnum) as any,]

Const NewVerificationComponent

NewVerificationComponent: ComponentClass<{} & NewVerificationProps, any> & { WrappedComponent: Component<P> } = connect(mapStateToProps,mapDispatchToProps,mergeProps,)(NewVerification)

Const OptInInputComponent

OptInInputComponent: OptInInput = OptInInput

Const OrganizationListComponent

OrganizationListComponent: OrganizationList = OrganizationList

Const PhoneNumberComponent

PhoneNumberComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(PhoneNumber)

Const PostalCodeInputComponent

PostalCodeInputComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(PostalCodeInput)

Const PrivacyPolicyLinkComponent

PrivacyPolicyLinkComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(PrivacyPolicyLink)

Const QUERY_STRING_ERRORID_OVERRIDE

QUERY_STRING_ERRORID_OVERRIDE: string = "mockErrorId"

Const QUERY_STRING_INSTALL_PAGE_URL

QUERY_STRING_INSTALL_PAGE_URL: string = "installPageUrl"

Const QUERY_STRING_PREV_STEP_OVERRIDE

QUERY_STRING_PREV_STEP_OVERRIDE: string = "mockPreviousStep"

Const QUERY_STRING_SEGMENT_OVERRIDE

QUERY_STRING_SEGMENT_OVERRIDE: string = "mockSegment"

Const QUERY_STRING_STEP_OVERRIDE

QUERY_STRING_STEP_OVERRIDE: string = "mockStep"

Const QUERY_STRING_SUBSEGMENT_OVERRIDE

QUERY_STRING_SUBSEGMENT_OVERRIDE: string = "mockSubSegment"

Const ROW_HEIGHT

ROW_HEIGHT: 42 = 42

Const RecentMoverStatusDefaultMessages

RecentMoverStatusDefaultMessages: any = Object.values(RecentMoverStatusDefaultMessagesEnum) as any

Const RequestOrganizationContext

RequestOrganizationContext: Context<[{ error: string; isInitialized: boolean; isLoading: number; locale: Locale; messages: RequestOrganizationMessages; programId: DatabaseId; programTheme: ProgramTheme; submitted: boolean; viewModel: RequestOrganizationViewModel }, Function]> = React.createContext<[RequestOrganizationService, Function]>([getInitialState(), () => {}])

Const RequestOrganizationSearchComponent

RequestOrganizationSearchComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(RequestOrganizationSearch)

Const ReviewPendingComponent

ReviewPendingComponent: ReviewPending = ReviewPending

Const SEGMENT_ID

SEGMENT_ID: "licensed-professional" = "licensed-professional"

Const SHEERID

SHEERID: "SheerID" = "SheerID"

Const SMSCodeComponent

SMSCodeComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(SMSCode)

Const SSN_STRING_LENGTH

SSN_STRING_LENGTH: number = 9

Const SSOPendingComponent

SSOPendingComponent: SSOPending = SSOPending

Const SSO_POLL_DURATION

SSO_POLL_DURATION: 5000 = 5000

Const Segments

Segments: any = Object.values(SegmentEnum) as any

Const SelectButtonComponent

SelectButtonComponent: SelectButton = SelectButton

Const SelectComponent

SelectComponent: Select = Select

Const SelectListComponent

SelectListComponent: SelectList = SelectList

Const SocialSecurityNumber

SocialSecurityNumber: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(SocialSecurity)

Const SsnChoice

SsnChoice: Step = Step

Const StateComponent

StateComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(State)

Const StateSelectComponent

StateSelectComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StateSelect)

Const StatusComponent

StatusComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(Status)

Const StepActiveMilitaryPersonalInfoComponent

StepActiveMilitaryPersonalInfoComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StepActiveMilitaryPersonalInfo)

Const StepAgePersonalInfoComponent

StepAgePersonalInfoComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StepAgePersonalInfo)

Const StepDocUploadComponent

StepDocUploadComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StepDocUpload)

Const StepDriverLicensePersonalInfoComponent

StepDriverLicensePersonalInfoComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StepDriverLicensePersonalInfo)

Const StepEmailLoopComponent

StepEmailLoopComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StepEmailLoop)

Const StepEmploymentPersonalInfoComponent

StepEmploymentPersonalInfoComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StepEmploymentPersonalInfo)

Const StepErrorComponent

StepErrorComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StepError)

Const StepFirstResponderPersonalInfoComponent

StepFirstResponderPersonalInfoComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StepFirstResponderPersonalInfo)

Const StepGeneralIdentityPersonalInfoComponent

StepGeneralIdentityPersonalInfoComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StepGeneralIdentityPersonalInfo)

Const StepHybridIdentityPersonalInfoComponent

StepHybridIdentityPersonalInfoComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StepHybridIdentityPersonalInfo)

Const StepInactiveMilitaryPersonalInfoComponent

StepInactiveMilitaryPersonalInfoComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StepInactiveMilitaryPersonalInfo)

Const StepLicensedProfessionalPersonalInfoComponent

StepLicensedProfessionalPersonalInfoComponent: ComponentClass<{}, any> & { WrappedComponent: React.ComponentType<P & InjectedIntlProps> } = injectIntl(StepLicensedProfessionalPersonalInfo)