← HomeFleetPay / Schema

ChavePixInformada

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.

How we interpreted the key you submitted; check whether it was received as expected.

tipostringRequired
"cpf" · "cnpj" · "telefone" · "email" · "aleatoria"
valorstringRequired

Canonical key: CPF/CNPJ with digits only, phone as +55DDDNÚMERO, email and random key in lowercase.

Original JSON Definition (Portuguese Descriptions)
{
  "type": "object",
  "required": [
    "tipo",
    "valor"
  ],
  "description": "Como interpretamos a chave que você mandou — confira aqui se ela chegou como você esperava.",
  "properties": {
    "tipo": {
      "type": "string",
      "enum": [
        "cpf",
        "cnpj",
        "telefone",
        "email",
        "aleatoria"
      ]
    },
    "valor": {
      "type": "string",
      "description": "A chave em forma canônica: CPF/CNPJ só com dígitos, telefone como `+55DDDNÚMERO`, e-mail e chave aleatória em caixa baixa."
    }
  }
}