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

# Update a beneficiary

> Updates a beneficiary using merge semantics. Only fields present in the
body are changed. `beneficiaryType` must be echoed from a prior Get even
when you are not changing it. Payment destinations are not touched by
this route — use the payment-destinations sub-resource instead.




## OpenAPI

````yaml /api-reference/openapi.yaml patch /beneficiaries/{beneficiaryId}
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) and the application secret header `x-zeam-auth`. The
    gateway

    verifies the token and resolves the caller's association server-side — you
    do not

    need to supply an association id header. 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.money/gw/v1
    description: >-
      Zeam API Gateway. The sandbox and production environments share this base
      URL; your application's registration determines which one a request runs
      in.
security:
  - BearerAuth: []
    ZeamAuth: []
tags:
  - name: Auth
    description: Public token issuance.
  - name: Wallets
    description: Association wallets with embedded balances.
  - name: Assets
    description: Platform asset registry.
  - name: Beneficiaries
    description: Association beneficiaries and their payment destinations.
  - name: Connectors
    description: Connector discovery (Connect, surfaced as REST).
  - name: Quotes
    description: Off-ramp quotes.
  - name: Payments
    description: >-
      P2P transfers, swaps, and off-ramp cash-outs, plus the compliance
      reference lookups used when building an off-ramp.
  - name: Transactions
    description: Transaction records, the polling and history complement to webhooks.
  - name: Webhooks
    description: Association webhook registrations.
paths:
  /beneficiaries/{beneficiaryId}:
    patch:
      tags:
        - Beneficiaries
      summary: Update a beneficiary
      description: |
        Updates a beneficiary using merge semantics. Only fields present in the
        body are changed. `beneficiaryType` must be echoed from a prior Get even
        when you are not changing it. Payment destinations are not touched by
        this route — use the payment-destinations sub-resource instead.
      operationId: updateBeneficiary
      parameters:
        - $ref: '#/components/parameters/BeneficiaryId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BeneficiaryInput'
            example:
              beneficiaryType: Business
              business:
                contactPersonName: Jane Smith
                contactEmail: jane@acme.example
      responses:
        '200':
          description: Updated beneficiary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Beneficiary'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
        '502':
          $ref: '#/components/responses/UpstreamError'
components:
  parameters:
    BeneficiaryId:
      name: beneficiaryId
      in: path
      required: true
      description: Beneficiary identifier.
      schema:
        type: string
        format: uuid
  schemas:
    BeneficiaryInput:
      type: object
      required:
        - beneficiaryType
      description: >
        Used for both POST (create) and PATCH (update) beneficiary requests.

        For PATCH, only fields present in the body are changed.
        `beneficiaryType`

        is always required — echo it from a prior Get even when not changing it.

        Payment destinations are managed separately via the

        `/payment-destinations` sub-resource.
      properties:
        beneficiaryType:
          type: string
          enum:
            - Individual
            - Business
        reference:
          type: string
        individual:
          $ref: '#/components/schemas/IndividualInput'
        business:
          $ref: '#/components/schemas/BusinessInput'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/AddressInput'
        tags:
          type: array
          items:
            type: string
    Beneficiary:
      type: object
      required:
        - id
        - beneficiaryType
      properties:
        id:
          type: string
          format: uuid
        beneficiaryType:
          type: string
          enum:
            - Individual
            - Business
        reference:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        individual:
          $ref: '#/components/schemas/Individual'
        business:
          $ref: '#/components/schemas/Business'
        paymentDestinations:
          type: array
          items:
            $ref: '#/components/schemas/PaymentDestination'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/BeneficiaryAddress'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/BeneficiaryTag'
    IndividualInput:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        idNumber:
          type: string
        dateOfBirth:
          type:
            - string
            - 'null'
          format: date
        nationality:
          type: string
        mobileNumber:
          type: string
        email:
          type: string
          format: email
    BusinessInput:
      type: object
      properties:
        companyName:
          type: string
        registrationNumber:
          type: string
        countryOfRegistration:
          type: string
        taxId:
          type: string
        industry:
          type: string
        contactPersonName:
          type: string
        contactNumber:
          type: string
        contactEmail:
          type: string
          format: email
        registeredAddress:
          type: string
    AddressInput:
      type: object
      properties:
        addressType:
          type: string
        addressLine1:
          type: string
        addressLine2:
          type: string
        city:
          type: string
        stateProvince:
          type: string
        postalCode:
          type: string
        countryCode:
          type: string
        isPrimary:
          type: boolean
    Individual:
      type: object
      properties:
        id:
          type: string
          format: uuid
        firstName:
          type: string
        lastName:
          type: string
        idNumber:
          type: string
        dateOfBirth:
          type:
            - string
            - 'null'
          format: date
        nationality:
          type: string
        mobileNumber:
          type: string
        email:
          type: string
          format: email
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Business:
      type: object
      properties:
        id:
          type: string
          format: uuid
        companyName:
          type: string
        registrationNumber:
          type: string
        countryOfRegistration:
          type: string
        taxId:
          type: string
        industry:
          type: string
        contactPersonName:
          type: string
        contactNumber:
          type: string
        contactEmail:
          type: string
          format: email
        registeredAddress:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    PaymentDestination:
      type: object
      required:
        - id
        - method
      properties:
        id:
          type: string
          format: uuid
        beneficiaryId:
          type: string
          format: uuid
        method:
          type: string
          description: Payment method — BANK, MOMO, or CRYPTO.
          example: BANK
        label:
          type: string
        isPrimary:
          type: boolean
        countryIsoCode2:
          type: string
          description: ISO 3166-1 alpha-2 country code.
        currencyIsoCode3:
          type: string
          description: ISO 4217 currency code.
        bankName:
          type: string
        bankCode:
          type: string
        accountNumber:
          type: string
        accountName:
          type: string
        accountType:
          type: string
        sortCode:
          type: string
        iban:
          type: string
        swiftBic:
          type: string
        branchCode:
          type: string
        mobileNumber:
          type: string
        mobileProvider:
          type: string
        networkName:
          type: string
          description: Platform network name (CRYPTO destinations).
        assetSymbol:
          type: string
        walletAddress:
          type: string
        isZeamAccount:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    BeneficiaryAddress:
      type: object
      properties:
        id:
          type: string
          format: uuid
        addressType:
          type: string
        addressLine1:
          type: string
        addressLine2:
          type: string
        city:
          type: string
        stateProvince:
          type: string
        postalCode:
          type: string
        countryCode:
          type: string
        isPrimary:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    BeneficiaryTag:
      type: object
      required:
        - tag
      properties:
        tag:
          type: string
        createdAt:
          type: string
          format: date-time
    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'
    NotFound:
      description: Resource not found.
      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 (the apiKey issued at registration), validated at the
        Kong edge.

````