SHsheerid
verification

Begin verification flow

Changed on

Start the verification flow for a given program

post/verification

Request

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

Request body

programIdstring required

The program ID to use for the verification

trackingIdstring

An optional ID specified by the consumer to support conversion tracking

installPageUrlstring

The URL for the page installing the verification form

localestring

The locale chosen by the user

metadataPersonalInfoMetadata

A collection of custom metadata to be stored with the verification

externalUserIdstring

An identifier stored with the verification for external reference

Response

The initial information required to render the verification form

verificationIdstring required

The unique identifier for the ongoing verification

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.

submissionUrlstring required

The url to use for submitting person data

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

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

    • 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