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 '
{
  "taxIdNumber": "12345678901",
  "fraudType": "MULE_ACCOUNT",
  "key": "fraud@example.com"
}
'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/fraud-markers"

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

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    taxIdNumber: '12345678901',
    fraudType: 'MULE_ACCOUNT',
    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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/dict/fraud-markers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'taxIdNumber' => '12345678901',
    'fraudType' => 'MULE_ACCOUNT',
    'key' => 'fraud@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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  \"taxIdNumber\": \"12345678901\",\n  \"fraudType\": \"MULE_ACCOUNT\",\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))

}

HttpResponse<String> response = Unirest.post("https://plugin-pix-indirect.api.lerian.net/v1/dict/fraud-markers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"taxIdNumber\": \"12345678901\",\n  \"fraudType\": \"MULE_ACCOUNT\",\n  \"key\": \"fraud@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/dict/fraud-markers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"taxIdNumber\": \"12345678901\",\n  \"fraudType\": \"MULE_ACCOUNT\",\n  \"key\": \"fraud@example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "019c96a0-0cfd-7d0d-8fc5-17a164b828b6",
  "document": "12345678901",
  "fraudType": "MULE_ACCOUNT",
  "key": "fraud@example.com",
  "status": "REGISTERED",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

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 '
{
  "taxIdNumber": "12345678901",
  "fraudType": "MULE_ACCOUNT",
  "key": "fraud@example.com"
}
'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/fraud-markers"

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

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    taxIdNumber: '12345678901',
    fraudType: 'MULE_ACCOUNT',
    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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/dict/fraud-markers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'taxIdNumber' => '12345678901',
    'fraudType' => 'MULE_ACCOUNT',
    'key' => 'fraud@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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  \"taxIdNumber\": \"12345678901\",\n  \"fraudType\": \"MULE_ACCOUNT\",\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))

}

HttpResponse<String> response = Unirest.post("https://plugin-pix-indirect.api.lerian.net/v1/dict/fraud-markers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"taxIdNumber\": \"12345678901\",\n  \"fraudType\": \"MULE_ACCOUNT\",\n  \"key\": \"fraud@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/dict/fraud-markers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"taxIdNumber\": \"12345678901\",\n  \"fraudType\": \"MULE_ACCOUNT\",\n  \"key\": \"fraud@example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "019c96a0-0cfd-7d0d-8fc5-17a164b828b6",
  "document": "12345678901",
  "fraudType": "MULE_ACCOUNT",
  "key": "fraud@example.com",
  "status": "REGISTERED",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

taxIdNumber

string

required

CPF or CNPJ of the person/entity being marked.

Example:

"12345678901"

fraudType

enum<string>

required

Type of fraud.

Available options:

APPLICATION_FRAUD,

MULE_ACCOUNT,

SCAMMER_ACCOUNT,

OTHER

Example:

"MULE_ACCOUNT"

key

string

Optional Pix key associated with the fraud.

Example:

"fraud@example.com"

Response

Fraud marker created successfully.

string

Unique identifier.

Example:

"019c96a0-0cfd-7d0d-8fc5-17a164b828b6"

document

string

CPF or CNPJ.

Example:

"12345678901"

fraudType

enum<string>

Type of fraud.

Available options:

APPLICATION_FRAUD,

MULE_ACCOUNT,

SCAMMER_ACCOUNT,

OTHER

Example:

"MULE_ACCOUNT"

key

string

Associated Pix key.

Example:

"fraud@example.com"

status

enum<string>

Current status.

Available options:

REGISTERED,

CANCELLED

Example:

"REGISTERED"

createdAt

string<date-time>

Example:

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

updatedAt

string<date-time>

Example:

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

Cancel a Fraud Marker

List Fraud Markers

⌘I

Lerian SPB

Lerian SPI

Lerian SILOC

Lerian SLC

Lerian STA

Lerian SISBAJUD

Lerian Consignado

Pix — Direct via JD

Pix — Indirect via BTG

TED — via JD

Payments — via BTG

Create a Fraud Marker

Authorizations

Body

Response