SHsheerid
verification

Allow user to submit an alternate email address

Changed on

Allows a user to submit an alternate email address. This email address will be used for the Email Loop. The domain of the email address will be validated prior to sending the email message. If the domain is valid for the organization associated with the request, then the user will have been sent an email message containing a link that will complete the email loop, unless the program is configured to bypass sending the email.

post/verification/{verificationId}/step/emailLoop/emailAddressOverride

Request

  • Base URL
    https://services.sheerid.com/rest/v2
  • Auth
    none declared

Path parameters

verificationIdstring required

Unique identifier for the ongoing verification

Request body

emailAddressstring

The email address of the person being verified

Response

The result of the override. If the verification stays at the email loop step, the response is a ResumeEmailLoopResponse. If the loop is complete, the response is the response for the next step.

verificationIdstring required

The unique ID for the VerificationRequest associated with this response

currentStep'collectStudentPersonalInfo' | 'collectActiveMilitaryPersonalInfo' | 'collectInactiveMilitaryPersonalInfo' | 'collectTeacherPersonalInfo' | 'collectSeniorPersonalInfo' | 'collectAgePersonalInfo' | 'collectFirstResponderPersonalInfo' | 'collectMedicalProfessionalPersonalInfo' | 'collectEmployeePersonalInfo' | 'collectMemberPersonalInfo' | 'collectLicensedProfessionalPersonalInfo' | 'collectMoverPersonalInfo' | 'collectLowIncomePersonalInfo' | 'collectDriverLicensePersonalInfo' | 'collectGeneralIdentityPersonalInfo' | 'collectHybridIdentityPersonalInfo' | 'collectPersonalInfo' | 'collectMilitaryStatus' | 'collectMarketplaceToken' | 'collectSocialSecurityNumber' | 'collectIdentifier' | 'completeAuthentication' | 'docUpload' | 'sso' | 'success' | 'error' | 'pending' | 'emailLoop' | 'idCheckLoop' | 'smsLoop' | 'thirdPartyLoop' | 'consolation' | 'override' | 'inCountryVerification' required

The step that the verification is at. Each step tells you what to do next.

One value is deprecated: collectHybridIdentityPersonalInfo. The API can still return it, so your client must accept it. The endpoint that submits this step is not part of the public API. Do not build a new integration on it.

errorIdsErrorId[]

The list of errors that occurred, if any

segment'student' | 'teacher' | 'military' | 'senior' | 'age' | 'firstResponder' | 'medical' | 'employment' | 'marketplace' | 'member' | 'licensedProfessional' | 'recentMover' | 'other' | 'lowIncome' | 'identity' nullable

The market segment for the verification. The value can be null if the server did not determine the segment. For example, the server sends an error before a verification exists.

subSegment'activeDuty' | 'veteran' | 'retiree' | 'reservist' | 'militaryFamily' | 'goldStarFamily' | 'police' | 'fireFighter' | 'searchAndRescue' | 'emt' | 'employee' | 'homeBuyer' | 'otherMover' | 'facultyHighSchool' | 'facultyUniversity' | 'facultyPostSecondary' | 'facultyK12' | 'fullAndPartTimeUniversity' | 'collegeBound' | 'highSchool' | 'graduate' | 'postSecondary' | 'nurse' | 'doctor' | 'otherHealthWorker' | 'dentist' | 'pharmacist' | 'generalContractor' | 'snapBenefits' | 'otherGovernmentAssistance' | 'communityEligibilityProvision' | 'architect' | 'interiorDesigner' | 'librarian' | 'childCareWorker' | 'veterinarian' | 'licensedRealEstateAgent' | 'licensedCosmetologist' | 'generalIdentity' | 'driverLicense' | 'hybridIdentity' | 'k12' | 'nutritionProfessional' nullable

The subsegment being verified. May be null when the verification has no applicable subsegment.

localestring

The locale chosen by the user

countrystring nullable

The ISO 3166-1 alpha-2 country code of the person being verified. In a response, the value can be null if the verification has no country.

createdinteger
updatedinteger
currentState'collectOrganizationEmail' | 'pending'
submissionUrlstring required

The url to use for submitting the email loop token

cancelUrlstring

The url to send a DELETE request to in order to cancel an ongoing email loop verification and move to the the docUpload step. Program must have an "Email Loop with Domain Validation" verification type to use this feature.

canResendEmailLoopboolean
tokenstring

The email loop token for the requested verification

Changes

  • 2373facbc1c2Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • bf4b86260e69Revision changes
    • warning

      added the new inCountryVerification enum value to the response property for the response status

    • warning

      added the new inCountryVerification enum value to the response property for the response status

    • warning

      added the new inCountryVerification enum value to the response property for the response status

    • warning

      added the new inCountryVerification enum value to the response property for the response status

    • warning

      added the new inCountryVerification enum value to the response property for the response status