Get participant

Retrieves a single participant by their 8-digit ISPB code.

GET /api/v1/core/participants/{ispb}

Get participant

cURL

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/core/participants/{ispb} \
  --header 'Authorization: Bearer <token>'

200

{
  "createdAt": "<string>",
  "id": "<string>",
  "ispb": "<string>",
  "name": "<string>",
  "status": "<string>",
  "type": "<string>",
  "updatedAt": "<string>",
  "config": {
    "quotaDailyLimit": 123,
    "quotaTransactionLimit": 123,
    "routingPolicy": "<string>"
  },
  "sponsorISPB": "<string>"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

ispb · string · required

ISPB (8 numeric digits)

Example:

"12345678"

Response

200

application/json

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.

Show child attributes

sponsorISPB · string

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

Example:

""