Skip to main content
POST
Search evidence records

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Request-ID
string

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

Corpo

application/json
cursor
string

Opaque pagination cursor from a previous page. An invalid cursor returns 400 SRC-0001.

document
string

Required unless kind is credential_operation or operator_case_closure. The consulted document, unmasked: CPF (11 numeric digits) or CNPJ (14 characters, 12 alphanumeric [0-9A-Z] plus 2 numeric check digits). Absent or off-pattern returns 422 SRC-0002, except that absence is accepted when kind is one of those two classes.

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

Optional declared class of the document: CPF or CNPJ. It filters nothing and does not change the returned documentMasked. A value outside the vocabulary returns 422 SRC-0002 with a violation on this member.

Opções disponíveis:
CPF,
CNPJ
Exemplo:

"CPF"

kind
enum<string>

Optional record class that restricts the page. When it is credential_operation or operator_case_closure, document is optional. For every other class, document is required. A value outside the vocabulary returns 422 SRC-0002 with a violation on this member.

Opções disponíveis:
acceptance,
entry_refusal,
dispatch_attempt,
channel_confirmation,
response,
rejection,
duplicate_response,
notification,
client_decision,
refusal_explanation,
credential_operation,
operator_case_closure,
correction
Exemplo:

"operator_case_closure"

limit
integer<int64>
padrão:50

Page size (1..200).

Intervalo obrigatório: 1 <= x <= 200
Exemplo:

50

Resposta

OK

documentMasked
string
obrigatório

The searched document, masked.

Exemplo:

"529******26"

items
object[] | null
obrigatório

The page's evidence records, most recently occurred first.

limit
integer<int64>
obrigatório

Effective page size this request was served with.

Exemplo:

50

nextCursor
string | null
obrigatório

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