Skip to main content
GET
/
v1
/
users
/
{user_id}
/
reports
/
{report_id}
/
Retrieve an Income and Employment Report
curl --request GET \
  --url https://api.example.com/v1/users/{user_id}/reports/{report_id}/

​
Overview

This endpoint retrieves a previously generated income and employment report for a specific user. The report provides verified employment and income information.

​
Authentication

This endpoint requires API authentication using:
  • ClientID (Header)
  • AccessKey (Header)

​
Path Parameters

​
user_id
string
required
The unique Transcrypts identifier for the user.
​
report_id
string
required
The unique identifier for the report to retrieve.

​
Response

The endpoint returns report data in JSON format. The response structure includes employment verification details and income information extracted from connected payroll systems.

​
Error Responses

Status CodeDescription
401Unauthorized - Authentication credentials were invalid or missing
403Forbidden - Authentication credentials were not provided or access is denied
404Not Found - The specified report or user was not found