Search PIX keys

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/dict/keys/search \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://spi.sandbox.lerian.net/api/v1/dict/keys/search"

	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))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/keys/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "createdAt": "2025-03-07T14:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "keyType": "CPF",
      "keyValue": "12345678901",
      "ownerName": "João Silva",
      "ownerTaxId": "12345678901",
      "participantISPB": "12345678",
      "status": "ACTIVE",
      "updatedAt": "2025-03-07T14:30:00Z",
      "accountNumber": "9988776",
      "accountType": "CACC",
      "bacen": {
        "correlationId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
        "lastModified": "2026-06-14T12:00:00Z",
        "responseTime": "2026-06-14T12:00:00Z"
      },
      "branch": "0001",
      "creationDate": "2020-01-15T00:00:00Z",
      "keyOwnershipDate": "2020-01-15T00:00:00Z",
      "openingDate": "2020-01-15T00:00:00Z",
      "ownerTradeName": "Silva ME",
      "ownerType": "NATURAL_PERSON",
      "requestId": "b2696bf1-0a51-48b0-ab4a-8af2dff440af"
    }
  ],
  "limit": 123,
  "offset": 123,
  "requestId": "<string>"
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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

api

dict

keys

Search PIX keys

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/dict/keys/search \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://spi.sandbox.lerian.net/api/v1/dict/keys/search"

	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))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/keys/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "createdAt": "2025-03-07T14:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "keyType": "CPF",
      "keyValue": "12345678901",
      "ownerName": "João Silva",
      "ownerTaxId": "12345678901",
      "participantISPB": "12345678",
      "status": "ACTIVE",
      "updatedAt": "2025-03-07T14:30:00Z",
      "accountNumber": "9988776",
      "accountType": "CACC",
      "bacen": {
        "correlationId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
        "lastModified": "2026-06-14T12:00:00Z",
        "responseTime": "2026-06-14T12:00:00Z"
      },
      "branch": "0001",
      "creationDate": "2020-01-15T00:00:00Z",
      "keyOwnershipDate": "2020-01-15T00:00:00Z",
      "openingDate": "2020-01-15T00:00:00Z",
      "ownerTradeName": "Silva ME",
      "ownerType": "NATURAL_PERSON",
      "requestId": "b2696bf1-0a51-48b0-ab4a-8af2dff440af"
    }
  ],
  "limit": 123,
  "offset": 123,
  "requestId": "<string>"
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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.

Query Parameters

limit

integer<int64>

default:25

Page size (default 25, max 100)

Required range: 1 <= x <= 100

offset

integer<int64>

default:0

Page offset (default 0)

Required range: x >= 0

keyType

enum<string>

Filter by PIX key type

Available options:

CPF,

CNPJ,

PHONE,

EMAIL,

EVP

status

enum<string>

Filter by key status. BLOCKED is a judicial block ordered by the BCB (DICT 8.4 §1.1): the key stays on the book but is neither resolvable nor mutable.

Available options:

ACTIVE,

INACTIVE,

PENDING_CLAIM,

PENDING_BACEN_SYNC,

BLOCKED

participantISPB

string

Filter by participant ISPB (8-digit institution code)

Response

items

object[]

required

PIX keys for the requested limit/offset window.

Show child attributes

limit

integer<int64>

required

Effective page size applied to this response.

offset

integer<int64>

required

Zero-based offset of the first item in this page.

requestId

string

Request-scoped identifier echoing X-Request-ID, for pivoting from response to trace. This is OUR OWN echo, distinct from any item's bacen.correlationId, which is BACEN's own value.