Consulta de fraude suspeita

Requisitos de autenticação:

Endpoints regulares usam OAuth2 autenticação com URL base: https://api.us.prd.caf.io
Para maior segurança, alguns endpoints também podem suportar mTLS autenticação com URL base: https://mtls.us.prd.caf.io
Para informações sobre a implementação de mTLS, acesse Usando mTLS

A consulta de fraude suspeita recupera as fraudes suspeitas por meio de uma pesquisa condicional.

Suspected Fraud Query

post

/query

Retrieves the suspected frauds by a conditional search.

Permission required: Create RS6 Query

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Parâmetros de cabeçalho

AuthorizationstringObrigatório

Your access token. See more in the 'Authentication' topic of this section.

Example: Bearer YOUR_TOKEN

Corpo

queryModestring · enumOpcionalValores possíveis:

pageintegerOpcional

The page number to request in paginated queries.

startDatestring · date-timeOpcional

The start Date Time of consult, ISO 8621 format.

endDatestring · date-timeOpcional

The end Date Time of consult, ISO 8621 format.

Respostas

200

Suspected fraud query occurred successfully.

application/json

messagestringObrigatório

Human readable message informing about the operation.

amountintegerObrigatório

Total amount of query results.

totalPagesintegerOpcional

The total number of pages in a paginated response.

Example: 2

currentPageintegerOpcional

The current page in a paginated response.

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/query

POST /v1/rs6/query HTTP/1.1
Host: api.us.prd.caf.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 157

{
  "identifier": {
    "data": "01234567890",
    "type": "CPF"
  },
  "queryMode": "DEFAULT",
  "page": 1,
  "startDate": "2026-01-01T00:00:00.000Z",
  "endDate": "2026-01-01T00:00:00.000Z"
}

{
  "message": "text",
  "requestStatus": {
    "status": "SUCCESS",
    "token": "123e4567-e89b-12d3-a456-426614174000"
  },
  "amount": 1,
  "occurrences": [
    {
      "data": {
        "data_ultima_alteracao": "2026-01-01T00:00:00.000Z",
        "instituicao_responsavel": {
          "cnpj_origem": "text",
          "razao_social_origem": "text"
        },
        "informacoes_bancarias_destino": {
          "codigo_instituicao": 1,
          "ispb": "text",
          "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": "2026-01-01T00:00:00.000Z",
          "local": "text",
          "canal": 1,
          "atividade_relacionada": 1,
          "classificacao": 1,
          "classificacao_irregularidade": 1,
          "operadora_aposta_dominio": "example.com",
          "motivo": "text",
          "valor_transacao": 1,
          "valor_contrato": 1,
          "dispositivo": {
            "identificacao": "text",
            "ip": "0.0.0.0"
          },
          "envolvimento_reclamante": 1,
          "modalidade_fraude": 1,
          "ativo_virtual": {
            "tipo_operacao": 1,
            "moeda": "text",
            "quantidade": "text",
            "transacao_id": "text"
          }
        }
      },
      "source": "INVALID_HUB",
      "status": "SUSPECTED_FRAUD",
      "token": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "totalPages": 2,
  "currentPage": 1
}

Opções

Conforme demonstrado na solicitação de exemplo, você pode definir as propriedades acima para pesquisar/consultar as fraudes suspeitas:

A identifier objeto é usado para consultar ocorrências de fraude suspeita, é composto por data (uma string representando o número do documento) e por tipo (deve ser CPF ou CNPJ). É uma obrigatório propriedade;
A queryMode propriedade indica como a consulta será executada, é um campo opcional e seu valor padrão é DEFAULT. Os valores possíveis são:
- DEFAULT: É o modo convencional, propaga a consulta para a All.Id Network e para todos os hubs disponíveis da rede do consórcio;
- LOCAL: Indica que a consulta será executada localmente no Peer, sem propagar a consulta para a rede. Um identificador único por SuspectedFraud é retornado, um UUID chamado token;
- INTERNAL: Indica que a consulta será executada internamente na All.Id Network, sem propagação para a rede do consórcio;
- DELETED: Semelhante ao LOCAL modo, a consulta será executada localmente, mas retornando de SuspectedFraud marcados como excluídos.
A startDate e endDate as propriedades devem ser strings representando um formato de data e hora ISO. Essas propriedades devem ser opcionais.
A page a propriedade deve ser usada apenas para consultas com respostas paginadas devido ao tamanho excessivo dos dados. É um campo inteiro opcional. Se não for especificada, uma consulta padrão é executada; se for especificada, recupera a página solicitada.

Respostas paginadas

Respostas paginadas são usadas para lidar com o grande volume de dados agregados retornados. Cada página contém até 5.000 entradas e é ordenada pela data de ocorrência, com as entradas mais recentes aparecendo primeiro.

As páginas são válidas por 1 hora. Após esse período, qualquer tentativa de acessar essas páginas resultará em um erro. Da mesma forma, tentar recuperar páginas para consultas não paginadas também resultará em um erro.

A paginação usa indexação baseada em 0 — certifique-se de seguir isso ao solicitar páginas subsequentes.

Atualizado há 6 meses