Este documento descreve o retorno esperado de uma chamada de API que retorna informações sobre um registro de chave PIX. Os dados de exemplo apresentados abaixo são fictícios e servem para ilustrar a estrutura e o significado de cada campo no retorno da resposta.
{
"data": {
"id": "169d01c4-cfe1-4169-a16c-f1248aa16a53",
"key_id": "84345446104",
"taxpayer_id": "84345446104",
"name": "Juliano dias",
"dict_type": "cpf",
"account_type": "checking",
"status": "registered",
"claim": false,
"created_at": "2024-11-04 10:53:52"
}
}
| Atributo | Descrição |
|---|---|
| id (string) | Identificador único do registro da chave. |
| key_id (string) | Identificação da chave registrada. |
| taxpayer_id (string) | CPF ou CNPJ do titular da chave, sem formatação. |
| name (string) | Nome completo do titular da chave. |
| dict_type (string) | Tipo de identificação da chave (ex.: ‘cpf’, ‘phone’, 'evp'). |
| account_type (string) | Tipo de conta associada (ex.: ‘checking’, ‘savings’). |
| status (string) | Status do registro da chave (ex.: ‘registered’, ‘pending’). |
| claim (boolean) | Indica se a chave está sendo reivindicada. |
| created_at (string) | Data e hora de criação do registro da chave no formato YYYY-MM-DD HH:MM. |