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

# Remove tag objects

> Remove tag mappings for the specified tags and objects.

Tag IDs are validated against the customer's accessible tags. If any tag ID does not exist or
belongs to a different customer, the entire request fails.

If an object has no mappings for the given tags, the operation succeeds and that object appears
in the response with an empty `tags` array.

Duplicate `tagIds` or `objects` in the request are deduplicated before processing.

An optional `comment` can be included.




## OpenAPI

````yaml /specs/fc-core-bundled_generated.yaml post /v2/tags/objects/remove
openapi: 3.0.3
info:
  title: Core V2 API
  version: 2.0.0
  description: >-
    This is the APIs for V2 Core. It allows you to do common operations, such as
    read audit entries or get workflow lists.
  contact:
    name: FrankieOne
    url: https://www.frankieone.com/
    email: help@frankieone.com
servers:
  - url: https://api.uat.frankie.one
    description: UAT Environment API Base URL
  - url: https://api.frankie.one
    description: Production API Base URL
security:
  - Api-Key: []
tags:
  - name: Audit
    description: Manage audit entries
  - name: Customers
    description: Manage customer accounts
  - name: Users
    description: Manage users provisioned in child customer accounts
  - name: Request
    description: Retrieve background request results
  - name: Reports
    description: Generate and manage reports
  - name: Results
    description: Manage process results including redaction
  - name: Workflow Definitions
    description: Create and update workflow definitions
  - name: Status
    description: All valid customers will get a successful response.
  - name: Workflows
    description: Manage Workflows and Workflow Definitions
  - name: Tags
    description: Query tags and tag mappings on objects
paths:
  /v2/tags/objects/remove:
    post:
      tags:
        - Tags
      summary: Remove tag objects
      description: >
        Remove tag mappings for the specified tags and objects.


        Tag IDs are validated against the customer's accessible tags. If any tag
        ID does not exist or

        belongs to a different customer, the entire request fails.


        If an object has no mappings for the given tags, the operation succeeds
        and that object appears

        in the response with an empty `tags` array.


        Duplicate `tagIds` or `objects` in the request are deduplicated before
        processing.


        An optional `comment` can be included.
      operationId: removeTagsObjects
      parameters:
        - $ref: '#/components/parameters/Api-Key'
        - $ref: '#/components/parameters/X-Frankie-CustomerID'
        - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
        - $ref: '#/components/parameters/X-Frankie-Channel'
        - $ref: '#/components/parameters/X-Frankie-Username'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Remove-Tag-Objects-Request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - requestId
                  - untaggedObjects
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  untaggedObjects:
                    type: array
                    description: >-
                      Objects that had their tag mappings removed, including the
                      removed tags.
                    items:
                      $ref: '#/components/schemas/Tag-Mapped-Object'
        '400':
          description: Bad Request — invalid input or inaccessible tag IDs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - Api-Key: []
