Skip to main content
GET
Retrieve the consultation dashboard

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Request-ID
string

Optional correlation id (UUID) propagated through logs/traces.

Query Parameters

from
string<date-time>
required

Inclusive lower bound on acceptance time (RFC3339 date-time). REQUIRED: an absent or unparseable value returns 422 SRC-0002.

Example:

"2026-08-01T00:00:00Z"

to
string<date-time>
required

Inclusive upper bound on acceptance time (RFC3339 date-time). REQUIRED: an absent or unparseable value returns 422 SRC-0002; earlier than 'from' returns 422 SRC-0002 with a violation on this field.

Example:

"2026-08-31T23:59:59Z"

Response

OK

byDocumentType
object
required

Breakdown by consulted document type.

byOutcome
object
required

Breakdown by outcome. These four partition consultations.status: their sum equals total.

byRegistration
object
required

Institution records registered in the period, counted by registration time. They are not outcomes: do not add them to total or byOutcome.

bySubjectRole
object
required

Breakdown by the role the consulted document plays. These four PARTITION total, as byDocumentType does: their sum equals total on a quiesced period.

companyLinkage
object
required

Counts over the company consultations accepted in the period: how many have linked holder or representative consultations, how many have none, and the outcome of the linked ones. The period applies to the company consultations only, so these numbers do not reconcile with bySubjectRole.holder and bySubjectRole.representative.

from
string<date-time>
required

Inclusive lower bound of the window these numbers were counted over.

openOperatorCases
integer<int64>
required

Open operator cases now, in the four legs: budget_exhausted, orphan_response, invalid_outbound and credential_operation. It does not depend on from and to. GET /v1/src/operator/cases lists them.

Example:

1

pendingBeyondExpected
integer<int64>
required

Consultations that are pending now for longer than the src.pending.alert_threshold runtime setting. It does not depend on from and to, so it is not a subset of byOutcome.pending and can be larger.

Example:

3

rejectionsByCode
object
required

Rejections of the period by rejection code, as received. Each key is a BACEN error code, except SRC-OUTBOUND-INVALID: Lerian SRC refused to send a message that did not conform to BACEN's specification.

restrictionsByProtectionType
object
required

Active-restriction verdicts of the period by protection type. A consultation restricted on two types counts twice, so this map does not sum to byOutcome.withRestriction. A configured protection type with no restriction in the period shows 0.

to
string<date-time>
required

Inclusive upper bound of the window these numbers were counted over.

total
integer<int64>
required

Consultations accepted in the period. A request refused before acceptance creates no consultation, so this total and the breakdowns do not count it.

Example:

1240