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

# Invite Beneficiaries to submit details

> Batch-capable (1..N). Mints a scoped collection token per Beneficiary, advances each to `invited`, and enqueues a tokenized email to a Cleff-hosted form on the collect surface. A resend invalidates the prior link. The dashboard single-invite action is N=1 through this endpoint.



## OpenAPI

````yaml POST /v1/beneficiaries/collection-invites
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/collection-invites:
    post:
      tags:
        - Beneficiaries
      summary: Invite Beneficiaries to submit their details
      description: >-
        Batch-capable (1..N). Mints a scoped collection token per Beneficiary,
        advances each to `invited`, and enqueues a tokenized email to a
        Cleff-hosted form on the collect surface. A resend invalidates the prior
        link. The dashboard single-invite action is N=1 through this endpoint.
      operationId: BeneficiariesController_inviteToCollect
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCollectionInvitesDto'
      responses:
        '202':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionInviteResponseDto'
        '401':
          description: Missing or invalid credentials
        '404':
          description: A targeted Beneficiary was not found
      security:
        - api_key: []
components:
  schemas:
    CreateCollectionInvitesDto:
      type: object
      properties:
        beneficiary_ids:
          description: Beneficiary ids to invite (1..N).
          type: array
          items:
            type: string
        scope:
          type: string
          enum:
            - full_onboarding
            - bank_details
            - tax_documents
          description: >-
            How much of onboarding the link collects. Defaults to
            full_onboarding.
        message:
          type: string
          description: >-
            Optional free-text note from the sender, included in the invite
            email.
          maxLength: 1000
        display_name:
          type: string
          description: >-
            Optional 'name to show on the request': the name the recipient sees
            on the collect surface and invite email. When omitted, falls back to
            the inviting Business's display_name, then its legal_name. Same
            value for every beneficiary in the batch.
          maxLength: 200
      required:
        - beneficiary_ids
    CollectionInviteResponseDto:
      type: object
      properties:
        invited:
          description: Beneficiary ids that were invited.
          type: array
          items:
            type: string
      required:
        - invited
  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

````