Pular para o conteúdo principal
GET
List fraud markers

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

tax_id_number
string
obrigatório

CPF or CNPJ (numeric or alphanumeric per IN RFB 2.229/2024) to filter by, checked against BACEN/RFB check digits. Mask, surrounding whitespace, and lowercase are accepted and normalized to the canonical unformatted uppercase form before use.

Exemplo:

"12345678901"

key
string

Optional Pix key filter. Maximum 77 BYTES UTF-8, not characters -- see CreateFraudMarkerBody.Key.

Exemplo:

"user@example.com"

status
enum<string>

Optional status filter

Opções disponíveis:
REGISTERED,
CANCELLED
Exemplo:

"REGISTERED"

modified_after
string<date-time>

Optional RFC 3339 lower bound on lastModified

Exemplo:

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

modified_before
string<date-time>

Optional RFC 3339 upper bound on lastModified

Exemplo:

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

limit
string

Optional page size, 1..200

Exemplo:

"50"

Resposta

Matching fraud markers (possibly empty).

fraudMarkers
object[]
obrigatório

Matching fraud markers, empty when none match

Exemplo:
hasMoreElements
boolean
obrigatório

Whether more results exist beyond this page

Exemplo:

false

total
integer<int64>
obrigatório

Number of fraud markers in this page. It is not a count of every match: BACEN returns none, and hasMoreElements says whether more markers match.

Exemplo:

1