components:
  parameters:
    Api-Key:
      name: api_key
      in: header
      schema:
        type: string
        example: 245c765b124a098d09ef8765....
      description: Your API key provided by FrankieOne
      required: true
    X-Frankie-CustomerID:
      name: X-Frankie-CustomerID
      in: header
      required: true
      schema:
        type: string
        example: 12345678-1234-1234-1234-123456789012
      description: Your Customer ID provided by FrankieOne
    X-Frankie-CustomerChildID:
      name: X-Frankie-CustomerChildID
      in: header
      required: false
      schema:
        type: string
        example: 87654321-4321-4321-4321-210987654321
      description: Your Customer Child ID provided by FrankieOne
    X-Frankie-Channel:
      name: X-Frankie-Channel
      in: header
      required: false
      schema:
        type: string
      description: >-
        Open string that can be used to define the "channel" the request comes
        in from. It can potentially be used in routing and risk calculations
        upon request. Default values that can be used are:  api portal smartui
        Any alphanumeric string is supported though. Anything over 64 characters
        will be truncated.
    X-Frankie-Username:
      name: X-Frankie-Username
      in: header
      description: Username provided by API caller
      required: false
      schema:
        type: string
        example: fred.flintstone@frankieone.com
  schemas:
    Remove-Tag-Objects-Request:
      type: object
      description: Request to remove tag mappings from one or more objects.
      required:
        - tagIds
        - objects
      properties:
        tagIds:
          type: array
          description: >-
            IDs of the tags to remove from the specified objects. All tag IDs
            must exist and be accessible to the customer — if any are invalid or
            belong to a different tenant, the entire request fails with no
            partial deletions (atomic failure).
          minItems: 1
          items:
            type: string
            format: uuid
          example:
            - 12345678-1234-1234-1234-123456789012
            - 87654321-4321-4321-4321-210987654321
        objects:
          type: array
          description: Objects from which to remove the specified tag mappings.
          minItems: 1
          items:
            $ref: '#/components/schemas/Tag-Object'
        comment:
          $ref: '#/components/schemas/Comment'
          description: Optional comment to be recorded in the audit log for this action.
    Request-ID:
      type: string
      example: 01HN9XHZN6MGXM9JXG50K59Q85
      description: The unique request identifier for the API call made.
    Tag-Mapped-Object:
      type: object
      description: An object and the tags mapped to it.
      required:
        - objectId
        - objectType
        - tags
      properties:
        objectId:
          type: string
          description: ID of the object (may be ULID or UUID).
          example: 12345678-1234-1234-1234-123456789012
        objectType:
          $ref: '#/components/schemas/Object-Type'
        tags:
          type: array
          description: >-
            Tags applied to this object, sorted by mapping createdAt descending
            (newest first).
          items:
            $ref: '#/components/schemas/Tag-Mapping'
    Error:
      type: object
      x-examples:
        '400':
          requestId: 0123456789ABCDEFGHIJKLMNOP
          errorCode: API-0400
          errorMsg: Parsing credentials from "<invalid>" failed, because invalid.
          httpStatusCode: 400
        '401':
          requestId: 0123456789ABCDEFGHIJKLMNOP
          errorCode: API-0401
          errorMsg: Unauthenticated due to invalid credentials.
          httpStatusCode: 401
        '409':
          requestId: 0123456789ABCDEFGHIJKLMNOP
          errorCode: API-0409
          errorMsg: Conflict.
          httpStatusCode: 409
      allOf:
        - $ref: '#/components/schemas/Error-Base'
        - type: object
          properties:
            requestId:
              $ref: '#/components/schemas/Request-ID'
    Tag-Object:
      type: object
      description: An object identified by its ID and type.
      required:
        - objectId
        - objectType
      properties:
        objectId:
          type: string
          description: ID of the object (may be ULID or UUID).
          example: 12345678-1234-1234-1234-123456789012
        objectType:
          $ref: '#/components/schemas/Object-Type'
    Comment:
      type: object
      properties:
        commentId:
          type: string
          description: Unique identifier for the comment
          format: ulid
          example: 01K3G4CCQ3DY3B1413S19M9QW1
          readOnly: true
        text:
          type: string
          description: The text content of the comment.
          example: Update after speaking to customer over the phone directly.
        entityId:
          $ref: '#/components/schemas/Entity-ID-Writeable'
        entityType:
          $ref: '#/components/schemas/Entity-Type-Writeable'
    Object-Type:
      description: The type of object being annotated.
      type: string
      enum:
        - ADDRESS
        - NAME
        - PHONE_NUMBER
        - EMAIL
        - DATE_OF_BIRTH
        - WEBSITE
        - SHAREHOLDER
        - OFFICIAL
        - UBO
        - REGISTRATION
        - SHAREHOLDING
        - SHARECAPITAL
        - DOCUMENT
        - DOCUMENT_ATTACHMENT
        - RESULT_PROCESS
        - RESULT_STEP
        - RESULT_WORKFLOW
        - SERVICE_PROFILE
        - AUDIT_EVENT
        - EXTERNAL_REFERENCE
        - RISK_ASSESSMENT
        - MATCHLIST
        - CUSTOMER
        - CUSTOMER_KEY
        - SERVICE
        - SECRET
        - USER
        - ACTIVITY
        - CASE
    Tag-Mapping:
      type: object
      description: >-
        A tag applied to an object, including the identifier for the specific
        mapping.
      required:
        - mappingId
      allOf:
        - $ref: '#/components/schemas/Tag-Base'
        - type: object
          properties:
            mappingId:
              type: string
              format: uuid
              description: Unique identifier for this tag-to-object mapping.
              example: 12345678-1234-1234-1234-123456789012
              readOnly: true
    Error-Base:
      type: object
      properties:
        errorCode:
          type: string
        errorMsg:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
    Entity-ID-Writeable:
      type: string
      description: >-
        Entities are assigned a FrankieOne auto-generated UUID to ensure global
        uniqueness, represented as entityId. The entityId allows for precise
        modification when required.

        To modify an entity, set the entityId of the entity you wish to update
        in an update request.
      example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
    Entity-Type-Writeable:
      type: string
      enum:
        - INDIVIDUAL
        - ORGANIZATION
        - UNKNOWN
      description: >-
        The type of entity within Frankie. This can be "INDIVIDUAL",
        "ORGANIZATION", or "UNKNOWN".
    Tag-Base:
      type: object
      required:
        - tagId
        - label
      properties:
        tagId:
          type: string
          format: uuid
          description: Unique identifier for the tag.
          example: 12345678-1234-1234-1234-123456789012
          readOnly: true
        label:
          type: string
          description: Human-readable name for the tag.
          example: ROMANCE_SCAM
        description:
          type: string
          description: Optional description for the tag.
          example: Indicates a potential romance scam.
        category:
          type: string
          description: Category used to group tags.
          example: FRAUD
        type:
          $ref: '#/components/schemas/Tag-Type'
        domain:
          type: string
          description: Optional domain context for the tag.
          example: ACTIVITY_MONITORING
    Issue:
      type: object
      properties:
        issue:
          type: string
          description: Description of the issue.
        issueLocation:
          type: string
          description: The location or context where the issue was identified.
        issueType:
          type: string
          description: The type or category of the issue.
    Tag-Type:
      description: >
        The type of the tag.

        - SYSTEM: A tag created by FrankieOne. The `createdBy` and `updatedBy`
        fields will be omitted for SYSTEM tags.

        - CUSTOMER: A tag created by the customer.
      type: string
      enum:
        - SYSTEM
        - CUSTOMER
  securitySchemes:
    Api-Key:
      type: apiKey
      in: header
      name: api_key
      description: ''

````