> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/fraud-markers
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    API for Pix Indirect via BTG. It covers DICT keys and claims; MED infraction
    reports, fraud markers, refund requests, and funds recoveries; DICT
    statistics and reconciliation; Pix transfers, refunds, and schedules; static
    QR codes and QR code decoding; immediate and due-date collections; Pix
    Automático for the payer; transaction reports and TemposTransacoes
    statistics; and inbound and outbound webhook records.
  license:
    name: Lerian Studio General License
  title: Pix BTG API
  version: 1.14.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
paths:
  /v1/dict/fraud-markers:
    post:
      tags:
        - Fraud Markers
      summary: Create a Fraud Marker
      description: >-
        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.
      operationId: dict-create-fraud-marker
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFraudMarkerInput'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FraudMarkerOutput'
          description: Created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Bad Request
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Request Entity Too Large
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Internal Server Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Error
components:
  schemas:
    CreateFraudMarkerInput:
      additionalProperties: false
      properties:
        fraudType:
          description: Classification of the type of fraud
          enum:
            - APPLICATION_FRAUD
            - MULE_ACCOUNT
            - SCAMMER_ACCOUNT
            - OTHER
          examples:
            - MULE_ACCOUNT
          minLength: 1
          type: string
        key:
          description: >-
            Pix key value associated with the fraudulent activity (8-32
            characters)
          examples:
            - fraud@example.com
          maxLength: 32
          minLength: 8
          type: string
        taxIdNumber:
          description: CPF or CNPJ of the person or entity being marked for fraud
          examples:
            - '52998224725'
          minLength: 1
          type: string
      required:
        - taxIdNumber
        - fraudType
      type: object
    FraudMarkerOutput:
      additionalProperties: false
      properties:
        createdAt:
          description: Timestamp when the fraud marker was created (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        deletedAt:
          description: Timestamp when the fraud marker was soft-deleted (ISO 8601 UTC)
          examples:
            - '2024-01-20T14:45:00Z'
          format: date-time
          type:
            - string
            - 'null'
        document:
          description: CPF or CNPJ of the person or entity marked for fraud
          examples:
            - '52998224725'
          type: string
        fraudType:
          description: Classification of the type of fraud
          enum:
            - APPLICATION_FRAUD
            - MULE_ACCOUNT
            - SCAMMER_ACCOUNT
            - OTHER
            - UNKNOWN
          examples:
            - MULE_ACCOUNT
          type: string
        id:
          description: Unique identifier of the fraud marker (UUID)
          examples:
            - 550e8400-e29b-41d4-a716-44665544f999
          type: string
        infractionReport:
          $ref: '#/components/schemas/FraudMarkerInfractionReport'
          description: Reference to the infraction report that originated this fraud marker
        key:
          description: Pix key value associated with the fraud marker
          examples:
            - fraud@example.com
          type:
            - string
            - 'null'
        status:
          description: Current operational status of the fraud marker
          enum:
            - REGISTERED
            - CANCELLED
          examples:
            - REGISTERED
          type: string
        updatedAt:
          description: Timestamp when the fraud marker was last updated (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
      required:
        - id
        - document
        - key
        - fraudType
        - status
        - infractionReport
        - createdAt
        - updatedAt
        - deletedAt
      type: object
    LegacyErrorBody:
      additionalProperties: false
      properties:
        code:
          type: string
        fields:
          additionalProperties:
            type: string
          type: object
        headers:
          additionalProperties:
            type: string
          type: object
        message:
          type: string
        paths:
          additionalProperties:
            type: string
          type: object
        queryParams:
          additionalProperties:
            type: string
          type: object
        raw:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    FraudMarkerInfractionReport:
      additionalProperties: false
      properties:
        id:
          description: Unique identifier of the related infraction report (UUID)
          examples:
            - 550e8400-e29b-41d4-a716-446655440001
          type: string
        reporterParticipant:
          description: >-
            ISPB of the participant that filed the infraction report (8
            uppercase alphanumeric characters)
          examples:
            - '12345678'
          type: string
      required:
        - id
        - reporterParticipant
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.