Reports

Reports are PDF summaries of data retrieved from users' connected payroll accounts.

Types of reports#

VOIE — Verification of Income & Employment#

• Includes the user's employment history and yearly income totals.
• Example VOIE report (PDF)

VOE — Verification of Employment#

• Includes only the user's employment history.
• Often used when re-verification of the user's income is not necessary.
• Example VOE report (PDF)

Generating reports#

Console#

1. Navigate to the Connections section of Console and click on an individual user.

2. Select "Generate report" within the Reports area of the user's page once all data sets have fully synced.

   Depending on the data retrieval speed limits of the underlying payroll platform, it can take from a few seconds up to several minutes after a new account connection before enough data has been synced to generate a complete report. Visit our Data Delivery Guide for more information on the timing of data retrieval.

   

3. Select the type of report you want to generate when the pop-up window appears.

   

API#

1. Send a POST request to the API's /reports endpoint.
2. Include the following JSON object in the request body:

1{
2    "user": "<ID of the user>",
3    "type": "voie"
4}

We recommend subscribing to the users.fully_synced webhook, which is sent when all data has been retrieved from all accounts connected by a user, to ensure full data availability when generating a report via the API.