Pular para o conteúdo principal
GET
/
v1
/
dict
/
keys
/
{key}
Recuperar uma Chave
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"
  }
}

Autorizações

​
Authorization
string
header
obrigatório

Header de autenticação Bearer no formato Bearer <token>, onde <token> é o seu token de acesso JWT.

Cabeçalhos

​
X-Account-Id
string
obrigatório

Identificador único da Conta do Ledger Midaz (formato UUID).

​
X-EndToEnd-Id
string

Identificador end-to-end SPI opcional utilizado para propostas de pagamento.

Parâmetros de caminho

​
key
string
obrigatório

Valor da chave PIX (CPF, CNPJ, Email, Phone ou EVP).

Resposta

Detalhes da chave PIX recuperados com sucesso.

​
key
string

Valor da chave PIX.

Exemplo:

"john.doe@example.com"

​
keyType
string

Tipo de chave PIX.

Exemplo:

"EMAIL"

​
account
object
​
owner
object