Cancel a Fraud Marker

Use this endpoint to cancel a previously registered fraud marker.

Notes:

• Cancellation is only allowed for markers in REGISTERED status.
• Only the participant who created the fraud marker can cancel it.
• For fraud markers created from infraction report closures, the counterparty participant who closed the infraction can cancel the marker.
• Cancelled markers cannot be reactivated.

POST /v1/dict/fraud-markers/{fraud_marker_id}/cancel

Cancel a Fraud Marker

cURL

curl --request POST \
  --url https://api.example.com/v1/dict/fraud-markers/{fraud_marker_id}/cancel \
  --header 'Authorization: Bearer <token>'

200

{
  "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": "[e-mail]",
  "status": "REGISTERED",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

fraud_marker_id · string<uuid> · requerido

Fraud Marker ID (UUID format)

Respuesta

200

application/json

OK

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"

id · 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:

"[e-mail]"

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"