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

​
Overview

This endpoint creates a bank income insights report for the user as part of the Bank Integration verification method, enabling analysis of income patterns derived from bank account data.

​
Authentication

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

​
Path Parameters

​
user_id
string
required
Unique identifier for the user.

​
Response

The endpoint returns a success response (HTTP 201) upon successful report creation.

​
Error Responses

Status CodeError CodeDescription
400incorrect_parametersInvalid or missing request parameters
401authentication_failedAuthentication credentials invalid or missing
403not_authenticatedInsufficient permissions
Users must be authenticated and provisioned before creating reports. The report creation is asynchronous; check the report status separately for completion details.