Generate a verification report
Generate a verification report which can be downloaded later
Request body
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.
Reason for requesting PII in the report. Required if isPiiIncluded=true.
Which verification modes to include in the verification report.
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.
Optional list of country codes. If provided, the report will only include verifications from the countries requested.
Optional list of eligibility states. If provided, the report will only include verifications that resulted in those states requested.
Optional list of affiliation types. If provided, the report will only include verifications of the affiliation types requested.
The list of standard field names to include in the report. See List Report Fields to retrieve a list of available fields.
The list of person data field names to include in the report. See List Report Fields to retrieve a list of available fields.
The list of metadata field names to include in the report. See List Report Fields to retrieve a list of available fields.
Response
Accepted
The URL to download the completed report from. The value is null until the status of the report becomes COMPLETE.
Changes
No recorded changes to this endpoint across all 1 revision of this API.