Saltar al contenido principal
GET
/
v1
/
entries
Listar claves
curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/entries \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/entries"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-direct.api.lerian.net/v1/entries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://plugin-pix-direct.api.lerian.net/v1/entries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://plugin-pix-direct.api.lerian.net/v1/entries"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://plugin-pix-direct.api.lerian.net/v1/entries")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/entries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "key": "+5511987654321",
    "status": 1,
    "statusDescription": "ACTIVE",
    "comment": "status 1 = ACTIVE - la clave telefónica está activa y operativa"
  },
  {
    "key": "user@example.com",
    "status": 1,
    "statusDescription": "ACTIVE",
    "comment": "status 1 = ACTIVE - la clave de correo electrónico está activa y operativa"
  },
  {
    "key": "12345678901",
    "status": 0,
    "statusDescription": "FINALIZED",
    "comment": "status 0 = FINALIZED - clave CPF pendiente de confirmación"
  }
]

Autorizaciones

Authorization
string
header
requerido

Autenticación con token JWT Bearer. Obtén el token desde el endpoint /v1/login/oauth/access_token usando credenciales de cliente (clientId y clientSecret).

Incluye el token en el encabezado Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

El token expira después de 3600 segundos (1 hora).

Parámetros de consulta

account_id
string<uuid>

Identificador de la cuenta.

Respuesta

Claves Pix recuperadas correctamente

key
string
requerido

Valor de la clave Pix.

Ejemplo:

"+5511987654321"

status
enum<integer>
requerido

Código de estado del registro de la clave Pix. Indica el estado actual de una clave Pix en su ciclo de vida.

Valores válidos:

  • -1 = CANCELLED (El registro de la clave fue cancelado)
  • 0 = FINALIZED (La clave está finalizada/pendiente de confirmación)
  • 1 = ACTIVE (La clave está activa y operativa)
  • 2 = WAITING_OWNERSHIP_CONFIRMATION (En espera de la confirmación de titularidad por parte del usuario)
  • 3 = CREATING (La clave se está creando en el sistema)
  • 4 = IM_CLAIMER_PENDING_CONFIRM_CLAIM_REQUEST (Soy reclamante, pendiente de confirmación del reclamo)
  • 5 = IM_CLAIMER_PENDING_OWNER_GIVEWAY (Soy reclamante, esperando que el titular actual libere la clave)
  • 6 = IM_OWNER_PENDING_GIVEAWAY_CONFIRM (Soy titular, pendiente de aprobar la transferencia de la clave)
  • 7 = IM_CLAIMER_AND_OWNER_GAVEAWAY_PENDING_MY_CONFIRM (Transferencia iniciada, a la espera de mi confirmación)
Opciones disponibles:
-1,
0,
1,
2,
3,
4,
5,
6,
7
Ejemplo:

1

statusDescription
string
requerido

Descripción legible del estado que corresponde al código numérico.

Ejemplo:

"REGISTERED"