Pular para o conteúdo principal

Consulta de Dados de Chave Pix no Banco Central

Request

ENDPOINT
/pix_key/PIX_KEY
MÉTODO
GET

Request Path Params

CampoTipoDescriçãoCaracteres
pix_key *stringChave 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

CampoTipoDescriçãoCaracteres
account_key *uuidv4Chave única do alias.36
document_numberintCPF/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"
}
CampoTipoDescriçãoMax. Caracteres
account_branchstringAgência da conta vinculada a Chave Pix, sem o dígito verificador.4
account_created_atstringData de abertura da conta vinculada a Chave Pix, informada pela instituição custodiante da conta.21
account_digitstringDígito verificador da conta vinculada a Chave Pix.1
account_numberstringNúmero de conta vinculada a Chave Pix sem o dígito verificador.20
account_typeenumDefinição do tipo de conta da Chave Pix.Enumeradores Account Type
bank_codestringCódigo do banco registrador da Chave Pix. Pode ser retornado como nulo, para instituições que não possuem código de banco3
end_to_end_idstringIndentificador ú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_institutionstringNome da instituição financeira registradora da Chave Pix.200
is_pix_key_ownerbooleanSerá 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.-
ispbstringISPB do Participate detentor da Chave Pix.8
owner_masked_document_numberstringNúmero de CPF ou CNPJ do titular da Chave Pix.14
owner_namestringNome do titular da Chave Pix.120
owner_person_typeenumNatureza jurídica do titular da Chave Pix.Enumeradores Owner Person Type
owner_trading_namestringNome fantasia do titular da Chave Pix (somente para owner_person_type=legal).100
pix_keystringChave Pix.-

Enumeradores account_type

EnumeradorDescrição
paymentConta de pagamento
checkingConta de corrente
savingsConta poupança
savingConta poupança
salaryConta salário
saving_accountConta poupança
payment_accountConta de pagamento
checking_accountConta de corrente
salary_accountConta salário
escrowConta Vinculada
info

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

Enumeradroes owner_person_type

EnumeradorDescrição
naturalstring
legalstring
STATUS
4XX
Response Body
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo"
}
Código HTTPCódigo QI
code
Título
title
Descrição (eng)
Description
Descrição (ptbr)
translation
404PIX000017Pix Key Not FoundPix key {pix_key} not found.A chave pix {pix_key} não foi encontrada.
403PIX000080Not enough permissionThe selected agent doesn't have permission to access this resource.O agente selecionado não tem permissão para acessar este recurso.
429PIX000081Rate Limit ExceededRate Limit ExceededLimite de requisições excedido
404PIX000082Alias not foundAlias {alias_key} not foundAlias {alias_key} não encontrado
404PIX000083Pix Key not foundPix Key {pix_key} not found for Alias {alias_key}Chave Pix {pix_key} não encontrada para o Alias {alias_key}
400PIX000084Only one query param allowedOnly one query param allowedSomente um parâmetro de consulta é permitido