Create a Fraud Marker

curl --request POST \
  --url https://api.example.com/v1/dict/fraud-markers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fraudType": "MULE_ACCOUNT",
  "taxIdNumber": "52998224725",
  "key": "fraud@example.com"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/dict/fraud-markers"

	payload := strings.NewReader("{\n  \"fraudType\": \"MULE_ACCOUNT\",\n  \"taxIdNumber\": \"52998224725\",\n  \"key\": \"fraud@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fraudType: 'MULE_ACCOUNT',
    taxIdNumber: '52998224725',
    key: 'fraud@example.com'
  })
};

fetch('https://api.example.com/v1/dict/fraud-markers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/dict/fraud-markers"

payload = {
    "fraudType": "MULE_ACCOUNT",
    "taxIdNumber": "52998224725",
    "key": "fraud@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "createdAt": "2024-01-15T10:30:00Z",
  "deletedAt": "2024-01-20T14:45:00Z",
  "document": "52998224725",
  "fraudType": "MULE_ACCOUNT",
  "id": "550e8400-e29b-41d4-a716-44665544f999",
  "infractionReport": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "reporterParticipant": "12345678"
  },
  "key": "fraud@example.com",
  "status": "REGISTERED",
  "updatedAt": "2024-01-15T10:30:00Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Create a Fraud Marker

Use this endpoint to register a fraud marker for a tax ID or Pix key.

Notes:

Fraud markers are used to flag documents (CPF/CNPJ) or Pix keys associated with fraudulent activity.
The taxIdNumber field is required and represents the person/entity being marked.
The key field is optional and can be used to associate the marker with a specific Pix key.
Fraud markers can also be automatically created when closing an infraction report with AGREED result.

POST

dict

fraud-markers

Create a Fraud Marker

curl --request POST \
  --url https://api.example.com/v1/dict/fraud-markers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fraudType": "MULE_ACCOUNT",
  "taxIdNumber": "52998224725",
  "key": "fraud@example.com"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/dict/fraud-markers"

	payload := strings.NewReader("{\n  \"fraudType\": \"MULE_ACCOUNT\",\n  \"taxIdNumber\": \"52998224725\",\n  \"key\": \"fraud@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fraudType: 'MULE_ACCOUNT',
    taxIdNumber: '52998224725',
    key: 'fraud@example.com'
  })
};

fetch('https://api.example.com/v1/dict/fraud-markers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/dict/fraud-markers"

payload = {
    "fraudType": "MULE_ACCOUNT",
    "taxIdNumber": "52998224725",
    "key": "fraud@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "createdAt": "2024-01-15T10:30:00Z",
  "deletedAt": "2024-01-20T14:45:00Z",
  "document": "52998224725",
  "fraudType": "MULE_ACCOUNT",
  "id": "550e8400-e29b-41d4-a716-44665544f999",
  "infractionReport": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "reporterParticipant": "12345678"
  },
  "key": "fraud@example.com",
  "status": "REGISTERED",
  "updatedAt": "2024-01-15T10:30:00Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json

fraudType

enum<string>

requerido

Classification of the type of fraud

Opciones disponibles:

APPLICATION_FRAUD,

MULE_ACCOUNT,

SCAMMER_ACCOUNT,

OTHER

Minimum string length: 1

Ejemplo:

"MULE_ACCOUNT"

taxIdNumber

string

requerido

CPF or CNPJ of the person or entity being marked for fraud

Minimum string length: 1

Ejemplo:

"52998224725"

key

string

Pix key value associated with the fraudulent activity (8-32 characters)

Required string length: 8 - 32

Ejemplo:

"fraud@example.com"

Respuesta

Created

createdAt

string<date-time>

requerido

Timestamp when the fraud marker was created (ISO 8601 UTC)

Ejemplo:

"2024-01-15T10:30:00Z"

deletedAt

string<date-time> | null

requerido

Timestamp when the fraud marker was soft-deleted (ISO 8601 UTC)

Ejemplo:

"2024-01-20T14:45:00Z"

document

string

requerido

CPF or CNPJ of the person or entity marked for fraud

Ejemplo:

"52998224725"

fraudType

enum<string>

requerido

Classification of the type of fraud

Opciones disponibles:

APPLICATION_FRAUD,

MULE_ACCOUNT,

SCAMMER_ACCOUNT,

OTHER,

UNKNOWN

Ejemplo:

"MULE_ACCOUNT"

string

requerido

Unique identifier of the fraud marker (UUID)

Ejemplo:

"550e8400-e29b-41d4-a716-44665544f999"

infractionReport

object

requerido

Reference to the infraction report that originated this fraud marker

Show child attributes

key

string | null

requerido

Pix key value associated with the fraud marker

Ejemplo:

"fraud@example.com"

status

enum<string>

requerido

Current operational status of the fraud marker

Opciones disponibles:

REGISTERED,

CANCELLED

Ejemplo:

"REGISTERED"

updatedAt

string<date-time>

requerido

Timestamp when the fraud marker was last updated (ISO 8601 UTC)

Ejemplo:

"2024-01-15T10:30:00Z"

API de DICT

API de Reclamaciones

MED · Infracciones

MED · Marcadores de fraude

MED · Solicitudes de devolución

MED · Estadísticas

API de Transacciones

API de Códigos QR

API de Cobros

API de Recuperación de Fondos

API de Conciliación

API de Pix Automático

API de Programaciones

API de Informes de Transacción

Tiempos de transacciones

API de Webhooks

Manejo de errores

Eventos

Create a Fraud Marker

Autorizaciones

Cuerpo

Respuesta