Consult PIX Key

Consult PIX key details.

Endpoint

POST /pix/key/info

Authentication

Merchant Credential. See Authentication.

Request headers

Name	In	Type	Required	Description	Example
Content-Type	header	string	Yes		application/json
X-Nonce	header	string	Yes		a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-Id	header	string	Yes		2492265300
X-Timestamp	header	string	Yes		1638123456
Digest	header	string	Yes		SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
Authorization	header	string	Yes		Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

Request body

Field	Type	Required	Description
key	string	Yes	pix-key

Request example

{
  "key": "14*******47"
}

Response

HTTP 200 — Success

Field	Type	Required	Description
status	integer	Yes
data	object	Yes

data fields

Field	Type	Required	Description
chave	string	Yes
tipoChave	integer	Yes
nomeCorrentista	string	Yes
nomeFantasia	string	Yes
tipoPessoa	integer	Yes
documentoFederal	string	Yes
conta	object	Yes
banco	object	Yes
detalhesConsulta	null	Yes
ticket	string	Yes
sucesso	boolean	Yes
mensagem	string	Yes
key	string	Yes
owner	object	Yes
account	object	Yes

Response example

{
  "status": 200,
  "data": {
    "chave": "14*******47",
    "tipoChave": 0,
    "nomeCorrentista": "Fulano de tal",
    "nomeFantasia": "",
    "tipoPessoa": 1,
    "documentoFederal": "***815687**",
    "conta": {
      "conta": "000001",
      "tipoConta": 1,
      "agencia": "0001",
      "ispb": "35535240"
    },
    "banco": {
      "descricao": "SAQ BANK",
      "numero": "",
      "ispb": "30306294"
    },
    "detalhesConsulta": null,
    "ticket": "",
    "sucesso": true,
    "mensagem": "",
    "key": "14*******47",
    "owner": {
      "name": "Fulano de tal",
      "taxIdNumber": "***815687**"
    },
    "account": {
      "bankName": "SAQ BANK"
    }
  }
}