Skip to main content
POST
/
api
/
v1
/
core
/
participants
/
{ispb}
/
activate
Activate participant
curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/core/participants/{ispb}/activate \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://spi.sandbox.lerian.net/api/v1/core/participants/{ispb}/activate"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spi.sandbox.lerian.net/api/v1/core/participants/{ispb}/activate', 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/core/participants/{ispb}/activate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://spi.sandbox.lerian.net/api/v1/core/participants/{ispb}/activate"

req, _ := http.NewRequest("POST", 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))

}
HttpResponse<String> response = Unirest.post("https://spi.sandbox.lerian.net/api/v1/core/participants/{ispb}/activate")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/core/participants/{ispb}/activate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "createdAt": "<string>",
  "id": "<string>",
  "ispb": "<string>",
  "name": "<string>",
  "status": "<string>",
  "type": "<string>",
  "updatedAt": "<string>",
  "config": {
    "quotaDailyLimit": 123,
    "quotaTransactionLimit": 123,
    "routingPolicy": "<string>"
  },
  "sponsorISPB": "<string>"
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key
string

Idempotency key, max 255 characters

Path Parameters

ispb
string
required

ISPB (8 numeric digits)

Example:

"12345678"

Response

OK

createdAt
string
required

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

Example:

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

id
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.

sponsorISPB
string

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

Example:

""