---
title: "Retrieve Summary Insights (Customer)"
method: GET
path: "/customers/{customer_id}/credit_analysis"
tags: ["Credit Insights"]
---

# Retrieve Summary Insights (Customer)

`GET /customers/{customer_id}/credit_analysis`

Returns income and creditworthiness information extracted from transactions belonging to a specific customer.

## Path parameters

- `customer_id` string, uuid, required

## Query parameters

- `start_date` string, date
- `end_date` string, date
- `document_ids` string
- `include_unreconciled_documents` boolean

## Response `200`

Successfully retrieved customer credit insights.

- CustomerCreditAnalysis
  - `summary_statistics` CreditSummaryStatistics — Summary statistics that contain inferred creditworthiness and income information (based on the submitted customer documents and transactions).
    - `credits_count` integer — The quantity of credit transactions within the customer's transactions.
    - `credits_total` integer — Summed amounts of all credit transactions within the customer's transactions (in cents). (Also still accessible via the deprecated alias `credits_total_gross`.)
    - `debits_count` integer — The quantity of debit transactions within the customer's transactions.
    - `debits_total` integer — Summed amounts of all debit transactions within the customer's transactions (in cents). (Also still accessible via the deprecated alias `debits_total_gross`.)
    - `maximum_consecutive_days` integer — The longest sequence of consecutive days that the uploaded customer data covers.
    - `personal_income_annual_gross` integer — The estimated gross annual personal income for the customer inferred from submitted payslips (in cents). (Also still accessible via the deprecated alias `salary_annual_gross`.)
    - `personal_income_annual_net` integer — The estimated net annual personal income for the customer inferred from their transactions and/or payslips (in cents). (Also still accessible via the deprecated alias `salary_annual_net`.)
    - `personal_income_period_gross` integer — The total gross summed personal income found within the customer's submitted payslips (in cents). The term `period` refers to the time interval covering the earliest date to the latest date found in the submitted data. (Also still accessible via the deprecated alias `salary_period_gross`.)
    - `personal_income_period_net` integer — The total net summed personal income found within the customer's transactions and/or payslips (in cents). The term `period` refers to the time interval covering the earliest date to the latest date found in the submitted data. (Also still accessible via the deprecated alias `salary_period_net`.)
    - `revenue_annual_gross` integer — The estimated gross annual revenue for the customer inferred from their transactions (in cents).
    - `revenue_period_gross` integer — The total gross summed revenue found within the customer's transactions (in cents). The term `period` refers to the time interval covering the earliest date to the latest date found in the submitted data.
    - `total_net` integer — The summed debit amounts minus the summed credit amounts (in cents).
    - `transfers_count` integer — The quantity of transfer transactions within the customer's transactions.
    - `transfers_credits_total` integer — Summed amounts of all credit transfer transactions within the customer's transactions (in cents). (Also still accessible via the deprecated alias `transfers_credits_total_gross`.)
    - `transfers_debits_total` integer — Summed amounts of all debit transfer transactions within the customer's transactions (in cents). (Also still accessible via the deprecated alias `transfers_debits_total_gross`.)
    - `unique_days_count` integer — Number of distinct days covered by the customer's bank statements and transactions.
  - `bank_accounts` string[] — A list of bank accounts associated with the customer.
  - `metadata` MetadataInsights — Additional data which provides context about Inscribe's Credit Insights response.
    - `confidence_score` number, float — The confidence score represents the degree of certainty for the accuracy of the Credit Insights outputs. We calculate this score using a weighted combination of parsing and transaction categorization certainties. Confidence scores above 0.5 represent high confidence.
    - `customer_contains_low_trust_score_documents` boolean — This value will be set to True if the customer contains any documents under a trust score threshold of 50. Else, this will be set to False.
    - `included_data_sources` object — Lists all documents and open banking data which were used to create the Inscribe Credit Insights.
      - `documents` object[]
        - `document_id` string, uuid
      - `open_banking` object[]
        - `open_banking_data_id` string, uuid
    - `excluded_data_sources` object — Lists all documents and open banking data which were excluded from the Inscribe Credit Insights. Documents can be excluded if they are duplicate documents, or when the include_unreconciled_documents query parameter is set to False.
      - `documents` object[]
        - `document_id` string, uuid
        - `exclusion_reason` string, string
      - `open_banking` object[]
        - `open_banking_data_id` string, uuid
    - `query_parameters` object — Lists the query parameters which were used in the original endpoint request.
  - `confidence_score` number, float — The confidence score represents the degree of certainty for the accuracy of the Credit Insights outputs. We calculate this score using a weighted combination of parsing and transaction categorization certainties. Confidence scores above 0.5 represent high confidence. Also accessible under the `metadata` header.
  - `customer_contains_low_trust_documents` boolean — This value will be set to True if the customer contains any documents under a trust score threshold of 50. Else, this will be set to False. Also accessible under the `metadata` header.

## Other responses

- `400` — You have provided incorrect data.
- `403` — You do not have permission to access this resource.
- `429` — Too many requests. The request has been rate limited. For more information, visit our [documentation on rate limiting](https://docs.inscribe.ai/docs/are-the-endpoints-rate-limited).

---

[API](https://skmtc.dev/inscribe/apis/core-resources.md) · [All operations](https://skmtc.dev/inscribe/apis/core-resources/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inscribe/core-resources/revisions/6489b36eb60f/schema)