List fraud markers

Returns the fraud markers registered for the required tax_id_number within the participant scope determined by the authenticated tenant. Optional filters are key, status (REGISTERED or CANCELLED), modified_after and modified_before (RFC3339), and limit (1 to 200). limit has no default and is applied only when provided. The listing serves only a numeric CPF or CNPJ: an alphanumeric CNPJ passes validation and is then refused with 400 / PIX-0020. total is the number of markers in this page, not a count of every match; hasMoreElements says whether more markers match.

GET /dict/fraud-markers

List fraud markers

cURL

curl --request GET \
  --url https://api.example.com/dict-hub/v1/dict/fraud-markers \
  --header 'Authorization: Bearer <token>'

200

{
  "fraudMarkers": [],
  "hasMoreElements": false,
  "total": 1
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

tax_id_number · string · requerido

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.

Ejemplo:

"12345678901"

key · string

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

Ejemplo:

"[e-mail]"

status · enum<string>

Optional status filter

Opciones disponibles: REGISTERED, CANCELLED

Ejemplo:

"REGISTERED"

modified_after · string<date-time>

Optional RFC 3339 lower bound on lastModified

Ejemplo:

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

modified_before · string<date-time>

Optional RFC 3339 upper bound on lastModified

Ejemplo:

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

limit · string

Optional page size, 1..200

Ejemplo:

"50"

Respuesta

200

application/json

Matching fraud markers (possibly empty).

fraudMarkers · object[] · requerido

Matching fraud markers, empty when none match

Show child attributes

Ejemplo:

[]

hasMoreElements · boolean · requerido

Whether more results exist beyond this page

Ejemplo:

false

total · integer<int64> · requerido

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.

Ejemplo:

1