List Pix key entries for an account
curl --request GET \
--url https://api.example.com/dict-hub/v1/entries \
--header 'Authorization: Bearer <token>' \
--header 'X-Account-Id: <x-account-id>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/dict-hub/v1/entries"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Account-Id", "<x-account-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {
method: 'GET',
headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.example.com/dict-hub/v1/entries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/dict-hub/v1/entries"
headers = {
"X-Account-Id": "<x-account-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"account": {
"branch": "0001",
"number": "0007654321",
"participant": "12345678",
"type": "CACC",
"openingDate": "2010-01-10T03:00:00Z"
},
"createdAt": "2019-11-18T03:00:00Z",
"holderId": "019606e5-7f80-9102-3d45-678901234ef0",
"id": "019606c3-5d6e-7f80-1b23-456789012cde",
"keyCreationDate": "2019-11-18T03:00:00Z",
"keyOwnershipDate": "2019-11-18T03:00:00Z",
"keyType": "CPF",
"keyValue": "52998224725",
"organizationId": "019606d4-6e7f-8091-2c34-567890123def",
"owner": {
"document": "52998224725",
"name": "João Silva",
"personType": "NATURAL",
"tradeName": "Silva ME"
},
"requestId": "a946d533-7f22-42a5-9a9b-e87cd55c0f4d",
"status": "ACTIVE",
"updatedAt": "2019-11-18T03:00:00Z",
"metadata": {}
}
],
"limit": 10,
"page": 1,
"total": 1
}{
"type": "https://errors.lerian.studio/v1/PIX-0001",
"title": "Bad Request",
"status": 400,
"detail": "Your request is missing one or more required header params.",
"code": "PIX-0001"
}{
"type": "https://errors.lerian.studio/v1/PIX-0105",
"title": "Not Found",
"status": 404,
"detail": "Key entry does not exist.",
"code": "PIX-0105"
}{
"type": "https://errors.lerian.studio/v1/PIX-0000",
"title": "Internal Server Error",
"status": 500,
"detail": "internal error",
"code": "PIX-0000"
}{
"type": "https://errors.lerian.studio/v1/PIX-0141",
"title": "Bad Gateway",
"status": 502,
"detail": "internal error",
"code": "PIX-0141"
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}List Pix key entries for an account
Returns a page-based list of Pix entries owned by the account in X-Account-Id. Account-scoped to prevent cross-account PII exposure; key_type and sort_order are case-insensitive.
GET
/
entries
List Pix key entries for an account
curl --request GET \
--url https://api.example.com/dict-hub/v1/entries \
--header 'Authorization: Bearer <token>' \
--header 'X-Account-Id: <x-account-id>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/dict-hub/v1/entries"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Account-Id", "<x-account-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {
method: 'GET',
headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.example.com/dict-hub/v1/entries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/dict-hub/v1/entries"
headers = {
"X-Account-Id": "<x-account-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"account": {
"branch": "0001",
"number": "0007654321",
"participant": "12345678",
"type": "CACC",
"openingDate": "2010-01-10T03:00:00Z"
},
"createdAt": "2019-11-18T03:00:00Z",
"holderId": "019606e5-7f80-9102-3d45-678901234ef0",
"id": "019606c3-5d6e-7f80-1b23-456789012cde",
"keyCreationDate": "2019-11-18T03:00:00Z",
"keyOwnershipDate": "2019-11-18T03:00:00Z",
"keyType": "CPF",
"keyValue": "52998224725",
"organizationId": "019606d4-6e7f-8091-2c34-567890123def",
"owner": {
"document": "52998224725",
"name": "João Silva",
"personType": "NATURAL",
"tradeName": "Silva ME"
},
"requestId": "a946d533-7f22-42a5-9a9b-e87cd55c0f4d",
"status": "ACTIVE",
"updatedAt": "2019-11-18T03:00:00Z",
"metadata": {}
}
],
"limit": 10,
"page": 1,
"total": 1
}{
"type": "https://errors.lerian.studio/v1/PIX-0001",
"title": "Bad Request",
"status": 400,
"detail": "Your request is missing one or more required header params.",
"code": "PIX-0001"
}{
"type": "https://errors.lerian.studio/v1/PIX-0105",
"title": "Not Found",
"status": 404,
"detail": "Key entry does not exist.",
"code": "PIX-0105"
}{
"type": "https://errors.lerian.studio/v1/PIX-0000",
"title": "Internal Server Error",
"status": 500,
"detail": "internal error",
"code": "PIX-0000"
}{
"type": "https://errors.lerian.studio/v1/PIX-0141",
"title": "Bad Gateway",
"status": 502,
"detail": "internal error",
"code": "PIX-0141"
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}Autorizaciones
JWT bearer token issued by the identity provider.
Encabezados
Account UUID. Listing is always scoped to this account.
Ejemplo:
"019606a1-3b4c-7d8e-9f01-234567890abc"
Parámetros de consulta
Filter by key type (case-insensitive)
Ejemplo:
"CPF"
Filter by key value
Ejemplo:
"52998224725"
Page number (1-based, default 1)
Ejemplo:
"1"
Rows per page (default 10, max 100)
Ejemplo:
"10"
Sort direction (default asc, case-insensitive)
Ejemplo:
"desc"
¿Esta página le ayudó?