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

# Erase a direct order (LGPD)

> Crypto-shreds one direct order: its intake (every revision's sealed body and DEK; clientOrderId and externalReference become keyed tokens, the normative keys stay so a resubmission is never a new order), its execution_order revisions and its block rows, in ONE transaction with the audit row (event LGPD_CRYPTO_ELIMINATION, entity EXECUTION_ORDER). If the audit write fails nothing is erased. The execution journal and the result outbox keep their pseudonymous residue (ids and amounts): an append-only accounting and audit record. A human platform-administrator action (direct_order_erasure:erase, never held by M2M): an application token (SBJ-0044) or a tenant-carrying token (SBJ-0045) is refused with 403. 200 outcome noop: already erased (audited again). 404 SBJ-0015: unknown order, or one of an institution this executor does not own. 409 SBJ-0056: not eligible (the purge-eligibility predicate, or a child whose parent is not erased). 409 SBJ-0057: permanent block in force, or its end unreadable. 422 SBJ-0058: reason, ticket or note invalid. 422 SBJ-0059: multi-tenant deployment.



## OpenAPI

````yaml /en/openapi/v3-current/sisbajud-executor.yaml post /v1/admin/direct/orders/{orderId}/erase
openapi: 3.1.0
info:
  description: >-
    API for Plugin SISBAJUD, which runs judicial orders on Midaz. It covers
    institution and Midaz connector configuration, orders that need attention,
    ledger-routing checks, credential key rotation and audit verification.
  title: Plugin SISBAJUD API
  version: 1.0.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: >-
      Institution configuration lifecycle: create (with key provisioning), read,
      and partial update of a connector configuration addressed by institution
      id.
    name: Institution
  - description: >-
      Rotation of the key that wraps an institution's stored connector
      credentials, addressed by institution id.
    name: Security
  - description: 'Admin API: audit-trail integrity verification.'
    name: Admin
paths:
  /v1/admin/direct/orders/{orderId}/erase:
    post:
      tags:
        - Direct Channel Administration
      summary: Erase a direct order (LGPD)
      description: >-
        Crypto-shreds one direct order: its intake (every revision's sealed body
        and DEK; clientOrderId and externalReference become keyed tokens, the
        normative keys stay so a resubmission is never a new order), its
        execution_order revisions and its block rows, in ONE transaction with
        the audit row (event LGPD_CRYPTO_ELIMINATION, entity EXECUTION_ORDER).
        If the audit write fails nothing is erased. The execution journal and
        the result outbox keep their pseudonymous residue (ids and amounts): an
        append-only accounting and audit record. A human platform-administrator
        action (direct_order_erasure:erase, never held by M2M): an application
        token (SBJ-0044) or a tenant-carrying token (SBJ-0045) is refused with
        403. 200 outcome noop: already erased (audited again). 404 SBJ-0015:
        unknown order, or one of an institution this executor does not own. 409
        SBJ-0056: not eligible (the purge-eligibility predicate, or a child
        whose parent is not erased). 409 SBJ-0057: permanent block in force, or
        its end unreadable. 422 SBJ-0058: reason, ticket or note invalid. 422
        SBJ-0059: multi-tenant deployment.
      operationId: erase-direct-order
      parameters:
        - description: The direct order's identifier (UUID).
          in: path
          name: orderId
          required: true
          schema:
            description: The direct order's identifier (UUID).
            examples:
              - 0b9b7c2e-4f8a-4d3e-9a51-7c2d1e0f3a44
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DirectOrderEraseRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectOrderEraseResponse'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Not Found
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Conflict
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Request Entity Too Large
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Too Many Requests
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Service Unavailable
components:
  schemas:
    DirectOrderEraseRequest:
      additionalProperties: false
      properties:
        note:
          description: >-
            Optional note (at most 256 characters, no personal data). Stored
            sealed in the audit trail; never echoed when refused.
          examples:
            - DPO request routed by the institution.
          type: string
        reason:
          description: >-
            Required: lgpd-subject-request (a data subject's request) or
            retention-purge (retention ended).
          examples:
            - lgpd-subject-request
          type: string
        ticket:
          description: >-
            Required: the request id the erase is filed under (at most 64
            characters, no personal data). Stored sealed in the audit trail.
          examples:
            - LGPD-2026-0042
          type: string
      type: object
    DirectOrderEraseResponse:
      additionalProperties: false
      properties:
        erasedAt:
          description: Instant of the request (UTC).
          format: date-time
          type: string
        erasedBy:
          description: Subject of the platform administrator who made the request.
          type: string
        orderId:
          description: The direct order's identifier.
          type: string
        outcome:
          description: >-
            erased: this request erased the order. noop: it was already erased
            (audited again).
          enum:
            - erased
            - noop
          type: string
        rows:
          $ref: '#/components/schemas/DirectOrderEraseRows'
          description: Rows shredded beyond the intake.
      required:
        - orderId
        - outcome
        - rows
        - erasedBy
        - erasedAt
      type: object
    Detail:
      additionalProperties: true
      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.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          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.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    ErrorResponse:
      additionalProperties: false
      properties:
        code:
          type: string
        details:
          additionalProperties: {}
          type: object
        message:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    DirectOrderEraseRows:
      additionalProperties: false
      properties:
        dailyAttempt:
          description: permanent_block_daily_attempt rows erased.
          format: int64
          type: integer
        executionOrder:
          description: execution_order revisions erased.
          format: int64
          type: integer
        judicialBlock:
          description: judicial_order_block rows erased.
          format: int64
          type: integer
        permanentBlock:
          description: permanent_block_order rows erased.
          format: int64
          type: integer
      required:
        - executionOrder
        - permanentBlock
        - dailyAttempt
        - judicialBlock
      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
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      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.