Skip to main content
POST
Create a user bank income insights report

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Path Parameters

user_id
string
required

Body

application/json

Income insights report parameters.

days_requested
integer
default:60
required

The specific duration in days for which the report is requested to be generated.

Required range: 30 <= x <= 730
consumer_report_permissible_purpose
enum<string>

Describes the reason you are generating an Income Insights Report for this user.

Available options:
ACCOUNT_REVIEW_CREDIT,
ACCOUNT_REVIEW_NON_CREDIT,
EMPLOYMENT,
EXTENSION_OF_CREDIT,
LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING,
LEGITIMATE_BUSINESS_NEED_OTHER,
WRITTEN_INSTRUCTION_PREQUALIFICATION,
WRITTEN_INSTRUCTION_OTHER
Example:

"ACCOUNT_REVIEW_CREDIT"

Response

report_id
string
required
read-only

Unique identifier of the report.

Maximum string length: 32
Example:

"7d4fcb86b81a4880955beea558092391"

created_at
string<date-time>
required
read-only

Timestamp when the report was created.

Example:

"2022-05-04T11:30:00Z"

completed_at
string<date-time>
required
read-only

Timestamp when the report was completed.

Example:

"2022-05-04T12:00:00Z"

days_requested
integer<int32>
required
read-only

Number of days for which transactions are requested.

Example:

60

List of assets links

bank_income_summary
object
required