Skip to main content
GET
/
v1
/
dict
/
keys
/
{key}
Retrieve a Key
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/keys/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'
{
  "key": "john.doe@example.com",
  "keyType": "EMAIL",
  "account": {
    "branch": "0001",
    "number": "123456789",
    "participant": "12345678",
    "type": "TRAN"
  },
  "owner": {
    "name": "John Doe",
    "taxIdNumber": "12345678901",
    "type": "NATURAL_PERSON"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Account-Id
string
required

Unique identifier of the Midaz Ledger Account (UUID format).

​
X-EndToEnd-Id
string

Optional SPI end-to-end identifier used for payment proposals.

Path Parameters

​
key
string
required

Pix key value (CPF, CNPJ, Email, Phone, or EVP).

Response

Pix key details retrieved successfully.

​
key
string

Pix key value.

Example:

"john.doe@example.com"

​
keyType
string

Type of Pix key.

Example:

"EMAIL"

​
account
object
​
owner
object