verification

Get verification details

Changed on

Get detailed information about a verification. Requires an API token. The PersonInfo field will only be populated to users with the Customer PII role.

get/verification/{verificationId}/details

Request

  • Base URL
    https://services.sheerid.com/rest/v2
  • Auth
    HTTP bearer

Path parameters

verificationIdstring required

Unique identifier for the ongoing verification

Response

Detailed information about the verification

createdinteger required

The date that the verification was created

updatedinteger required

The date that the verification was updated

programIdstring required

The program ID that was used to create this verification

trackingIdstring

The tracking ID that was assigned to this verification

personIdstring

The person ID that was assigned to the person for this verification

socialIdstring required

The unique identifier that can be used to track social sharing of an offer

docUploadRejectionCountnumber required

The number of times that the server rejected the documents for this verification. This number is always equal to the number of entries in docUploadRejectionReasons.

approvingVerificationTypesExternalVerificationType[]

A list of all verification types that contributed to the final approved outcome.

verificationMethod'INSTANT' | 'MANUAL' nullable required

The method used to decision a verification. Null for verifications that are in progress, or that expired before completion

Changes

    • warning

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

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status