Pix Key Lookup

Request

ENDPOINT

/pix_key/PIX_KEY

METHOD

GET

Request Path Params

Field	Type	Description	Characters
pix_key *	string	PIX key to be queried.	77

Pix Key Types

The “pix_key” can be a CPF, CNPJ, Email, Phone, or a Random Key (UUID), following these formats: CPF: Integer with 11 digits.

CNPJ: Integer with 14 digits.

Email: Text containing at least one “@”.

Phone: Text containing the following values: “+55” + “Mobile DDD“ + “Complete Mobile Number with a minimum of 8 and a maximum of 9 digits”. E.g., “+5511987654321“.

Random Key: UUID4.

Request Query Params

Field	Type	Description	Characters
alias_key *	uuidv4	Unique alias key.	36

Usage of Query Tokens

To ensure the correct person is charged for the PIX key query token, it is mandatory to send the alias_key.

Response

STATUS

200

Response Body: Key active

{
  "account_branch": "0001",
  "account_created_at": "2023-09-06T22:03:34.000Z",
  "account_digit": "8",
  "account_number": "2897775",
  "account_type": "checking",
  "bank_code": null,
  "end_to_end_id": "E73856642202309201429bZKfklNlbwu",
  "financial_institution": "BANCO INDIRETO PRUPRU",
  "ispb": "32402502",
  "owner_masked_document_number": "**.458.****/0001-**",
  "owner_name": "Empresa teste 01",
  "owner_person_type": "legal",
  "owner_trading_name": null,
  "pix_key": "0f723f66-b333-4187-be16-97fc37c86052"
}

Field	Type	Description	Max. Characters
pix_key	string	PIX key of the query	4
account_branch	string	Branch, without the check digit	4
account_digit	string	Account check digit	1
account_number	string	Account number, without the check digit	20
account_type	string	Definition of account type	20
owner_person_type	string	Type of account owner. Can be "legal" or "natural"	7
owner_masked_document_number	string	CPF or CNPJ number	14
end_to_end_id	string	Unit key of the PIX transaction	32
owner_name	string	Account owner's name	120
owner_trading_name	string	Account owner's trade name (only for CNPJ)	100
ispb	string	ISPB of the Participant holding the key	8
bank_code	string	COMPE code of the financial institution	3
financial_institution	string	Name of the financial institution holding the key	100
account_created_at	string	Account creation date	20

STATUS

4XX

Response Body: Error

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

HTTP Code	QI Code code	Title title	Description (eng) Description	Description (ptbr) translation
400	PIX000086	Invalid Query Params Combination	Account_key and Alias_key are mutually exclusive query parameters. Choose one	Account_key e Alias_key são parâmetros mutualmente exclusivos. Escolha apenas um
403	PIX000080	Not enough permission	The selected agent is not an Pix Indirect Participant	O agente selecionado não é um Participante Indireto do Pix
404	PIX000082	Alias not found	Alias {alias_key} not found	Alias {alias_key} não encontrado
404	PIX000017	Pix Key is Unregistered	Pix key {pix_key} is not currently used	A chave pix {pix_key} não está sendo utilizada
400	PIX000081	Rate Limit Exceeded	Rate Limit Exceeded	Limite de requisições excedido