← HomeFleetPay / Schema

ContaDoAgregado

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

The contractor's FleetPay digital account. If you read only one field, read habilitado_a_receber; the others explain why.

situacaostringRequired

The account's current stage. sem_conta — registration exists, but account opening has not started. criada / em_analise — FleetPay is handling the process. aprovada — the account exists and is operational. reprovada / encerrada — final outcomes. Treat this as an open list: a new value must not break your client.

"sem_conta" · "criada" · "em_analise" · "aprovada" · "reprovada" · "encerrada"

biometriastringRequired

The account holder's identity verification. This is the step most likely to hold up an account, and FleetPay handles it directly with the person — you cannot unblock it through the API.

"nao_iniciada" · "em_analise" · "aprovada" · "reprovada"

habilitado_a_receberbooleanRequired

The decisive field. true only when the account is approved AND not blocked. An approved but blocked account still exists and still cannot receive funds — checking situacao alone is therefore insufficient.

pendenciastring | nullOptional

What is missing, in a sentence you can display to your operator. null when nothing is pending. This is human-readable text: do not base an if condition on it — use situacao and biometria.

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "situacao",
    "biometria",
    "habilitado_a_receber"
  ],
  "description": "A conta digital FleetPay do agregado. Se você só for ler um campo, leia `habilitado_a_receber` — os outros existem para explicar o \"por quê\".",
  "properties": {
    "situacao": {
      "type": "string",
      "enum": [
        "sem_conta",
        "criada",
        "em_analise",
        "aprovada",
        "reprovada",
        "encerrada"
      ],
      "description": "Em que ponto está a conta. `sem_conta` — o cadastro existe mas a abertura da conta não começou. `criada` / `em_analise` — a FleetPay está conduzindo. `aprovada` — a conta existe e funciona. `reprovada` / `encerrada` — desfechos finais. Trate como lista aberta: um valor novo não deve quebrar o seu cliente."
    },
    "biometria": {
      "type": "string",
      "enum": [
        "nao_iniciada",
        "em_analise",
        "aprovada",
        "reprovada"
      ],
      "description": "A verificação de identidade do titular. É o passo que mais segura conta parada, e é conduzido pela FleetPay com a pessoa — você não consegue destravá-lo pela API."
    },
    "habilitado_a_receber": {
      "type": "boolean",
      "description": "**O campo que decide.** `true` só quando a conta está aprovada E não está bloqueada. Uma conta aprovada porém bloqueada continua existindo e continua não recebendo — por isso não basta olhar `situacao`."
    },
    "pendencia": {
      "type": [
        "string",
        "null"
      ],
      "description": "O que falta, em uma frase que você pode mostrar ao seu operador. `null` quando não há nada pendente. É texto para leitura humana: não faça `if` em cima dele — use `situacao` e `biometria`."
    }
  }
}