Skip to main content
Reports package the income, employment, or asset information users share through a report-based verification workflow.
Payroll data can be packaged into income and employment verification reports.
The diagram above illustrates payroll reports. Verifications also supports banking, Doc VOI, and government report types.

​
Report types

Review Reports and Source Documents for example PDFs and JSON.

​
Generate reports through Verifications

The Verifications API supports all current report types and is recommended for new report-based implementations.
  1. Create or reuse a user.
  2. Order a verification with the required report.type.
  3. Complete the required account-connection or document steps.
  4. Listen for the verifications.updated webhook.
  5. Retrieve the report when the verification reaches completed or completed_with_errors.
See the Verifications Quickstart.

​
Generate payroll reports in Console

Console-only implementations can generate supported payroll reports without using the API:
  1. Open the user in the Connections section after their payroll data is available.
  2. Select Generate report in the Reports area.
Generate a payroll report from a user's page in Console.
  1. Select the payroll report type and generate the report.
Select a payroll report type in Console.
Banking and Doc VOI reports cannot currently be generated in Console. Use the Verifications API or a supported integration to order them. Completed reports can be viewed and downloaded in Console when available.

​
Classic Reports API

The classic /v2/reports/{type} workflow supports only a subset of payroll report types and remains available for existing integrations. Use the reports.ready webhook to determine when sufficient payroll data is available before generating a classic report. Use the reports.generated webhook to track asynchronous report generation.
The classic Reports API remains available for existing payroll integrations. For new report-based implementations, start with Verifications.

​
Retrieve report files

Verification resources provide report.file_url and report.json_url when the report is ready. Classic report objects provide the corresponding report URLs for their supported types. Requests to report file URLs require Argyle authentication headers.

​
GSE validation

Payroll and Doc VOI reports can support Day 1 Certainty® and AIM workflows when the required product and configuration are enabled. See Day 1 Certainty® and AIM.