Consulta de Dados de Chave Pix no Banco Central

Request

ENDPOINT

/pix_key/PIX_KEY

MÉTODO

GET

Request Path Params

Campo	Tipo	Descrição	Caracteres
pix_key *	string	Chave PIX que será consultada.	77

Tipos de Chave Pix

A “pix_key” pode ser um CPF, CNPJ, E-mail, Celular ou uma Chave Aleatória (UUID), seguindo as seguintes formatações:

CPF: Número inteiro com 11 dígitos.

CNPJ: Número inteiro com 14 dígitos.

E-mail: Texto contendo ao menos um “@”.

Celular: Texto contendo os seguintes valores: “+55” + “DDD do celular“ + “Número Inteiro do Celular com no mínimo 8 e no máximo 9 dígitos”. Ex: “+5511987654321“.

Chave Aleatória: UUID4.

Request Query Params

Campo	Tipo	Descrição	Caracteres
account_key *	uuidv4	Chave única do alias.	36
document_number	int	CPF/CNPJ do titular da Chave Pix. Ao passar este parâmetro o campo is_pix_key_owner será retornado com um valor booleano identificando se o CPF/CNPJ informado é igual ao do titular da Chave Pix.	14

Utilização de tokens de consulta

Para que o token de consulta de chave pix seja cobrado da pessoa titular da conta, é obrigatório que o account_key seja enviado. Caso não seja enviado o account_key, o token será cobrado do número de documento do parceiro.

Response

STATUS

200

Response Body: Chave Ativa

{
    "account_branch": "452",
    "account_created_at": "2021-10-22T20:30.459Z",
    "account_digit": "1",
    "account_number": "370158",
    "account_type": "checking_account",
    "bank_code": "237",
    "end_to_end_id": "E3240250220230404185631R0kjZnC6G",
    "financial_institution": "BCO BRADESCO S.A.",
    "is_pix_key_owner": false,
    "ispb": "60746948",
    "owner_masked_document_number": "***.141.857-**",
    "owner_name": "Teste teste",
    "owner_person_type": "legal",
    "owner_trading_name": "Teste LTDA.",
    "pix_key": "teste@gmail.com"
}

Campo	Tipo	Descrição	Max. Caracteres
account_branch	string	Agência da conta vinculada a Chave Pix, sem o dígito verificador.	4
account_created_at	string	Data de abertura da conta vinculada a Chave Pix, informada pela instituição custodiante da conta.	21
account_digit	string	Dígito verificador da conta vinculada a Chave Pix.	1
account_number	string	Número de conta vinculada a Chave Pix sem o dígito verificador.	20
account_type	enum	Definição do tipo de conta da Chave Pix.	Enumeradores Account Type
bank_code	string	Código do banco registrador da Chave Pix. Pode ser retornado como nulo, para instituições que não possuem código de banco	3
end_to_end_id	string	Indentificador único da consulta da chave Pix no Bacen. Deve ser enviado na transferência Pix para que o token consumido na consulta seja recuperado.	32
financial_institution	string	Nome da instituição financeira registradora da Chave Pix.	200
is_pix_key_owner	boolean	Será retornado um valor boleano, caso o parâmetro document_number seja passado na request. Este campo informa se o CPF/CNPJ informado no parâmetro document_number é o mesmo do titular da Chave Pix. Será retornado um valor nulo caso o parâmetro document_number não seja informado.	-
ispb	string	ISPB do Participate detentor da Chave Pix.	8
owner_masked_document_number	string	Número de CPF ou CNPJ do titular da Chave Pix.	14
owner_name	string	Nome do titular da Chave Pix.	120
owner_person_type	enum	Natureza jurídica do titular da Chave Pix.	Enumeradores Owner Person Type
owner_trading_name	string	Nome fantasia do titular da Chave Pix (somente para owner_person_type=legal).	100
pix_key	string	Chave Pix.	-

Enumeradores account_type

Enumerador	Descrição
payment	Conta de pagamento
checking	Conta de corrente
savings	Conta poupança
saving	Conta poupança
salary	Conta salário
saving_account	Conta poupança
payment_account	Conta de pagamento
checking_account	Conta de corrente
salary_account	Conta salário
escrow	Conta Vinculada

info

Diferentes enumeradores podem significar o mesmo tipo de conta devido a informação retornada por diferentes instituições.

Enumeradroes owner_person_type

Enumerador	Descrição
natural	string
legal	string

STATUS

4XX

Response Body

{
    "title": "titulo",
    "description": "description in English",
    "translation": "descrição em portugues",
    "code": "codigo"
}

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (ptbr) translation
404	PIX000017	Pix Key Not Found	Pix key {pix_key} not found.	A chave pix {pix_key} não foi encontrada.
403	PIX000080	Not enough permission	The selected agent doesn't have permission to access this resource.	O agente selecionado não tem permissão para acessar este recurso.
429	PIX000081	Rate Limit Exceeded	Rate Limit Exceeded	Limite de requisições excedido
404	PIX000082	Alias not found	Alias {alias_key} not found	Alias {alias_key} não encontrado
404	PIX000083	Pix Key not found	Pix Key {pix_key} not found for Alias {alias_key}	Chave Pix {pix_key} não encontrada para o Alias {alias_key}
400	PIX000084	Only one query param allowed	Only one query param allowed	Somente um parâmetro de consulta é permitido