> For the complete documentation index, see [llms.txt](https://docs.bullcredtech.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bullcredtech.com/api-reference/apis-en/api-reference-client/get-customers-summary.md).

# Customer Summary

**GET** `/customers/{cpf}/summary`

Returns in a single response the consolidated customer summary: contact data, available loan amount, and list of contracts.

This route aggregates in one call what would normally require multiple requests — useful for "customer profile" screens or relationship dashboards.

## URL Parameters

| Parameter | Type   | Description                                 |
| --------- | ------ | ------------------------------------------- |
| `cpf`     | string | Customer's CPF (digits only, 11 characters) |

## Request Example

```http
GET /customers/12345678909/summary HTTP/1.1
Authorization: Bearer your_token
```

## Success Response (200 OK)

```json
{
  "cpf": "12345678909",
  "email": "cliente@example.com",
  "available_loan_amount": 1234.56,
  "available_loan_approved_at": "2026-04-20T14:30:00.000Z",
  "contracts": [
    {
      "contract_id": "9f195264-b1f5-415f-97ea-8e7a51e04238",
      "proposal_id": "99afc6ce-4720-4746-9cf6-0a23e85cdf75",
      "status": "ISSUED",
      "celcoin_application_id": "CCB123456",
      "principal_amount": 25153.66,
      "total_amount": 41903.28,
      "installment_amount": 2327.96,
      "installments": 18,
      "interest_rate": 4.99,
      "disbursement_amount": 25153.66,
      "disbursement_date": "2026-04-21T00:00:00.000Z",
      "disbursement_paid_at": "2026-04-21T13:45:00.000Z",
      "first_due_date": "2026-05-21T00:00:00.000Z",
      "final_due_date": "2027-10-21T00:00:00.000Z",
      "issue_date": "2026-04-20T18:30:00.000Z",
      "created_at": "2026-04-20T18:25:00.000Z"
    }
  ]
}
```

### Response Fields

| Field                        | Type                      | Description                                                                                         |
| ---------------------------- | ------------------------- | --------------------------------------------------------------------------------------------------- |
| `cpf`                        | string                    | Queried CPF                                                                                         |
| `email`                      | string \| null            | Customer email, obtained from the most recent proposal. `null` when unavailable.                    |
| `available_loan_amount`      | number \| null            | Available amount for a new loan. `null` when the CPF does not have an approved credit analysis.     |
| `available_loan_approved_at` | string (ISO 8601) \| null | Date/time of the analysis considered in the calculation. `null` when there is no approved analysis. |
| `contracts`                  | array                     | List of the customer's contracts in the authenticated channel                                       |

For the complete structure of each contract's fields, see [GET /customers/{cpf}/contracts](/api-reference/apis-en/api-reference-client/get-customers-contracts.md).

## Possible Errors

| Code | Message                                |
| ---- | -------------------------------------- |
| 400  | Invalid CPF. Enter only the 11 digits. |

## Notes

* The response aggregates data from [GET /customers/{cpf}/available-loan-amount](/api-reference/apis-en/api-reference-client/get-customers-available-loan-amount.md) and [GET /customers/{cpf}/contracts](/api-reference/apis-en/api-reference-client/get-customers-contracts.md) in a single call
* When the CPF has no contracts in the authenticated channel, `contracts` is returned as an empty array
* When the CPF does not have an approved credit analysis, `available_loan_amount` and `available_loan_approved_at` are returned as `null`

{% hint style="success" %}
**When to use this route**

Use the summary when you need to display an overall view of the customer on a single screen. For flows that need only the available amount or only the contracts, prefer the dedicated routes.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.bullcredtech.com/api-reference/apis-en/api-reference-client/get-customers-summary.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.