verification

Submit student data

Changed on

Submit data for a student verification

post/verification/{verificationId}/step/collectStudentPersonalInfo

Request

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

Path parameters

verificationIdstring required

Unique identifier for the ongoing verification

Request body

firstNamestring required

The first name of the person being verified

lastNamestring required

The last name of the person being verified

deviceFingerprintHashstring

The device fingerprint collected for the person being verified

emailstring required

The email address of the person being verified

birthDatestring date required

The date of birth of the person being verified (format YYYY-MM-DD). Date must be greater than 1900-01-01.

statusesStudentStatus[]

List of student statuses.

ipAddressstring ipv4

The end-user's public IP address. This only needs to be provided in situations where the HTTP requests do not come directly from the end-user.

ipAddressExtendedstring ipv4,ipv6

The end-user's public IP address. This only needs to be provided in situations where the HTTP requests do not come directly from the end-user.

externalUserIdstring

An identifier stored with the verification for external reference

captchaTokenstring

The captcha token collected for the person being verified

cvecNumberstring

The unique CVEC number for the person being verified

phoneNumberstring

The phone number used for SMS messages

localestring

The locale chosen by the user

metadataPersonalInfoMetadata

A collection of custom metadata to be stored with the verification

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.

Response

The result of the verification

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • warning

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