← HomeFleetPay / Schema

ConferenciaChavePix

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.

ChavePixInformada ↗

documentostringRequired

Queried CPF or CNPJ, digits only.

chave_pixobjectRequired

ChavePixInformada ↗

vinculadabooleanRequired

Shortcut for situacao == "vinculada".

situacaostringRequired

vinculada — the key matches the one registered for this document. chave_de_outro_titular — the key exists in your records under ANOTHER contracted carrier. This requires action: it is the pattern associated with a swapped key. nao_cadastrada — no external Pix key with this value is registered for this document.

"vinculada" · "chave_de_outro_titular" · "nao_cadastrada"

titularobject | nullRequired

Populated only when situacao is vinculada. For chave_de_outro_titular, it is deliberately null so that verification cannot become a reverse key-to-person directory.

documento_possui_chavebooleanRequired

Whether this document has ANY external Pix key registered with you. Distinguishes "we have no key for this person" (false) from "we have one, but it is different" (true) — both return vinculada: false and require opposite actions.

mensagemstringRequired

Ready-to-display text written by FleetPay for your operator.

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "documento",
    "chave_pix",
    "vinculada",
    "situacao",
    "titular",
    "documento_possui_chave",
    "mensagem"
  ],
  "properties": {
    "documento": {
      "type": "string",
      "description": "CPF ou CNPJ consultado, somente dígitos."
    },
    "chave_pix": {
      "$ref": "#/components/schemas/ChavePixInformada"
    },
    "vinculada": {
      "type": "boolean",
      "description": "Atalho para `situacao == \"vinculada\"`."
    },
    "situacao": {
      "type": "string",
      "enum": [
        "vinculada",
        "chave_de_outro_titular",
        "nao_cadastrada"
      ],
      "description": "`vinculada` — a chave é a que consta no cadastro deste documento. `chave_de_outro_titular` — a chave existe na sua base, cadastrada para OUTRO agregado seu. **É o caso que pede ação:** é o padrão da troca de chave. `nao_cadastrada` — não há chave PIX externa com este valor para este documento."
    },
    "titular": {
      "type": [
        "object",
        "null"
      ],
      "description": "Só vem preenchido quando `situacao` é `vinculada`. Em `chave_de_outro_titular` vai `null` de propósito, para a conferência não virar um diretório reverso chave → pessoa.",
      "properties": {
        "tipo": {
          "type": "string",
          "enum": [
            "motorista"
          ]
        },
        "nome": {
          "type": [
            "string",
            "null"
          ]
        },
        "documento": {
          "type": "string"
        }
      }
    },
    "documento_possui_chave": {
      "type": "boolean",
      "description": "Este documento tem ALGUMA chave PIX externa cadastrada com você. É o que separa \"não temos chave desta pessoa\" (`false`) de \"temos, e é outra\" (`true`) — as duas respondem `vinculada: false` e pedem ações opostas."
    },
    "mensagem": {
      "type": "string",
      "description": "Frase pronta, redigida pela FleetPay, para você mostrar ao seu operador."
    }
  }
}