Registrar chave PIX

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/dict/keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountNumber": "9988776",
  "accountType": "CACC",
  "keyType": "CPF",
  "keyValue": "12345678901",
  "openingDate": "2020-01-15T00:00:00Z",
  "ownerName": "João Silva",
  "ownerTaxId": "12345678901",
  "participantISPB": "12345678",
  "branch": "0001",
  "ownerTradeName": "Silva ME"
}
'

import requests

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

payload = {
    "accountNumber": "9988776",
    "accountType": "CACC",
    "keyType": "CPF",
    "keyValue": "12345678901",
    "openingDate": "2020-01-15T00:00:00Z",
    "ownerName": "João Silva",
    "ownerTaxId": "12345678901",
    "participantISPB": "12345678",
    "branch": "0001",
    "ownerTradeName": "Silva ME"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountNumber: '9988776',
    accountType: 'CACC',
    keyType: 'CPF',
    keyValue: '12345678901',
    openingDate: '2020-01-15T00:00:00Z',
    ownerName: 'João Silva',
    ownerTaxId: '12345678901',
    participantISPB: '12345678',
    branch: '0001',
    ownerTradeName: 'Silva ME'
  })
};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/keys', 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://spi.sandbox.lerian.net/api/v1/dict/keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accountNumber' => '9988776',
    'accountType' => 'CACC',
    'keyType' => 'CPF',
    'keyValue' => '12345678901',
    'openingDate' => '2020-01-15T00:00:00Z',
    'ownerName' => 'João Silva',
    'ownerTaxId' => '12345678901',
    'participantISPB' => '12345678',
    'branch' => '0001',
    'ownerTradeName' => 'Silva ME'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"accountNumber\": \"9988776\",\n  \"accountType\": \"CACC\",\n  \"keyType\": \"CPF\",\n  \"keyValue\": \"12345678901\",\n  \"openingDate\": \"2020-01-15T00:00:00Z\",\n  \"ownerName\": \"João Silva\",\n  \"ownerTaxId\": \"12345678901\",\n  \"participantISPB\": \"12345678\",\n  \"branch\": \"0001\",\n  \"ownerTradeName\": \"Silva ME\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://spi.sandbox.lerian.net/api/v1/dict/keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountNumber\": \"9988776\",\n  \"accountType\": \"CACC\",\n  \"keyType\": \"CPF\",\n  \"keyValue\": \"12345678901\",\n  \"openingDate\": \"2020-01-15T00:00:00Z\",\n  \"ownerName\": \"João Silva\",\n  \"ownerTaxId\": \"12345678901\",\n  \"participantISPB\": \"12345678\",\n  \"branch\": \"0001\",\n  \"ownerTradeName\": \"Silva ME\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/dict/keys")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accountNumber\": \"9988776\",\n  \"accountType\": \"CACC\",\n  \"keyType\": \"CPF\",\n  \"keyValue\": \"12345678901\",\n  \"openingDate\": \"2020-01-15T00:00:00Z\",\n  \"ownerName\": \"João Silva\",\n  \"ownerTaxId\": \"12345678901\",\n  \"participantISPB\": \"12345678\",\n  \"branch\": \"0001\",\n  \"ownerTradeName\": \"Silva ME\"\n}"

response = http.request(request)
puts response.read_body

{
  "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",
  "branch": "0001",
  "openingDate": "2020-01-15T00:00:00Z",
  "ownerTradeName": "Silva ME"
}

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

POST

api

dict

keys

Registrar chave PIX

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/dict/keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountNumber": "9988776",
  "accountType": "CACC",
  "keyType": "CPF",
  "keyValue": "12345678901",
  "openingDate": "2020-01-15T00:00:00Z",
  "ownerName": "João Silva",
  "ownerTaxId": "12345678901",
  "participantISPB": "12345678",
  "branch": "0001",
  "ownerTradeName": "Silva ME"
}
'

import requests

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

payload = {
    "accountNumber": "9988776",
    "accountType": "CACC",
    "keyType": "CPF",
    "keyValue": "12345678901",
    "openingDate": "2020-01-15T00:00:00Z",
    "ownerName": "João Silva",
    "ownerTaxId": "12345678901",
    "participantISPB": "12345678",
    "branch": "0001",
    "ownerTradeName": "Silva ME"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountNumber: '9988776',
    accountType: 'CACC',
    keyType: 'CPF',
    keyValue: '12345678901',
    openingDate: '2020-01-15T00:00:00Z',
    ownerName: 'João Silva',
    ownerTaxId: '12345678901',
    participantISPB: '12345678',
    branch: '0001',
    ownerTradeName: 'Silva ME'
  })
};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/keys', 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://spi.sandbox.lerian.net/api/v1/dict/keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accountNumber' => '9988776',
    'accountType' => 'CACC',
    'keyType' => 'CPF',
    'keyValue' => '12345678901',
    'openingDate' => '2020-01-15T00:00:00Z',
    'ownerName' => 'João Silva',
    'ownerTaxId' => '12345678901',
    'participantISPB' => '12345678',
    'branch' => '0001',
    'ownerTradeName' => 'Silva ME'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"accountNumber\": \"9988776\",\n  \"accountType\": \"CACC\",\n  \"keyType\": \"CPF\",\n  \"keyValue\": \"12345678901\",\n  \"openingDate\": \"2020-01-15T00:00:00Z\",\n  \"ownerName\": \"João Silva\",\n  \"ownerTaxId\": \"12345678901\",\n  \"participantISPB\": \"12345678\",\n  \"branch\": \"0001\",\n  \"ownerTradeName\": \"Silva ME\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://spi.sandbox.lerian.net/api/v1/dict/keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountNumber\": \"9988776\",\n  \"accountType\": \"CACC\",\n  \"keyType\": \"CPF\",\n  \"keyValue\": \"12345678901\",\n  \"openingDate\": \"2020-01-15T00:00:00Z\",\n  \"ownerName\": \"João Silva\",\n  \"ownerTaxId\": \"12345678901\",\n  \"participantISPB\": \"12345678\",\n  \"branch\": \"0001\",\n  \"ownerTradeName\": \"Silva ME\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/dict/keys")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accountNumber\": \"9988776\",\n  \"accountType\": \"CACC\",\n  \"keyType\": \"CPF\",\n  \"keyValue\": \"12345678901\",\n  \"openingDate\": \"2020-01-15T00:00:00Z\",\n  \"ownerName\": \"João Silva\",\n  \"ownerTaxId\": \"12345678901\",\n  \"participantISPB\": \"12345678\",\n  \"branch\": \"0001\",\n  \"ownerTradeName\": \"Silva ME\"\n}"

