Consultar un conductor asociado por CPF/CNPJ

Parámetros, estructura de datos y respuestas del contrato versionado.

GET/agregados/{documento}

consultarAgregadoBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

El mismo contenido de la lista, para un único documento: útil cuando ya sabe a quién consulta y quiere verificar su estado antes de iniciar una operación.

Un documento que no pertenece a uno de sus transportistas agregados devuelve 404, no 403. Es deliberado: un 403 confirmaría que ese CPF/CNPJ existe en FleetPay y convertiría el endpoint en un buscador de registros ajenos. Aquí, un 404 significa "no es uno de sus transportistas agregados"; no implica necesariamente que la persona no exista.

Autenticación

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

La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

documentopath · stringObligatorio

CPF (11 dígitos) o CNPJ (14 dígitos). Acepta con o sin puntuación.

Restricciones

{
  "type": "string"
}

Respuestas

200 Respuesta HTTP

El colaborador

`application/json`

RespostaAgregado ↗

dataobjectObligatorio

Agregado ↗

ambienteobjectObligatorio

Ambiente ↗

400 Respuesta HTTP

Solicitud inválida

`application/json`

Erro ↗

errorobjectOpcional

401 Respuesta HTTP

Sin autenticación (autenticacao): credencial ausente, inválida o vencida, incluida una clave API utilizada en el entorno incorrecto. La clave de homologación no es válida en producción, ni la de producción en homologación; el mensaje de error indica el entorno esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Respuesta HTTP

Ámbito no habilitado para esta credencial

`application/json`

Erro ↗

errorobjectOpcional

404 Respuesta HTTP

Ningún colaborador con este documento está vinculado a tu empresa.

`application/json`

Erro ↗

errorobjectOpcional

429 Respuesta HTTP

Límite de solicitudes excedido (limite_requisicoes). Espera el intervalo indicado en el encabezado Retry-After antes de reintentar. Puede provenir del proveedor o del límite antiabuso de FleetPay, calculado por empresa autenticada y grupo de rutas, con una ventana corta para ráfagas y otra larga para tráfico automatizado lento. Los límites son amplios deliberadamente: las integraciones reales, incluidos lotes grandes procesados de una vez, deberían quedar muy por debajo. Si tu integración alcanza un límite, contacta con FleetPay.

`application/json`

Erro ↗

errorobjectOpcional

500 Respuesta HTTP

Error interno (erro_interno)

`application/json`

Erro ↗

errorobjectOpcional

Definición Completa de la Operación

{
  "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}"
}