Suspected fraud query

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

Suspected fraud query

post

/query

Authorizations

Body

identifierobjectrequired

Identifier of suspected fraud.

queryModestring · enum

Options: DEFAULT, LOCAL, INTERNAL, DELETED

startDatestring · date-time

The start Date Time of consult, ISO 8621 format.

endDatestring · date-time

The end Date Time of consult, ISO 8621 format.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.prd.combateafraude.com/fraud/query' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "identifier": {
      "data": "01234567890",
      "type": "CPF"
    },
    "queryMode": "DEFAULT",
    "startDate": "2025-03-13T00:52:55.418Z",
    "endDate": "2025-03-13T00:52:55.418Z"
  }'

200

400

401

422

500

503

200

{
  "message": "text",
  "requestStatus": {
    "status": "SUCCESS",
    "token": "123e4567-e89b-12d3-a456-426614174000"
  },
  "amount": 1,
  "occurrences": [
    {
      "data": {
        "data_ultima_alteracao": "2025-03-13T00:52:55.418Z",
        "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-03-13T00:52:55.418Z",
          "local": "text",
          "canal": 1,
          "atividade_relacionada": 1,
          "classificacao": 1,
          "motivo": "text",
          "valor_transacao": 1,
          "valor_contrato": 1,
          "dispositivo": {
            "identificacao": "text",
            "ip": "127.0.0.1"
          },
          "envolvimento_reclamante": 1,
          "modalidade_fraude": 1
        }
      },
      "source": "INVALID_HUB",
      "status": "SUSPECTED_FRAUD",
      "token": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Suspected fraud query occurred successfully.

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.