Consultar chaves Pix

Request

ENDPOINT

/pix_key/PIX_KEY?authenticated_user_key=CPF/CNPJ

METHOD

GET

Request Path Params

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

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 String Params

Campo	Tipo	Descrição
authenticated_user_key *	string	Documento do titular da conta

Response

STATUS

200

Response Body: Chave Ativa

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

Campo	Tipo	Descrição	Max. Caracteres
account_branch *	string	Agência, sem o dígito verificador.	4
account_digit *	string	Dígito verificador da conta.	1
account_number *	string	Número de conta, sem o dígito verificador.	20
account_type *	string	Definição do tipo de conta.	20
owner_person_type *	string	Tipo de dono da conta. Pode ser "legal" ou "natural"	7
owner_masked_document_number*	string	Numero de CPF ou CNPJ.	14
owner_name *	string	Nome do dono da conta.	120
owner_trading_name	string	Nome fantasia do dono da conta (somente para CNPJ).	100
ispb *	string	ISPB do Participate detentor da chave.	8
financial_institution *	string	Nome da instituição financeira detentora da chave.	200
created_at *	datetime Zulu	Data de criação da requisição.	20

STATUS

404

Response Body: Chave Inativa

{
  "title": "Pix Key Not Found",
  "description": "Pix key edd5d727-ddd6-4bbb-8463-2ff1bdb28c89 not found.", 
  "translation": "A chave pix edd5d727-ddd6-4bbb-8463-2ff1bdb28c89 não foi encontrada.",
  "code": "PIX000017"
}

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
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