> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flunora.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Extrato da chave

> Devolve o consumo da chave e a lista do que ela consultou. Não gera cobrança.

O extrato é da chave, não da organização: uma chave de integração não enxerga o que a equipe consultou pela tela do app.


Consumo da chave e lista do que ela consultou. Serve para conferir gasto antes de bater no
teto e para reconciliar cobrança do seu lado.

<Card title="Não gera cobrança" horizontal>
  Lê só o histórico.
</Card>

O extrato é **da chave**, não da organização: uma chave de integração não enxerga o que a
equipe consultou pela tela do app, o que é deliberado.

O bloco `uso` conta apenas consultas cobradas. Consulta servida do histórico não entra na
conta, porque também não custou nada.

**Resposta:**

```json theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  "uso": { "hoje": 1, "mes": 1, "total": 1 },
  "consultas": [
    {
      "id": "cmtsr515m1uxzjn04ta469e3q",
      "produto": "search-pj",
      "documento": "11222333000181",
      "status": "SUCCESS",
      "cobrada": true,
      "duracaoMs": 609,
      "erro": null,
      "consultadoEm": "2026-09-08T14:15:35.194Z"
    }
  ]
}
```


## OpenAPI

````yaml openapi.yaml GET /api/v1/consultas
openapi: 3.1.0
info:
  title: API da Flunora
  description: >
    Superfície pública da Flunora. Duas capacidades: colocar contatos no funil a
    partir de qualquer sistema, e consultar CPF e CNPJ num bureau de dados
    brasileiro.


    A URL base é o endereço da **sua instância**, não um domínio compartilhado
    da plataforma. Troque `crm.suaempresa.com` pelo seu.
  version: 1.0.0
  contact:
    name: Suporte da Flunora
    email: contato@flunora.com.br
    url: https://docs.flunora.com
servers:
  - url: https://{instancia}
    description: A sua instância da Flunora.
    variables:
      instancia:
        default: crm.suaempresa.com
        description: O domínio da sua instância.
security:
  - chaveDeApi: []
tags:
  - name: Consultas
    description: Ficha cadastral de pessoa e de empresa. Cada consulta é cobrada.
  - name: Entrada de contatos
    description: Criar contato no funil a partir de um sistema externo.
paths:
  /api/v1/consultas:
    get:
      tags:
        - Consultas
      summary: Extrato da chave
      description: >
        Devolve o consumo da chave e a lista do que ela consultou. Não gera
        cobrança.


        O extrato é da chave, não da organização: uma chave de integração não
        enxerga o que a equipe consultou pela tela do app.
      operationId: extratoDaChave
      parameters:
        - name: limite
          in: query
          description: Quantas consultas trazer. O máximo é 100.
          schema:
            type: integer
            default: 30
            maximum: 100
        - name: produto
          in: query
          description: Filtra por id de produto.
          schema:
            type: string
        - name: documento
          in: query
          description: Filtra por documento. Pontuação é ignorada.
          schema:
            type: string
      responses:
        '200':
          description: Consumo e histórico da chave.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uso:
                    type: object
                    description: >
                      Consultas cobradas por janela. Consulta servida do
                      histórico não entra na conta, porque também não custou
                      nada.
                    properties:
                      hoje:
                        type: integer
                        example: 1
                      mes:
                        type: integer
                        example: 1
                      total:
                        type: integer
                        example: 1
                  consultas:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        produto:
                          type: string
                        documento:
                          type: string
                        status:
                          type: string
                          enum:
                            - SUCCESS
                            - NOT_FOUND
                            - FAILED
                        cobrada:
                          type: boolean
                        duracaoMs:
                          type:
                            - integer
                            - 'null'
                        erro:
                          type:
                            - string
                            - 'null'
                        consultadoEm:
                          type: string
                          format: date-time
        '401':
          $ref: '#/components/responses/NaoAutenticado'
components:
  responses:
    NaoAutenticado:
      description: Chave ausente, inválida, revogada, expirada ou desativada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
  schemas:
    Erro:
      type: object
      description: >
        O `codigo` é uma string estável nossa, não o número que o bureau
        devolveu. Trate por ele, para o seu `if` continuar valendo se o
        fornecedor mudar.
      properties:
        erro:
          type: object
          properties:
            codigo:
              type: string
              example: nao_encontrado
            mensagem:
              type: string
              example: Documento não localizado.
            detalhe:
              type: object
  securitySchemes:
    chaveDeApi:
      type: http
      scheme: bearer
      description: >
        Chave de API criada em Configurações, Integrações, Chaves de API. Começa
        com `sk_live_` e aparece uma vez só. O cabeçalho `X-API-Key` também é
        aceito, com o mesmo valor.

````