List Pix key entries for an account

cURL with fictitious data

curl --request GET \
  --url https://api.example.com/dict-hub/v1/entries \
  --header 'Authorization: Bearer demo-access-token' \
  --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc'

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",
        "openingDate": "2010-01-10T03:00:00Z",
        "participant": "12345678",
        "type": "CACC"
      },
      "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",
      "metadata": {
        "field": "field-example"
      },
      "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"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 1
}

{
  "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"
  }
}

GET

entries

cURL with fictitious data

curl --request GET \
  --url https://api.example.com/dict-hub/v1/entries \
  --header 'Authorization: Bearer demo-access-token' \
  --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc'

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",
        "openingDate": "2010-01-10T03:00:00Z",
        "participant": "12345678",
        "type": "CACC"
      },
      "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",
      "metadata": {
        "field": "field-example"
      },
      "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"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 1
}

{
  "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"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id

string

required

UUID of the account associated with the operation.

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Query Parameters

key_type

string

Filter by key type (case-insensitive)

Example:

"CPF"

key_value

string

Filter by key value

Example:

"52998224725"

page

string

Page number (1-based, default 1)

Example:

"1"

limit

string

Rows per page (default 10, max 100)

Example:

"10"

sort_order

string

Sort direction (default asc, case-insensitive)

Example:

"desc"

Response

items

object[] | null

required

Show child attributes

limit

integer<int64>

required

Example:

10

page

integer<int64>

required

Example:

1

total

integer<int64>

required

Example:

1

DICT and Pix keys

Collections and BR Codes

Payments and refunds

Error handling

List Pix key entries for an account

Authorizations

Headers

Query Parameters

Response