Get a Pix key by ID
GET {{baseInfraUrl}}/{{version}}/pix-key/:keyId
Get a specific Pix Key by it's id. This method can access any Pix Key, not only ones linked to your bank code.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | null | List of strings to filter response JSON keys. | |
payerId | null | (Required). Payer id (CPF/CNPJ) of the individual or business requesting the Pix Key information. This id is used by the Central Bank to limit request rates. Example: "20.018.183/0001-80" | |
endToEndId | null | Central Bank's unique transaction id. If the request results in the creation of a Pix Request, the same end to end id should be used. If this parameter is not passed, one endToEndId will be automatically created. Example: "E00002649202201172211u34srod19le" |
RESPONSES
status: OK
{"key":{"accountCreated":"2022-02-02T02:59:59.999999+00:00","accountNumber":"0000","accountType":"savings","bankCode":"35547753","bankName":"","branchCode":"0000","created":"2022-05-17T19:19:46.274234+00:00","id":"exemplopostman@hotmail.com","name":"Jamie Lannister","owned":"2022-05-17T19:19:46.274234+00:00","ownerType":"individual","status":"registered","tags":[],"taxId":"012.345.678-90","type":"email"}}