Consultar 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.

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?

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

Consultar Marcação de Fraude

get

Endpoint para consultar uma marcação de fraude específica pelo ID

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

markFraudIdstringRequired

ID da marcação de fraude a ser consultada

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

Responses

200

Detalhes da marcação de fraude retornados com sucesso

application/json

401

Falha de autorização

404

Marcação de fraude não encontrada

422

Falha de validação

500

Erro desconhecido no servidor

get

/internal/api/v1/keys/markFraud/consult/{markFraudId}

HTTPcURLJavaScriptPython

GET /internal/api/v1/keys/markFraud/consult/{markFraudId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "markFraudId": "708df85a-3521-4d93-90ca-7e51a869586e",
  "ispb": "11165756",
  "personType": "FISICA",
  "cpfCnpj": 12345678901,
  "key": "12345678901",
  "fraudType": "CONTA_FRAUDADOR",
  "statusMarkFraud": "ATIVA",
  "dateCreated": "2024-01-15T10:30:00.000Z",
  "dateModified": "2024-01-15T10:30:00.000Z"
}

JSON Retorno Sucesso