SHsheerid
report

Generate a verification report

Changed on

Generate a verification report which can be downloaded later

post/report/verification

Request

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

Request body

format'CSV' required
startDatestring date-time
endDatestring date-time
isPiiIncludedboolean

Optional toggle for whether or not to include PII in report. User must have appropriate permissions to request PII. If this field is omitted, PII details will only be returned if requesting user has appropriate permissions.

piiReasonstring

Reason for requesting PII in the report. Required if isPiiIncluded=true.

verificationModeInclusion'ALL' | 'LIVE' | 'TEST'

Which verification modes to include in the verification report.

programIdsstring[]

Optional list of program ids belonging to the User's account. If provided, the report will only include verifications associated with the program ids requested.

countryCodesstring[]

Optional list of country codes. If provided, the report will only include verifications from the countries requested.

rewardEligibilitiesRewardEligibility[]

Optional list of eligibility states. If provided, the report will only include verifications that resulted in those states requested.

communitiesCommunity[]

Optional list of affiliation types. If provided, the report will only include verifications of the affiliation types requested.

standardFieldsstring[]

The list of standard field names to include in the report. See List Report Fields to retrieve a list of available fields.

personFieldsstring[]

The list of person data field names to include in the report. See List Report Fields to retrieve a list of available fields.

metadataFieldsstring[]

The list of metadata field names to include in the report. See List Report Fields to retrieve a list of available fields.

Response

Accepted

idstring
status'PENDING' | 'COMPLETE' | 'ERROR' | 'DELETED'
statusUrlstring uri
retrievalUrlstring uri nullable

The URL to download the completed report from. The value is null until the status of the report becomes COMPLETE.

requesterstring
createdinteger

Changes