Get channel settings

Returns the STR channel settings, including the participant ISPB binding, delivery mode, and any registered webhook endpoints. When readiness lookup is wired, the response also embeds the operational readiness summary.

GET /v1/str/settings

Get channel settings

cURL

curl --request GET \
  --url https://spb.sandbox.lerian.net/v1/str/settings \
  --header 'Authorization: Bearer <token>'

200

{
  "channelStatus": "CONNECTED",
  "correlationId": "req-7a3f9c2e",
  "deliveryMode": "WEBHOOK",
  "ispb": "12345678",
  "webhooks": [
    {
      "createdAt": "2026-05-04T18:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "isActive": true,
      "messageTypes": [
        "STR0004",
        "STR0007"
      ],
      "url": "https://example.com/webhooks/str",
      "metadata": {}
    }
  ],
  "certDaysRemaining": 365,
  "certificateExpiresAt": "2027-05-04T18:30:00Z",
  "metadata": {},
  "readiness": {
    "blockers": [
      "redis: connection refused"
    ],
    "status": "READY",
    "warnings": [
      "certificate expires in 12 days"
    ]
  }
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Respuesta

200

application/json

OK

channelStatus · enum<string> · requerido

SPB channel connectivity status: CONNECTED or PENDING_CONFIGURATION.

Opciones disponibles: CONNECTED, PENDING_CONFIGURATION

Ejemplo:

"CONNECTED"

correlationId · string · requerido

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

Ejemplo:

"req-7a3f9c2e"

deliveryMode · enum<string> · requerido

Notification delivery mode: WEBHOOK, EVENT (streaming), or BOTH.

Opciones disponibles: WEBHOOK, EVENT, BOTH

Ejemplo:

"WEBHOOK"

ispb · string · requerido

Participant ISPB the settings belong to, the 8-character BACEN institution identifier.

Required string length: 8

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

Ejemplo:

"12345678"

webhooks · object[] | null · requerido

Configured webhook endpoints that receive STR notifications.

Show child attributes

certDaysRemaining · integer<int64>

Whole days remaining until the active certificate expires; absent when no certificate is configured.

Ejemplo:

365

certificateExpiresAt · string<date-time>

UTC RFC 3339 expiry timestamp of the active ICP-Brasil certificate; absent when no certificate is configured.

Ejemplo:

"2027-05-04T18:30:00Z"

metadata · object

Client-supplied settings metadata; sensitive keys and values are redacted before being returned.

Show child attributes

readiness · object

Embedded readiness summary: aggregate status plus blocker and warning messages. Present only when a readiness source is wired into the settings handler.

Show child attributes