Test connectivity to Núclea for a participant

curl --request POST \
  --url https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity"

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

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

print(response.text)

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

fetch('https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity', 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://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity",
  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://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity"

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

}

require 'uri'
require 'net/http'

url = URI("https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity")

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

{
  "cdConnection": {
    "status": "<string>",
    "latencyMs": 123
  },
  "nucleaApi": {
    "status": "<string>",
    "latencyMs": 123
  },
  "participantId": "<string>",
  "rsfnConnection": {
    "status": "<string>",
    "latencyMs": 123
  },
  "certificateExpiresAt": "<string>",
  "certificateValid": true
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Test connectivity to Núclea for a participant

Sends a role-correct connectivity probe over the REST channel (AGEN001 for the DOMICILE_IF role, AGEN999 for other participant roles) and reports the round-trip echo and latency in the nucleaApi channel status. The path param is the participant’s 8-digit ISPB, NOT the participant UUID the sibling /v1/participants operations take. 404 when the ISPB is not a participant in the tenant’s catalog. RBAC: connectivity:test (admin). The cdConnection and rsfnConnection channels report NOT_CONFIGURED because the managed file-transfer and message-broker transports are not currently available. An open-breaker transport returns a retryable 503.

POST

participants

{participantIspb}

test-connectivity

Test connectivity to Núclea for a participant

curl --request POST \
  --url https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity"

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

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

print(response.text)

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

fetch('https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity', 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://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity",
  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://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity"

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

}

require 'uri'
require 'net/http'

url = URI("https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity")

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

{
  "cdConnection": {
    "status": "<string>",
    "latencyMs": 123
  },
  "nucleaApi": {
    "status": "<string>",
    "latencyMs": 123
  },
  "participantId": "<string>",
  "rsfnConnection": {
    "status": "<string>",
    "latencyMs": 123
  },
  "certificateExpiresAt": "<string>",
  "certificateValid": true
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

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

Path Parameters

participantIspb

string

required

Participant ISPB (8 digits). A non-conforming value is rejected with 400.

Example:

"12345678"

Response

cdConnection

object

required

managed file-transfer channel status (not yet configured: NOT_CONFIGURED).

Show child attributes

nucleaApi

object

required

Núclea REST-channel connectivity probe outcome: status is OK when the probe echo round-trips and DEGRADED otherwise. The probe sent is selected by the participant role: AGEN001 for the DOMICILE_IF (IF Domicílio) role, AGEN999 for other roles.

Show child attributes

participantId

string

required

Participant id (8-digit ISPB).

Example:

"12345678"

rsfnConnection

object

required

message-broker channel status (not yet configured: NOT_CONFIGURED).

Show child attributes

certificateExpiresAt

string

Signing-certificate expiry (RFC3339 UTC); not populated when certificate management is not configured.

Example:

"2027-06-15T00:00:00Z"

certificateValid

boolean

Whether the signing certificate is valid (not populated when certificate management is not configured).

Example:

true

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Test connectivity to Núclea for a participant

Authorizations

Path Parameters

Response