curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/core/participants/direct \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "contactEmail": "med@bancoexemplo.com.br",
  "contactPhone": "+5511999998888",
  "ispb": "12345678",
  "name": "Banco Exemplo S.A."
}
'

package main

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

func main() {

	url := "https://spi.sandbox.lerian.net/api/v1/core/participants/direct"

	payload := strings.NewReader("{\n  \"contactEmail\": \"med@bancoexemplo.com.br\",\n  \"contactPhone\": \"+5511999998888\",\n  \"ispb\": \"12345678\",\n  \"name\": \"Banco Exemplo S.A.\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contactEmail: 'med@bancoexemplo.com.br',
    contactPhone: '+5511999998888',
    ispb: '12345678',
    name: 'Banco Exemplo S.A.'
  })
};

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

import requests

url = "https://spi.sandbox.lerian.net/api/v1/core/participants/direct"

payload = {
    "contactEmail": "med@bancoexemplo.com.br",
    "contactPhone": "+5511999998888",
    "ispb": "12345678",
    "name": "Banco Exemplo S.A."
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "contactEmail": "med@bancoexemplo.com.br",
  "contactPhone": "+5511999998888",
  "createdAt": "2025-03-07T14:30:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "ispb": "12345678",
  "name": "Banco Exemplo S.A.",
  "status": "ACTIVE",
  "type": "DIRECT",
  "updatedAt": "2025-03-07T14:30:00Z",
  "config": {
    "quotaDailyLimit": 1000000,
    "quotaTransactionLimit": 50000,
    "routingPolicy": "DEFAULT"
  },
  "sponsorISPB": ""
}

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

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

Register the direct participant this rail operates as

Establishes the institution this rail IS at the SPI: the ACTIVE DIRECT participant that anchors the closed set of participants whose arriving Pix settle here (its own accounts, plus every indirect it is BACEN-confirmed liquidante for). Admin-only, and at most one may be ACTIVE. There is no reda flow for a direct participant — the SPI refuses a reda.014/reda.031 naming one (reda.016 error DIR1) — so nothing external confirms this act and it is not client-callable.

POST

api

core

participants

direct

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/core/participants/direct \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "contactEmail": "med@bancoexemplo.com.br",
  "contactPhone": "+5511999998888",
  "ispb": "12345678",
  "name": "Banco Exemplo S.A."
}
'

package main

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

func main() {

	url := "https://spi.sandbox.lerian.net/api/v1/core/participants/direct"

	payload := strings.NewReader("{\n  \"contactEmail\": \"med@bancoexemplo.com.br\",\n  \"contactPhone\": \"+5511999998888\",\n  \"ispb\": \"12345678\",\n  \"name\": \"Banco Exemplo S.A.\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contactEmail: 'med@bancoexemplo.com.br',
    contactPhone: '+5511999998888',
    ispb: '12345678',
    name: 'Banco Exemplo S.A.'
  })
};

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

import requests

url = "https://spi.sandbox.lerian.net/api/v1/core/participants/direct"

payload = {
    "contactEmail": "med@bancoexemplo.com.br",
    "contactPhone": "+5511999998888",
    "ispb": "12345678",
    "name": "Banco Exemplo S.A."
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "contactEmail": "med@bancoexemplo.com.br",
  "contactPhone": "+5511999998888",
  "createdAt": "2025-03-07T14:30:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "ispb": "12345678",
  "name": "Banco Exemplo S.A.",
  "status": "ACTIVE",
  "type": "DIRECT",
  "updatedAt": "2025-03-07T14:30:00Z",
  "config": {
    "quotaDailyLimit": 1000000,
    "quotaTransactionLimit": 50000,
    "routingPolicy": "DEFAULT"
  },
  "sponsorISPB": ""
}

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

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

Headers

X-Idempotency

string

required

Idempotency key, max 255 characters

Body

application/json

contactEmail

string

required

Lower-case e-mail BACEN uses to reach this participant about a funds-recovery case (DICT 2.12.1 Email pattern). The address must be lower-case: an upper-case one is refused, never rewritten. The service checks the format, not the published schema, so a refusal never echoes the submitted value back.

Example:

"med@bancoexemplo.com.br"

contactPhone

string

required

E.164 phone BACEN uses to reach this participant about a funds-recovery case (DICT 2.12.1 Phone pattern: +, then 2 to 15 digits). The service checks the format, not the published schema, so a refusal never echoes the submitted value back.

Example:

"+5511999998888"

ispb

string

required

ISPB of the institution this rail operates as, exactly 8 numeric digits.

Pattern: ^[0-9]{8}$

Example:

"12345678"

name

string

required

Legal name of the institution. The 256-character bound is Lerian's own — it is what participants.name stores — not a BACEN limit.

Required string length: 1 - 256

Example:

"Banco Exemplo S.A."

Response

Created

contactEmail

string

required

Registered regulator-facing e-mail; travels on every MED 2.0 funds recovery opened for this participant.

Example:

"med@bancoexemplo.com.br"

contactPhone

string

required

Registered regulator-facing phone; travels on every MED 2.0 funds recovery opened for this participant.

Example:

"+5511999998888"

createdAt

string

required

UTC timestamp when the participant was created, RFC 3339 format.

Example:

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

string

required

Server-assigned UUID of the participant.

Example:

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

ispb

string

required

ISPB of the participant, exactly 8 numeric digits.

Example:

"12345678"

name

string

required

Legal name of the participant institution.

Example:

"Banco Exemplo S.A."

status

string

required

Lifecycle state of the participant: ACTIVE, SUSPENDED, OFFBOARDED, PENDING (indirect reda.014 in flight), REGISTRATION_REJECTED (reda.016 REJT), or OFFBOARD_PENDING (reda.031 in flight).

Example:

"ACTIVE"

type

string

required

Connection type: DIRECT (connects directly to BACEN) or INDIRECT (routes through a sponsor).

Example:

"DIRECT"

updatedAt

string

required

UTC timestamp of the last update to the participant, RFC 3339 format.

Example:

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

config

object

Quota and routing configuration; present only for indirect participants.

Show child attributes

ISPB of the sponsoring participant (8 numeric digits); present only for INDIRECT participants.

Example:

""