Consultar um agregado pelo CPF/CNPJ

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/agregados/{documento}

consultarAgregadoBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

O mesmo conteúdo da listagem, para um documento só — para quando você já sabe de quem está falando e quer checar antes de disparar uma operação.

Documento que não é seu agregado responde 404, não 403. É deliberado: um 403 confirmaria que aquele CPF/CNPJ existe na FleetPay, e transformaria este endpoint num consultor de base alheia. Um 404 aqui significa "não é seu agregado" — não significa, necessariamente, que a pessoa não existe.

Autenticação

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

documentopath · stringObrigatório

CPF (11 dígitos) ou CNPJ (14 dígitos). Aceita com ou sem pontuação.

Restrições

{
  "type": "string"
}

Respostas

200 Resposta HTTP

O agregado

`application/json`

RespostaAgregado ↗

dataobjectObrigatório

Agregado ↗

ambienteobjectObrigatório

Ambiente ↗

400 Resposta HTTP

Requisição inválida

`application/json`

Erro ↗

errorobjectOpcional

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Resposta HTTP

Escopo não habilitado para esta credencial

`application/json`

Erro ↗

errorobjectOpcional

404 Resposta HTTP

Nenhum agregado com este documento está vinculado à sua empresa.

`application/json`

Erro ↗

errorobjectOpcional

429 Resposta HTTP

Limite de requisições excedido (limite_requisicoes). Aguarde o intervalo indicado no header Retry-After antes de repetir. Pode vir do provedor, repassado, ou do teto anti-abuso da própria FleetPay — contado por empresa autenticada e por grupo de rotas, com uma janela curta que pega a rajada e uma longa que pega o robô lento. Os tetos são folgados de propósito: integração real, inclusive lote grande processado de uma vez, não chega perto deles. Se a sua chegar, fale com a FleetPay.

`application/json`

Erro ↗

errorobjectOpcional

500 Resposta HTTP

Erro interno (erro_interno)

`application/json`

Erro ↗

errorobjectOpcional

Definição Completa da Operação

{
  "tags": [
    "Agregados"
  ],
  "summary": "Consultar um agregado pelo CPF/CNPJ",
  "operationId": "consultarAgregado",
  "description": "O mesmo conteúdo da listagem, para um documento só — para quando você já sabe de quem\nestá falando e quer checar antes de disparar uma operação.\n\n**Documento que não é seu agregado responde `404`, não `403`.** É deliberado: um `403`\nconfirmaria que aquele CPF/CNPJ existe na FleetPay, e transformaria este endpoint num\nconsultor de base alheia. Um `404` aqui significa \"não é seu agregado\" — não significa,\nnecessariamente, que a pessoa não existe.\n",
  "parameters": [
    {
      "name": "documento",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "CPF (11 dígitos) ou CNPJ (14 dígitos). Aceita com ou sem pontuação."
    }
  ],
  "responses": {
    "200": {
      "description": "O agregado",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RespostaAgregado"
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/Erro400"
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    },
    "404": {
      "description": "Nenhum agregado com este documento está vinculado à sua empresa.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "429": {
      "$ref": "#/components/responses/Erro429"
    },
    "500": {
      "$ref": "#/components/responses/Erro500"
    }
  },
  "method": "GET",
  "path": "/agregados/{documento}"
}