This document describes the expected response of an API call that returns information about a PIX key record. The sample data presented below is fictitious and serves to illustrate the structure and meaning of each field in the response.
{
"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"
}
}| Attribute | Description |
|---|---|
id (string) | Unique identifier of the key record. |
key_id (string) | Registered key identifier. |
taxpayer_id (string) | CPF or CNPJ of the key owner, without formatting. |
name (string) | Full name of the key owner. |
dict_type (string) | Type of key identification (e.g.: cpf, phone, evp). |
account_type (string) | Type of associated account (e.g.: checking, savings). |
status (string) | Key record status (e.g.: registered, pending). |
claim (boolean) | Indicates whether the key is being claimed. |
created_at (string) | Date and time when the key record was created in the format YYYY-MM-DD HH:MM. |