Retrieve Income Insights (Customer)

get

https://api.inscribe.ai/api/v2/customers/{customer_id}/credit_analysis/income_insights

Returns income insights derived from submitted customer documents and transactions.

Path Params

customer_id

uuid

required

The id of the customer to return.

Query Params

start_date

date

Specifies the start date for data retrieval. Only data with a date on or after this will be considered. This helps in filtering the data to a specific time frame of interest.

end_date

date

Specifies the end date for data retrieval. Only data with a date before this will be considered. This helps in filtering data to a specific time frame of interest.

document_ids

string

A comma separated list of document UUIDs. Only data from these documents will be considered (as well as open banking data). This helps in filtering data to include/exclude certain documents.

include_unreconciled_documents

boolean

Unreconciled bank statements are statements where the difference between the parsed opening and closing balances is not explained by the sum of the parsed transaction amounts. Statements are typically unreconciled if the uploaded document has poor quality or is missing some of its original pages. It can also happen when the parsing models fail to parse and extract all relevant data. If this parameter is set to False, unreconciled bank statements will be excluded from the credit insights. This parameter defaults to True, keeping all documents included.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successfully retrieved customer income insights.

400You have provided incorrect data.

403You do not have permission to access this resource.

429Too many requests. The request has been rate limited. For more information, visit our documentation on rate limiting.