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ção de Fraude

get

Authorizations

Query parameters

ispbstringRequired

Código ISPB da instituição bancária

Example: 11165756

cpfCnpjnumberRequired

CPF ou CNPJ da pessoa associada à marcação de fraude. Required Quando não tem dateStartMarkFraud

Example: 12345678000195

chavestringOptional

Chave associada à marcação de fraude

Example: chave123

markFraudIdstringOptional

ID da marcação de fraude

Example: abc123

fraudTypestring · enumOptional

Tipo de fraude

Example: FALSIDADE_IDEOLOGICAPossible values:

statusMarkFraudstring · enumOptional

Status da marcação de fraude

Example: RegistradaPossible values:

dateStartMarkFraudstring · date-timeOptional

Data de início da criação da marcação de fraude

Example: 2024-11-01T00:00:00.000Z

dateEndMarkFraudstring · date-timeOptional

Data de fim da criação da marcação de fraude

Example: 2024-11-30T23:59:59.999Z

pageintegerOptional

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

Example: 1

limitinteger · max: 100Optional

Quantidade de resultados por página. Limite 100

Example: 10

Responses

get

HTTPcURLJavaScriptPython

GET /internal/api/v1/keys/markFraud/list HTTP/1.1
Host: sandbox.globalscm.app.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "dthr": "2024-11-26T10:30:00.000Z",
  "totalMarkFraud": 100,
  "page": 1,
  "limitPage": 10,
  "hasBeforePage": true,
  "hasAfterPage": true,
  "markFraud": [
    {
      "markFraudId": "abc123",
      "peopleType": "FISICA",
      "cpfCnpj": 12345678000195,
      "key": "chave123",
      "fraudType": "FALSIDADE_IDEOLOGICA",
      "statusMarkFraud": "Registrada",
      "dateCreateMarkFraud": "2024-11-20T08:15:00.000Z",
      "dateUpdateMarkFraud": "2024-11-22T09:00:00.000Z"
    }
  ]
}

JSON Retorno Sucesso