Skip to main content
POST
/
v1
/
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"
}
'
{
  "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.

​
id
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"