response = http.request(request)
puts response.read_body

{
  "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",
  "branch": "0001",
  "openingDate": "2020-01-15T00:00:00Z",
  "ownerTradeName": "Silva ME"
}

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

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

Idempotency-Key

string

Idempotency key, max 255 characters

Corpo

application/json

PIX key to register (key type, value, owner identity, and participant ISPB); registration fails closed if BACEN DICT rejects or is unavailable

accountNumber

string

obrigatório

Account number (1..20 digits).

Exemplo:

"9988776"

accountType

enum<string>

obrigatório

BACEN account type: CACC (current), TRAN (transactional), SLRY (salary), or SVGS (savings).

Opções disponíveis:

CACC,

TRAN,

SLRY,

SVGS

Exemplo:

"CACC"

keyType

string

obrigatório

PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP (random key).

Exemplo:

"CPF"

keyValue

string

obrigatório

PIX key value, formatted according to keyType (e.g. 11 digits for CPF, E.164 for PHONE, an email address for EMAIL).

Exemplo:

"12345678901"

openingDate

string

obrigatório

Account opening date, RFC 3339 (the FI account's opening date, not the key's creation moment).

Exemplo:

"2020-01-15T00:00:00Z"

ownerName

string

obrigatório

Full legal name of the key owner.

Exemplo:

"João Silva"

ownerTaxId

string

obrigatório

Owner tax identifier (CPF for individuals, CNPJ for businesses), digits only.

Exemplo:

"12345678901"

participantISPB

string

obrigatório

Owning participant ISPB, the 8-digit BACEN institution identifier.

Exemplo:

"12345678"

branch

string

Account branch (1..4 digits), optional.

Exemplo:

"0001"

ownerTradeName

string

Owner trade name (legal-entity / CNPJ owners), optional.

Exemplo:

"Silva ME"

Resposta

Created

Registered PIX key with its assigned status

createdAt

string

obrigatório

Key creation timestamp, RFC 3339 (UTC).

Exemplo:

"2025-03-07T14:30:00Z"

string

obrigatório

Unique PIX key identifier (UUID) assigned by the service.

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

keyType

string

obrigatório

PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP (random key).

Exemplo:

"CPF"

keyValue

string

obrigatório

PIX key value in its canonical format for the key type.

Exemplo:

"12345678901"

ownerName

string

obrigatório

Full legal name of the key owner.

Exemplo:

"João Silva"

ownerTaxId

string

obrigatório

Owner tax identifier (CPF or CNPJ), digits only.

Exemplo:

"12345678901"

participantISPB

string

obrigatório

Owning participant ISPB, the 8-digit BACEN institution identifier.

Exemplo:

"12345678"

status

string

obrigatório

Key lifecycle status: ACTIVE, INACTIVE, PENDING_CLAIM, or PENDING_BACEN_SYNC.

Exemplo:

"ACTIVE"

updatedAt

string

obrigatório

Timestamp of the last update to the key, RFC 3339 (UTC).

Exemplo:

"2025-03-07T14:30:00Z"

accountNumber

string

Account number (1..20 digits), omitted for a tuple-less key.

Exemplo:

"9988776"

accountType

enum<string>

BACEN account type (CACC, TRAN, SLRY, SVGS), omitted for a tuple-less key.

Opções disponíveis:

CACC,

TRAN,

SLRY,

SVGS

Exemplo:

"CACC"

branch

string

Account branch (1..4 digits), omitted when unset.

Exemplo:

"0001"

openingDate

string<date-time>

Account opening date, RFC 3339, omitted for a tuple-less key.

Exemplo:

"2020-01-15T00:00:00Z"

ownerTradeName

string

Owner trade name (legal-entity owners), omitted when unset.

Exemplo:

"Silva ME"

Pix — Lerian SPI (mensageria nativa)

Pix — JD (interface, direto)

Pix — BTG (interface, indireto)

TED — Lerian SPB (mensageria nativa)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (mensageria nativa)

Lerian SLC (mensageria nativa)

Lerian STA (mensageria nativa)

Lerian SISBAJUD (mensageria nativa)

Lerian Consignado — Dataprev

Registrar chave PIX

Autorizações

Cabeçalhos

Corpo

Resposta