Skip to main content
GET
/
v1
/
users
/
{user_id}
/
income_insights
/
reports
/
{report_id}
/
Retrieve a User Bank Income Insights Report
curl --request GET \
  --url https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/

​
Overview

This endpoint retrieves a bank income insights report for a specific user as part of the Bank Integration verification method. The report provides analyzed financial data based on bank account information.

​
Authentication

This endpoint requires API credentials:
  • ClientID (Header)
  • AccessKey (Header)

​
Path Parameters

​
user_id
string
required
The unique identifier for the user.
​
report_id
string
required
The unique identifier for the specific report.

​
Response

The endpoint returns report data in JSON format containing analyzed income insights from connected bank accounts.

​
Error Responses

Status CodeDescription
401Unauthorized - Authentication failed or invalid token
403Forbidden - User is not authenticated or lacks permissions
404Not Found - The specified user or report does not exist