Learn about the /reports endpoint.
Report objects contains information related to reports generated for a user, including:
- Verification of Income and Employment (VOIE) reports
- Verification of Employment (VOE) reports
Reports are generated on request and are based on data available from payroll providers.
Attributes
| Attribute | Type | Description |
|---|---|---|
| id | string | Unique ID of the report object. |
| user | string uuid | A unique ID assigned to a user. |
| reference_id | string uuid | Unique ID of the report referenced on the PDF used as a single reference point. |
| generated_at | string | Shows the date and time when the report was generated. |
| type | string | Type of report, either:voie - Verification of Income and Employment (VOIE) report.voe - Verification of Employment (VOE) report. |
| status | string | The status of the report generation process. Possible values:waiting_for_sync - account is being synced.generating - report is being generated.generated - report is ready to be downloaded. |
| file_url | string | The file_url contains a direct link to the file. This link is valid for 15 minutes. When it expires, you can call the reports endpoint again to generate another valid URL. |
| metadata.purpose | JSON object | Other report metadata for internal use, such as the purpose of the report. |
| metadata.email | JSON object | Defines the email address to which a generated report will be sent. |
Endpoints
These are the endpoints available for reports.
| Endpoints |
|---|
Generate a report - POST /reports/generate |
Retrieve a report - GET /reports/:id |
List reports - GET /reports |
Example object
{
"id": "9f82994c-774d-11eb-b1c7-13e87316bacb",
"reference_id": "VOIE12357",
"generated_at": "2020-11-29T08:33:41.525392Z",
"type": "voie",
"user": "8a5f613a-673a-4434-aeee-1a38b960b936",
"status": "generated",
"file_url": "www.company.com/voie_report.pdf",
"metadata": {
"purpose": "Risk Assesment",
"email": "[email protected]"
}
}