> For the complete documentation index, see [llms.txt](https://docs.geeknums.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.geeknums.io/api-de-consulta-de-saldo-1.md).

# API de Consulta de Saldo

A API de Consulta de Saldo é usada para consultar em tempo real o saldo atual da sua conta CheckNumber e a cota disponível de detecção.

## Endpoint da API

`GET https://api.checknumber.ai/v1/balance`

## Método de Requisição

### Headers de Requisição

| Parâmetro   | Obrigatório | Descrição                                                              |
| ----------- | ----------- | ---------------------------------------------------------------------- |
| `X-API-Key` | Sim         | Sua chave de API (o header alternativo `X-Access-Key` também é aceito) |

## Exemplos de Resposta

### Resposta com Sucesso

```json
{  "balance": 9850.50}
```

### Descrição dos Campos

| Campo     | Tipo   | Descrição                  |
| --------- | ------ | -------------------------- |
| `balance` | number | Saldo atual da conta (USD) |

### Resposta Não Autorizada

```json
{  "error": "unauthorized",  "message": "Uma chave de acesso é obrigatória (X-API-Key ou X-Access-Key)"}
```

## Códigos de Status

| Código | Descrição                                                 |
| ------ | --------------------------------------------------------- |
| `200`  | Requisição bem-sucedida                                   |
| `401`  | Não autorizado; a chave de API está ausente ou é inválida |
| `502`  | Falha na consulta de saldo; erro do serviço upstream      |


---

# 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.geeknums.io/api-de-consulta-de-saldo-1.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.