Suspected fraud query

The suspected fraud query retrives the suspected frauds by a conditional search.

Suspected Fraud Query

post

Authorizations

Body

queryModestring · enumOptionalPossible values:

pageintegerOptional

The page number to request in paginated queries.

startDatestring · date-timeOptional

The start Date Time of consult, ISO 8621 format.

endDatestring · date-timeOptional

The end Date Time of consult, ISO 8621 format.

Responses

200

Suspected fraud query occurred successfully.

application/json

400

Suspected fraud query failed due to a bad request.

application/json

401

Unauthorized.

application/json

422

Suspected fraud query failed, but the request was processed by the API, just not by the peer.

application/json

500

Suspected fraud query failed due to an unexpected error in the API.

application/json

503

Suspected fraud query failed due to an unexpected error in the Peer.

application/json

post

HTTPcURLJavaScriptPython

POST /fraud/query HTTP/1.1
Host: api.prd.combateafraude.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 157

{
  "identifier": {
    "data": "01234567890",
    "type": "CPF"
  },
  "queryMode": "DEFAULT",
  "page": 1,
  "startDate": "2025-05-30T10:42:39.073Z",
  "endDate": "2025-05-30T10:42:39.073Z"
}

{
  "message": "text",
  "requestStatus": {
    "status": "SUCCESS",
    "token": "123e4567-e89b-12d3-a456-426614174000"
  },
  "amount": 1,
  "occurrences": [
    {
      "data": {
        "data_ultima_alteracao": "2025-05-30T10:42:39.073Z",
        "instituicao_responsavel": {
          "cnpj_origem": "text",
          "razao_social_origem": "text"
        },
        "informacoes_bancarias_destino": {
          "codigo_instituicao": 1,
          "agencia": "text",
          "conta": {
            "numero": "text",
            "tipo": 1,
            "titular": {
              "documento": {
                "tipo": 1,
                "numero": "text"
              },
              "nome_completo_razao_social": "text",
              "nome_fantasia": "text"
            },
            "documento_representante_legal": [
              {
                "tipo": 1,
                "numero": "text"
              }
            ]
          },
          "chave_pix": {
            "tipo": 1,
            "valor": "text"
          },
          "linha_digitavel_boleto": "text"
        },
        "informacao_executor": {
          "nome": "text",
          "razao_social": "text",
          "documento": {
            "tipo": 1,
            "numero": "text"
          },
          "documento_representante_legal": [
            {
              "tipo": 1,
              "numero": "text"
            }
          ]
        },
        "informacao_reclamante": {
          "documento": {
            "tipo": 1,
            "numero": "text"
          },
          "documento_representante_legal": [
            {
              "tipo": 1,
              "numero": "text"
            }
          ]
        },
        "registro": {
          "data_hora": "2025-05-30T10:42:39.073Z",
          "local": "text",
          "canal": 1,
          "atividade_relacionada": 1,
          "classificacao": 1,
          "motivo": "text",
          "valor_transacao": 1,
          "valor_contrato": 1,
          "dispositivo": {
            "identificacao": "text",
            "ip": "0.0.0.0"
          },
          "envolvimento_reclamante": 1,
          "modalidade_fraude": 1
        }
      },
      "source": "INVALID_HUB",
      "status": "SUSPECTED_FRAUD",
      "token": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "totalPages": 2,
  "currentPage": 1
}

Options

As demonstrated in the example request you can set the above properties to the search/query the suspected frauds:

• The identifier object is used to query suspected fraud occurrences, is composed by data (a string representing the document number) and by type (must be CPF or CNPJ). It's a required property;

• The queryMode property indicates how the query is be performed, it's an optional field and your default value is DEFAULT. The possible values are:

  • DEFAULT: It's the conventional mode, propagates the query to All.Id Network and to all available hubs of the consortium network;

  • LOCAL: Indicates that the query will be executed locally on the Peer, without propagating the query to the network. A unique identifier per SuspectedFraud is returned, a UUID named token;

  • INTERNAL: Indicates that the query will be executed internally in the All.Id Network, not propagating to the consortium network;

  • DELETED: Similar to LOCAL mode, the query will be executed locally but returning SuspectedFraud's marked as deleted.

• The startDate and endDate properties must be strings representing a date-time ISO format. Those properties must be optional.

• The page property should only be used for queries with paginated responses due to the excessive size of the data. It is an optional integer field. If not specified, a standard query is executed; if specified, it retrieves the requested page.

Paginated Responses

Paginated responses are used to handle the large volume of aggregated data returned. Each page contains up to 5,000 entries and is ordered by occurrence date, with the most recent entries appearing first.

Pages are valid for 1 hour. After this period, any attempt to access these pages will result in an error. Similarly, attempting to retrieve pages for non-paginated queries will also result in an error.