Skip to main content
POST
Search consultations

Autorizaciones

Authorization
string
header
requerido

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

Encabezados

X-Request-ID
string

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

Cuerpo

application/json
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.

document
string

Filter by consulted document, unmasked: CPF (11 numeric digits) or CNPJ (14 characters, 12 alphanumeric [0-9A-Z] plus 2 numeric check digits).

Pattern: ^([0-9]{11}|[0-9A-Z]{12}[0-9]{2})$
documentType
string

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

Ejemplo:

"CPF"

from
string

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

Ejemplo:

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

limit
integer<int64>
predeterminado:50

Page size (1..200).

Rango requerido: 1 <= x <= 200
Ejemplo:

50

status
string

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

Ejemplo:

"pending"

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.

Ejemplo:

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

Respuesta

OK

items
object[] | null
requerido

The page's consultation summaries, newest first.

limit
integer<int64>
requerido

Effective page size this request was served with.

Ejemplo:

50

nextCursor
string | null
requerido

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

prevCursor
string | null
requerido

Opaque cursor for the preceding page; null.