Prepare Verification Request

Prepare a verification request.

Request Details

HTTP Method(s)

GET

Resource URI

https://services-sandbox.sheerid.com/rest/0.5/verification

Parameters

Name Type Description
any field name from List Fields mixed value for the specified field (ex: FIRST_NAME=Thomas)
metadata key (any string prefixed with :) string metadata value for the supplied key (ex: :orderId=179365)
_affiliationTypes AffiliationType[] A comma-delimited list of affiliation type names (see List Affiliation Types). Defines the affiliations the requestor deems acceptable for a given verification. (For example, when attempting to verify that an individual is either a full-time or part-time student: _affiliationTypes=STUDENT_FULL_TIME,STUDENT_PART_TIME)
_assetTypes AssetType[] A comma-delimited list of asset type names (see List Asset Types). Defines the requestor's list of acceptable documents for use with ASSET_REVIEW verification types. If ASSET_REVIEW is not an allowable verification type, this configuration is ignored.
_rewardIds string[] A comma-delimited list of Reward IDs (see List Rewards). Defines any rewards to be issued when an individual is verified.
_verificationTypes VerificationType[] A comma-delimited list of verification type names (see List Verification Types). Defines the requestor's list of acceptable techniques that may be used to verify an individual.
matchName boolean false to disable matching of organizationName. If organizationId is supplied or organizationName is not supplied, this parameter is ignored.
organizationId long an optional organization id, see List Organizations
organizationName string an organization name supplied when the ID is not known. If organizationId is supplied, this parameter is ignored.
organizationType OrganizationType an organization type (see List Organization Types) to help when matching the organization name. If organizationId is supplied or organizationName is not supplied, this parameter is ignored.
Possible values: UNIVERSITY, MEMBERSHIP, MILITARY, FIRST_RESPONDER, MEDICAL, NON_PROFIT, CORPORATE, K12
token string a script token which is issued by the account in which the request should be prepared

Response Details

Expected Response

204 No Content