Skip to main content
GET
/
v1
/
entries
List keys
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 - phone key is active and operational"
  },
  {
    "key": "user@example.com",
    "status": 1,
    "statusDescription": "ACTIVE",
    "comment": "status 1 = ACTIVE - email key is active and operational"
  },
  {
    "key": "12345678901",
    "status": 0,
    "statusDescription": "FINALIZED",
    "comment": "status 0 = FINALIZED - CPF key pending confirmation"
  }
]

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Query Parameters

​
account_id
string<uuid>

Account identifier.

Response

Pix keys retrieved successfully

​
key
string
required

Pix key value.

Example:

"+5511987654321"

​
status
enum<integer>
required

Pix key registration status code. Indicates the current state of a Pix key in its lifecycle.

Valid values:

  • -1 = CANCELLED (Key registration was cancelled)
  • 0 = FINALIZED (Key is finalized/pending confirmation)
  • 1 = ACTIVE (Key is active and operational)
  • 2 = WAITING_OWNERSHIP_CONFIRMATION (Awaiting ownership confirmation from the user)
  • 3 = CREATING (Key is being created in the system)
  • 4 = IM_CLAIMER_PENDING_CONFIRM_CLAIM_REQUEST (I am claimer, pending claim confirmation)
  • 5 = IM_CLAIMER_PENDING_OWNER_GIVEWAY (I am claimer, awaiting current owner to release the key)
  • 6 = IM_OWNER_PENDING_GIVEAWAY_CONFIRM (I am owner, pending approval to transfer key)
  • 7 = IM_CLAIMER_AND_OWNER_GAVEAWAY_PENDING_MY_CONFIRM (Transfer initiated, awaiting my confirmation)
Available options:
-1,
0,
1,
2,
3,
4,
5,
6,
7
Example:

1

​
statusDescription
string
required

Human-readable status description corresponding to the numeric status code.

Example:

"REGISTERED"