Incluir 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 utiliza essa API para iniciar um processo de Marcacao de Fraude .

As marcações de fraude são utilizadas para fins de segurança do Pix, sensibilizando contadores de estatísticas que podem ser obtidos por pessoa (CPF/CNPJ) ou por chave.

Sempre que identificada uma transação fraudulenta que possua chave Pix, a mesma deve ser indicada na requisição desta API, para também receber a marcação de fraude, além do CPF ou CNPJ da transação.

Como utilizar?

Requisição de exemplo

Incluir Marcação de Fraude

post

Authorizations

Body

ispbstringRequired

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

Example: 11165756

personTypestring · enumRequired

Tipo de pessoa (Física ou Jurídica)

Example: PFPossible values:

cpfCnpjnumberRequired

CPF ou CNPJ do cliente

Example: 12345678901

chavestringOptional

Chave associada ao cliente (opcional)

Example: chave-xyz

fraudTypestring · enumRequired

Tipo de fraude

Example: FALSIDADE_IDEOLOGICAPossible values:

Responses

200

Marcação de fraude concluída com sucesso

application/json

401

Falha na autorização

422

Falha na validação dos dados enviados

500

Erro desconhecido do servidor

post

HTTPcURLJavaScriptPython

POST /internal/api/v1/keys/markFraud HTTP/1.1
Host: sandbox.globalscm.app.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "ispb": "11165756",
  "personType": "PF",
  "cpfCnpj": "12345678901",
  "chave": "chave-xyz",
  "fraudType": "FALSIDADE_IDEOLOGICA"
}

{
  "dateDictResponse": "2024-11-26T10:30:00.000Z",
  "correlationId": "a1b2c3d4-e5f6-7g8h-9i0j-1k2l3m4n5o6p",
  "markFraudId": "abc123",
  "statusMarkFraud": "Registrada",
  "dateCreateMarkFraud": "2024-11-20T08:15:00.000Z",
  "dateUpdateMarkFraud": "2024-11-22T09:00:00.000Z"
}

JSON Retorno Sucesso