List Fraud Markers

Use this endpoint to list fraud markers with filters. Returns empty array [] if no markers match the criteria.

Notes:

• This endpoint is a proxy to BTG and does not persist data locally.

• Uses cursor-based pagination via modified_after/modified_before filters.

• When hasMoreElements is true, use the updatedAt of the last item as modified_after for the next request.

GET /v1/dict/fraud-markers

List Fraud Markers

cURL

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/fraud-markers \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "items": [
    {
      "id": "019c96a0-0cfd-7d0d-8fc5-17a164b828b6",
      "document": "12345678901",
      "fraudType": "MULE_ACCOUNT",
      "key": "[e-mail]",
      "status": "REGISTERED",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "hasMoreElements": false
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer · default: 10

Maximum number of items per page.

Required range: 1 <= x <= 100

modified_after · string

Filter by records modified after this timestamp (RFC3339 format: 2024-01-15T10:30:00Z).

modified_before · string

Filter by records modified before this timestamp (RFC3339 format: 2024-01-15T10:30:00Z).

tax_id · string

Filter by CPF or CNPJ document.

status · enum<string>

Filter by status.

Available options: REGISTERED, CANCELLED

Response

200

application/json

List of fraud markers retrieved successfully.

items · object[]

Show child attributes

hasMoreElements · boolean

Indicates if there are more elements to fetch.

Example:

false