Pular para o conteúdo principal

Antifraude

Os endpoints a seguir trazem as funcionalidades disponíveis para a gestão de Antifraude


Criar marcação de fraude​

Endpoint para criar uma marcação de fraude.

Idempotência

A operação de criação de marcação de fraude é idempotente. Para garantir a idempotência da operação, a requisição tem um campo RequestId, que deve ser único no contexto de um mesmo participante.

POST /dict/fraud-markers
Requer autorização para o escopo: antifraud.ind.write


Requisição

{
  "fraudMarker": {
    "fraudType": "MULE_ACCOUNT",
    "key": "[email protected]",
    "taxIdNumber": "01234567890"
  },
  "requestId": "a946d533-7f22-42a5-9a9b-e87cd55c0f4d"
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "responseTime": 299,
  "fraudMarker": {
    "taxIdNumber": "01234567890",
    "key": "[email protected]",
    "fraudType": "MULE_ACCOUNT",
    "identification": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
    "status": "REGISTERED",
    "creationTime": "2020-01-17T10:00:00.000Z",
    "lastModified": "2020-01-17T10:00:00.000Z"
  }
}

Consultar marcação de fraude​

Endpoint para obter detalhes de uma marcação de fraude.

GET /dict/fraud-markers/:fraudMarkerId
Requer autorização para o escopo: antifraud.ind.read


Requisição

A requisição enviada para esse endpoint não precisa de um body, apenas os cabeçalhos de autorização OAuth, parâmetros e o certificado da conta.

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "fraudMarker": {
    "creationTime": "2020-01-17T10:00:00.000Z",
    "fraudType": "MULE_ACCOUNT",
    "id": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
    "key": "[email protected]",
    "lastModified": "2020-01-17T10:00:00.000Z",
    "status": "REGISTERED",
    "taxIdNumber": "01234567890"
  },
  "responseTime": 0
}

Cancelar marcação de fraude​

Endpoint para cancelar uma marcação de fraude.

Pode ser realizada pelo participante que criou a marcação de fraude.

Uma marcação de fraude criada como consequência do fechamento de uma notificação de infração pode ser cancelada pelo participante contraparte, que fez o fechamento da notificação.

Idempotência

A operação é idempotente. Caso o registro já tenha sido cancelado com os mesmos parâmetros, será retornada resposta equivalente à primeira requisição.

POST /dict/fraud-markers/:fraudMarkerId/cancel
Requer autorização para o escopo: antifraud.ind.write


Requisição

{
  "fraudMarkerId": "91d65e98-97c0-4b0f-b577-73625da1f9fc"
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "fraudMarker": {
    "creationTime": "2020-01-17T10:00:00.000Z",
    "fraudType": "MULE_ACCOUNT",
    "id": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
    "key": "[email protected]",
    "lastModified": "2023-01-17T10:00:00.000Z",
    "status": "CANCELLED",
    "taxIdNumber": "01234567890"
  },
  "responseTime": 0
}

Consultar estatísticas de pessoa​

Endpoint para obter dados estatísticos de um usuário final.

GET /dict/persons/:taxIdNumber/statistics
Requer autorização para o escopo: statistics.ind.read


Requisição

A requisição enviada para esse endpoint não precisa de um body, apenas os cabeçalhos de autorização OAuth, parâmetros e o certificado da conta.

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "personStatistics": {
    "entries": {
      "registeredAccounts": 0,
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "fraudMarkers": {
      "applicationFrauds": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "distinctFraudReporters": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "muleAccounts": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "otherFrauds": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "scammerAccounts": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "totalFraudTransactionAmount": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "unknownFrauds": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "infractionReports": {
      "openReports": 0,
      "openReportsDistinctReporters": 0,
      "rejectedReports": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "spi": {
      "settlements": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    }
  },
  "responseTime": 0,
  "taxIdNumber": "12345678901"
}

Consultar estatística de chave registrada​

Endpoint para obter dados estatísticos relacionados a uma chave registrada.

GET /dict/entries/:key/statistics
Requer autorização para o escopo: statistics.ind.read


Requisição

A requisição enviada para esse endpoint não precisa de um body, apenas os cabeçalhos de autorização OAuth, parâmetros e o certificado da conta.

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "responseTime": 300,
  "key": "11122233300",
  "keyStatistics": {
    "entries": {
      "distinctAccounts": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "fraudMarkers": {
      "applicationFrauds": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "distinctFraudReporters": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "muleAccounts": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "otherFrauds": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "scammerAccounts": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "totalFraudTransactionAmount": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "unknownFrauds": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "infractionReports": {
      "openReports": "0",
      "openReportsDistinctReporters": "0",
      "rejectedReports": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "spi": {
      "settlements": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    }
  },
  "ownerStatistics": {
    "entries": {
      "registeredAccounts": "0",
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "fraudMarkers": {
      "applicationFrauds": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "distinctFraudReporters": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "muleAccounts": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "otherFrauds": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "scammerAccounts": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "totalFraudTransactionAmount": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "unknownFrauds": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "infractionReports": {
      "openReports": "0",
      "openReportsDistinctReporters": "0",
      "rejectedReports": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "spi": {
      "settlements": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    }
  }
}

Última atualização em