Skip to main content
GET
List consultations

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

status
string

Filter by lifecycle state: pending | completed | failed. An unknown value returns 422 SRC-0002.

Example:

"pending"

type
string

Filter by document type: CPF | CNPJ. An unknown value returns 422 SRC-0002.

Example:

"CPF"

companyConsultationId
string

Only the consultations LINKED to this company consultation — the link seen from the company's side. The value is a consultation id. An id that does not exist, or belongs to another deployment, returns an EMPTY page and 200 — never 404/422. A value that is not a UUID returns 400 SRC-0001.

Example:

"8f14e45f-ceea-467a-9a36-dedd4bea2543"

subjectRole
string

Filter by the role the consulted document plays: individual | company | holder | representative. An unknown value returns 422 SRC-0002.

Example:

"representative"

restrictionActive
string

Filter by whether the consultation holds an active restriction. THREE populations, and this parameter selects among them: true returns only the consultations where at least one consulted protection type came back restricted; false returns only the CONCLUDED consultations whose verdicts were all permitted; omitting the parameter returns all of them, INCLUDING the ones with no verdict yet (pending, and failed), which carry restrictionActive: null and are returned by NEITHER value — false is an assertion about a verdict RECEIVED, and a consultation BACEN has not answered has none. An empty value is the same as omitting the parameter; any other value outside true or false returns 422 SRC-0002.

Example:

"true"

from
string

Inclusive lower bound on acceptance time (RFC3339 date-time). Unparseable returns 400 SRC-0001.

Example:

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

to
string

Inclusive upper bound on acceptance time (RFC3339 date-time). Unparseable returns 400 SRC-0001; earlier than from returns 422 SRC-0002. For an EXACT page sequence set it a few seconds in the past, closing the window before you start paging — see the operation description.

Example:

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

cursor
string

Opaque pagination cursor from a previous page. An invalid cursor returns 400 SRC-0001. Paging is exact only inside a closed, lagged 'to' window — see the operation description.

limit
integer<int64>
default:50

Page size (1..200).

Required range: 1 <= x <= 200
Example:

50

Response

OK

items
object[] | null
required

The page's consultation summaries, newest first.

limit
integer<int64>
required

Effective page size this request was served with.

Example:

50

nextCursor
string | null
required

Opaque cursor for the following page; null on the last page.

prevCursor
string | null
required

Opaque cursor for the preceding page; null.