Skip to main content
GET
Retrieve a Key

Autorizaciones

Authorization
string
header
requerido

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

Encabezados

X-Account-Id
string
requerido

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 ruta

key
string
requerido

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

Respuesta

Pix key details retrieved successfully.

key
string

Pix key value.

Ejemplo:

"john.doe@example.com"

keyType
string

Type of Pix key.

Ejemplo:

"EMAIL"

account
object
owner
object