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

# Register a holder-ownership removal

> Severs a holder's ownership of a transactional account, making the DICT bulk-delete every Pix key bound to that holder and account. Returns the per-key deletion outcomes.



## OpenAPI

````yaml en/openapi/v3-current/pix.yaml POST /v1/holder-removals
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/holder-removals:
    post:
      tags:
        - Key DICT API
      summary: Register a holder-ownership removal
      description: >-
        Severs a holder's ownership of a transactional account, making the DICT
        bulk-delete every Pix key bound to that holder and account. Returns the
        per-key deletion outcomes.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HolderRemovalBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HolderRemovalResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    HolderRemovalBody:
      additionalProperties: false
      properties:
        account:
          description: The account number.
          type: string
        accountId:
          description: The CRM account id of the caller (resolves the server-side ISPB).
          type: string
        accountType:
          description: The account type (0=Checking,1=Salary,2=Savings,3=Payment,4=PI).
          format: int64
          type: integer
        branch:
          description: The branch number of the account.
          type: string
        document:
          description: The target holder document (CPF/CNPJ).
          type: string
        personType:
          description: The target holder person type (0=Person,1=Corporate).
          format: int64
          type: integer
      required:
        - accountId
        - accountType
        - account
        - personType
        - document
      type: object
    HolderRemovalResponse:
      additionalProperties: false
      properties:
        deletedKeys:
          description: The per-key deletion outcomes.
          items:
            $ref: '#/components/schemas/DeletedKeyView'
          type: array
          nullable: true
      required:
        - deletedKeys
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          format: uri
          type: string
        status:
          description: HTTP status code
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          format: uri
          type: string
      type: object
    DeletedKeyView:
      additionalProperties: false
      properties:
        document:
          description: The key owner document (account-closure only).
          type: string
        key:
          description: The deleted Pix key value.
          type: string
        name:
          description: The key owner name (account-closure only).
          type: string
        reason:
          description: The deletion reason code.
          format: int64
          type: integer
        result:
          description: Deletion result (0=not deleted,1=deleted).
          format: int64
          type: integer
        resultDescription:
          description: The failure reason when result=0.
          type: string
      required:
        - key
        - reason
        - result
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        JWT Bearer token authentication. Obtain token from
        `/v1/login/oauth/access_token` endpoint

        using client credentials (clientId and clientSecret).


        Include token in Authorization header:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        Token expires after 3600 seconds (1 hour).

````