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

# Archive a Beneficiary

> Removes a Beneficiary from the address book: it stops appearing in `GET /v1/beneficiaries` and the CSV export, new Payouts to it are refused with BENEFICIARY_ARCHIVED, and every live collection link is cancelled. Nothing is deleted — `GET /v1/beneficiaries/{id}` still resolves it with `archived_at` set so a Payout's payee stays lookup-able, Payouts already in flight still disburse, and the compliance evidence is retained. The email address is freed, so the same payee can be registered again. Idempotent: re-archiving is a success no-op.



## OpenAPI

````yaml DELETE /v1/beneficiaries/{id}
openapi: 3.0.0
info:
  title: Cleff API
  description: >-
    Payout orchestration platform. All endpoints under /v1/ require an API key
    in the Authorization header (Bearer ck_<env>_<id>_<secret>).
  version: 0.0.1
  contact: {}
servers: []
security: []
tags: []
paths:
  /v1/beneficiaries/{id}:
    delete:
      tags:
        - Beneficiaries
      summary: Archive a Beneficiary
      description: >-
        Removes a Beneficiary from the address book: it stops appearing in `GET
        /v1/beneficiaries` and the CSV export, new Payouts to it are refused
        with BENEFICIARY_ARCHIVED, and every live collection link is cancelled.
        Nothing is deleted — `GET /v1/beneficiaries/{id}` still resolves it with
        `archived_at` set so a Payout's payee stays lookup-able, Payouts already
        in flight still disburse, and the compliance evidence is retained. The
        email address is freed, so the same payee can be registered again.
        Idempotent: re-archiving is a success no-op.
      operationId: BeneficiariesController_archive
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
      responses:
        '204':
          description: Archived (or already archived — idempotent)
        '401':
          description: Missing or invalid credentials
        '404':
          description: Beneficiary not found
      security:
        - api_key: []
components:
  securitySchemes:
    api_key:
      scheme: bearer
      bearerFormat: ck_<env>_<id>_<secret>
      type: http
      description: >-
        Cleff API key issued to a Business that self-registers via POST
        /v1/registration

````