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

# Remove a previously registered legado loan

> Proxies excluir-emprestimo-legado-trabalhador (Manual 007 v1.4 §3.2, PUT — never DELETE), restoring the worker's eligibility for new contracting on this rail. motivoExclusao is a closed, non-contiguous set (1,2,3,7,8,9 — the manual's own apêndice §4.1 has no 4, 5 or 6). X-Idempotency is required. A retried request that lands on the rail's own HY ("empréstimo inexistente") answers success rather than a refusal.



## OpenAPI

````yaml en/openapi/v3-current/consignado.yaml put /v1/consignado/legacy-contracts/{numero_contrato}
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    OpenAPI 3.1 surface for Lerian Consignado — Dataprev. The API covers tenant
    credentials and rail configuration, worker margin, loan auctions and bids,
    contract registration and lifecycle, disbursement confirmation, portability,
    refinancing, renegotiation, FGTS guarantees, reconciliation, funds,
    assignments, usage, throughput, and event subscriptions. Secret material is
    written to the tenant secret store and is never returned by any operation.
  license:
    name: Lerian Studio General License
  title: Lerian Consignado API
  version: v1.0.0
servers:
  - url: https://consignado.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Per-tenant Dataprev credential custody and public rail configuration
      (upload, status, rotation, revoke, requester code, and worker portal base
      URL)
    name: Credentials
  - description: >-
      Tenant-scoped consignado gateway usage: priced billable-unit aggregation
      per competência
    name: Consignado Usage
  - description: >-
      Per-tenant streaming-hub subscription control-plane (list, create, get,
      rotate, revoke, and test delivery)
    name: Subscriptions
  - description: >-
      Dataprev payroll-rail surface: FGTS balance and authorization reads, the
      FGTS guarantee execution, contract suspension, reactivation and term
      changes, the rail's own contract documents, and the on-demand reads of
      leilão solicitações, escriturações, repasses and employment terminations
    name: Consignado Rail
  - description: >-
      Synchronous rail command surface: the operations a bancarizador without
      the lender drives over HTTP. Each shares its command implementation with
      the equivalent lender event trigger.
    name: Consignado Rail Commands
  - description: >-
      Gateway-owned disbursement confirmation: a client bank recording money it
      has ALREADY paid to a worker. It crosses no government boundary and
      proxies no Dataprev operation.
    name: Consignado Disbursement
  - description: >-
      Per-tenant self-service outbound Dataprev rail throughput: read and set
      this tenant's own requests-per-second, including a deliberate pause at
      zero
    name: Consignado Throughput
paths:
  /v1/consignado/legacy-contracts/{numero_contrato}:
    put:
      tags:
        - Consignado Rail
      summary: Remove a previously registered legado loan
      description: >-
        Proxies excluir-emprestimo-legado-trabalhador (Manual 007 v1.4 §3.2, PUT
        — never DELETE), restoring the worker's eligibility for new contracting
        on this rail. motivoExclusao is a closed, non-contiguous set
        (1,2,3,7,8,9 — the manual's own apêndice §4.1 has no 4, 5 or 6).
        X-Idempotency is required. A retried request that lands on the rail's
        own HY ("empréstimo inexistente") answers success rather than a refusal.
      operationId: excluirConsignadoEmprestimoLegado
      parameters:
        - description: Number of the legado contract to remove.
          in: path
          name: numero_contrato
          required: true
          schema:
            description: Number of the legado contract to remove.
            examples:
              - 99999999999AL1
            maxLength: 20
            minLength: 1
            type: string
        - description: >-
            Client-chosen idempotency key. REQUIRED: an absent key is 422, never
            a generated default.
          in: header
          name: X-Idempotency
          required: true
          schema:
            description: >-
              Client-chosen idempotency key. REQUIRED: an absent key is 422,
              never a generated default.
            examples:
              - idem-legado-excluir-0001
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LegadoExcluirBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegadoOperationResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    LegadoExcluirBody:
      additionalProperties: false
      properties:
        cpfTrabalhador:
          description: Worker CPF, exactly 11 digits.
          examples:
            - '99999999999'
          pattern: ^[0-9]{11}$
          type: string
        motivoExclusao:
          description: >-
            Reason for the exclusion: 1 desistência, 2 falecimento, 3 liquidação
            antecipada, 7 ação judicial, 8 fraude, 9 outros. The set has holes
            at 4, 5 and 6 — the manual's own apêndice §4.1.
          enum:
            - 1
            - 2
            - 3
            - 7
            - 8
            - 9
          examples:
            - 9
          format: int64
          type: integer
      required:
        - cpfTrabalhador
        - motivoExclusao
      type: object
    LegadoOperationResponse:
      additionalProperties: false
      properties:
        idempotent:
          description: >-
            True when the rail answered its own HX (incluir)/HY (excluir)
            idempotency code rather than fresh confirmation. On excluir (HY)
            this means the contract is confirmed gone, which is sound. On
            incluir (HX) it means ONLY that this numeroContrato is already
            registered on the rail — the values THIS request carried
            (valorEmprestimo, valorParcela, etc.) were NOT compared against what
            is stored. To correct a legado registered with wrong values, exclude
            it (motivo 9) and include it again; do not rely on idempotent:true
            as proof the stored values match.
          examples:
            - false
          type: boolean
        mensagem:
          description: The rail's own message.
          examples:
            - Emprestimo legado incluido com sucesso
          type: string
        numeroContrato:
          description: The contract number the rail confirmed the operation against.
          examples:
            - 99999999999AL1
          type: string
      required:
        - mensagem
        - numeroContrato
        - idempotent
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          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
    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

````