Create a Fraud Marker

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/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://plugin-pix-indirect.api.lerian.net/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://plugin-pix-indirect.api.lerian.net/v1/dict/fraud-markers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/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"
}

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

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

{
  "message": "<string>",
  "code": "<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://plugin-pix-indirect.api.lerian.net/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://plugin-pix-indirect.api.lerian.net/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://plugin-pix-indirect.api.lerian.net/v1/dict/fraud-markers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/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"
}

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

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

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

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Body

application/json

fraudType

enum<string>

required

Classification of the type of fraud

Available options:

APPLICATION_FRAUD,

MULE_ACCOUNT,

SCAMMER_ACCOUNT,

OTHER

Minimum string length: 1

Example:

"MULE_ACCOUNT"

taxIdNumber

string

required

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

Minimum string length: 1

Example:

"52998224725"

key

string

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

Required string length: 8 - 32

Example:

"fraud@example.com"

Response

Created

createdAt

string<date-time>

required

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

Example:

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

deletedAt

string<date-time> | null

required

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

Example:

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

document

string

required

CPF or CNPJ of the person or entity marked for fraud

Example:

"52998224725"

fraudType

enum<string>

required

Classification of the type of fraud

Available options:

APPLICATION_FRAUD,

MULE_ACCOUNT,

SCAMMER_ACCOUNT,

OTHER,

UNKNOWN

Example:

"MULE_ACCOUNT"

string

required

Unique identifier of the fraud marker (UUID)

Example:

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

infractionReport

object

required

Reference to the infraction report that originated this fraud marker

Show child attributes

key

string | null

required

Pix key value associated with the fraud marker

Example:

"fraud@example.com"

status

enum<string>

required

Current operational status of the fraud marker

Available options:

REGISTERED,

CANCELLED

Example:

"REGISTERED"

updatedAt

string<date-time>

required

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

Example:

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

DICT API

Claims API

MED · Infractions

MED · Fraud markers

MED · Refund requests

MED · Statistics

Transactions API

QR Codes API

Collections API

Funds Recovery API

Reconciliation API

Pix Automático API

Schedules API

Transaction Reports API

Transaction times

Webhooks API

Error handling

Create a Fraud Marker

Authorizations

Body

Response