Listar Marcacao de fraude

Importante:

Para usar esta API, é necessário estar autenticado e incluir seu token de autenticação no cabeçalho da requisição. Consulte a documentação de Autenticação na plataforma para mais informações.

Autenticação.

O Sistema Cliente deve utilizar esta API sempre que um Cliente precisar acessar a lista de marcacoes de fraude.

Como utilizar?

Para utilizar essa funcionalidade, siga estes passos simples. Abaixo, você encontrará exemplos de como realizar o processo de abertura de conta.

Requisição de exemplo

Listar Marcações de Fraude

get

Endpoint para listar marcações de fraude com filtros opcionais

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ispbstringRequired

ISPB da instituição financeira

Example: 11165756

cpfCnpjnumberRequired

CPF ou CNPJ do titular da chave

Example: 12345678901

keystringOptional

Chave PIX para filtrar

Example: 12345678901

markFraudIdstringOptional

ID da marcação de fraude

Example: 708df85a-3521-4d93-90ca-7e51a869586e

fraudTypestring · enumOptional

Tipo de fraude

Example: CONTA_FRAUDADORPossible values:

statusMarkFraudstringOptional

Status da marcação de fraude

Example: ATIVA

dateStartMarkFraudstring · dateOptional

Data inicial para filtrar marcações

Example: 2024-01-01

dateEndMarkFraudstring · dateOptional

Data final para filtrar marcações

Example: 2024-12-31

pageintegerOptional

Número da página para paginação

Default: 1Example: 1

limitintegerOptional

Limite de resultados por página

Default: 10Example: 10

Responses

200

Lista de marcações de fraude retornada com sucesso

application/json

401

Falha de autorização

422

Falha de validação

500

Erro desconhecido no servidor

get

/internal/api/v1/keys/markFraud/list

HTTPcURLJavaScriptPython

GET /internal/api/v1/keys/markFraud/list?ispb=text&cpfCnpj=1 HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalMarkFrauds": 25,
  "page": 1,
  "limit": 10,
  "markFrauds": [
    {
      "markFraudId": "708df85a-3521-4d93-90ca-7e51a869586e",
      "ispb": "11165756",
      "cpfCnpj": 12345678901,
      "key": "12345678901",
      "fraudType": "CONTA_FRAUDADOR",
      "statusMarkFraud": "ATIVA",
      "dateCreated": "2024-01-15T10:30:00.000Z"
    }
  ]
}

JSON Retorno Sucesso