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

# Add a beneficiary

> Adds a beneficiary under the association resolved from the token.



## OpenAPI

````yaml /api-reference/openapi.yaml post /beneficiaries
openapi: 3.1.0
info:
  title: Zeam API Gateway
  version: 1.0.0
  description: >
    The Zeam API Gateway is the single, REST-based external surface for
    registered

    integrators. Every protected request carries a bearer access token (issued
    by the

    Zeam Auth Service) plus the application secret header `x-zeam-auth`. The
    gateway

    verifies the token, resolves the caller's association, and
    proxies/orchestrates the

    underlying Zeam services. Errors use RFC 7807 `application/problem+json`.
  license:
    name: Proprietary
    url: https://zeam.app
  contact:
    name: Zeam Platform Team
    url: https://zeam.app
servers:
  - url: https://api.zeam.app/v1
    description: Production
  - url: https://api.dev.zeam.paytec.io/v1
    description: Development
security:
  - BearerAuth: []
    ZeamAuth: []
tags:
  - name: Auth
    description: Public token issuance.
  - name: Wallets
    description: Association wallets, balances, and transactions.
  - name: Beneficiaries
    description: Association beneficiaries.
  - name: Connectors
    description: Connector discovery (Connect, surfaced as REST).
  - name: Quotes
    description: Connect quotes.
  - name: Intents
    description: Transaction intent initiation and state.
  - name: Payments
    description: Payment intent execution via Hydra.
  - name: Webhooks
    description: Association webhook registrations.
paths:
  /beneficiaries:
    post:
      tags:
        - Beneficiaries
      summary: Add a beneficiary
      description: Adds a beneficiary under the association resolved from the token.
      operationId: addBeneficiary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBeneficiaryRequest'
            example:
              reference: ACME-001
              beneficiaryType: Business
              displayName: Acme Ltd
      responses:
        '201':
          description: Beneficiary created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Beneficiary'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
        '502':
          $ref: '#/components/responses/UpstreamError'
components:
  schemas:
    CreateBeneficiaryRequest:
      type: object
      required:
        - reference
        - beneficiaryType
      properties:
        reference:
          type: string
        beneficiaryType:
          type: string
          enum:
            - Individual
            - Business
        displayName:
          type: string
    Beneficiary:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          format: uuid
        reference:
          type: string
        beneficiaryType:
          type: string
          enum:
            - Individual
            - Business
        displayName:
          type: string
    Problem:
      type: object
      required:
        - type
        - title
        - status
      description: RFC 7807 problem details.
      properties:
        type:
          type: string
          format: uri
          example: https://errors.zeam.app/validation-error
        title:
          type: string
          example: Validation Error
        status:
          type: integer
          example: 422
        detail:
          type: string
          example: The 'amount' field must be a positive decimal.
        instance:
          type: string
          example: /v1/quotes
        requestId:
          type: string
          example: 01J8Z6K3QW9F2
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
  responses:
    BadRequest:
      description: Malformed request.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: Missing or invalid authentication.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: Authenticated but not permitted.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ValidationError:
      description: Request failed validation.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    UpstreamError:
      description: A downstream service returned an unexpected error.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token issued by POST /v1/auth/token.
    ZeamAuth:
      type: apiKey
      in: header
      name: x-zeam-auth
      description: Application secret (Kong apiKey) issued at registration.

````