Skip to main content
GET
Retrieve a Key

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Account-Id
string
obrigatório

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

X-EndToEnd-Id
string

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

Parâmetros de caminho

key
string
obrigatório

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

Resposta

Pix key details retrieved successfully.

key
string

Pix key value.

Exemplo:

"john.doe@example.com"

keyType
string

Type of Pix key.

Exemplo:

"EMAIL"

account
object
owner
object