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

# Put customers beneficiaries



## OpenAPI

````yaml /api-reference/openapi.yaml put /customers/{customerId}/beneficiaries/{beneficiaryId}
openapi: 3.0.3
info:
  title: Polygon OMS Public API
  version: v26.10.29-0003
  description: >-
    Unified API for moving money between crypto and fiat. Three ways to move
    money: Transactions (instant, wallet or card funded, including Cash-In for
    in-person cash deposits), Deposit Addresses (reusable crypto deposit
    configurations), and Virtual Accounts (dedicated bank accounts that
    auto-convert fiat to crypto). Standard transactions follow a two-step flow:
    create a Quote (pricing), then create a Transaction (execution). Cash-in
    codes generate a one-time deposit code for in-person cash deposits at retail
    locations.
  contact:
    name: Polygon OMS
    url: https://oms.polygon.technology
servers:
  - url: https://sandbox-api.polygon.technology/v0.13
    description: Sandbox
  - url: https://api.polygon.technology/v0.13
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Auth
    description: Authentication via OMS API key and secret
  - name: Customers
    description: Customer management and KYC
  - name: Customer
  - name: Wallet
  - name: Quote
  - name: Transaction
  - name: Transfer
  - name: CashIns
  - name: CashLocation
  - name: Sandbox
  - name: VirtualAccount
  - name: Counterparty
  - name: ExternalAccount
  - name: Reference
  - name: DepositAddress
  - name: Indexer
    description: >-
      Read token balances, prices, and transaction history across EVM networks,
      Solana, and Tron. Indexer methods are webRPC calls: each is a `POST` with
      a JSON body, served at `/v1/{Service}/{Method}` on the API host rather
      than under the `/v0.13` base path. Authenticate with a publishable key in
      the `Api-Key` header, or with a bearer token from `POST /auth/token`.
paths:
  /customers/{customerId}/beneficiaries/{beneficiaryId}:
    parameters:
      - name: customerId
        in: path
        required: true
        schema:
          type: string
      - name: beneficiaryId
        in: path
        required: true
        schema:
          type: string
    put:
      tags:
        - Business onboarding
      operationId: updateBusinessBeneficiary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessBeneficiaryUpdate'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessBeneficiary'
        '400':
          description: Request failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Request failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Request failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Request failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Request failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    BusinessBeneficiaryUpdate:
      type: object
      required:
        - version
        - input
      properties:
        version:
          type: integer
          minimum: 1
        input:
          $ref: '#/components/schemas/BusinessBeneficiaryInput'
    BusinessBeneficiary:
      type: object
      required:
        - id
        - object
        - customerId
        - roles
        - version
      properties:
        id:
          type: string
        object:
          type: string
          enum:
            - businessBeneficiary
        customerId:
          type: string
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        fullNameAsOnDocument:
          type: string
        nationality:
          type: string
        address:
          $ref: '#/components/schemas/BusinessAddress'
        email:
          type: string
        emailType:
          $ref: '#/components/schemas/BusinessEmailType'
        phone:
          type: string
        phoneType:
          $ref: '#/components/schemas/BusinessPhoneType'
        title:
          type: string
        roles:
          type: array
          items:
            type: string
            enum:
              - beneficialOwner
              - controller
              - director
              - signatory
              - representative
        ownershipPercentage:
          type: string
        hasControl:
          type: boolean
        politicallyExposedPerson:
          type: boolean
        regO:
          type: boolean
        riskRating:
          $ref: '#/components/schemas/BusinessRiskRating'
        taxIdType:
          $ref: '#/components/schemas/BusinessTaxIDType'
        identificationType:
          type: string
          enum:
            - driversLicense
            - passport
            - idCard
            - socialSecurityCard
            - other
        issuingAuthority:
          type: string
        issuingCountry:
          type: string
        issuingState:
          type: string
        issuedDate:
          type: string
        expirationDate:
          type: string
        verifiedDate:
          type: string
        hasBirthDate:
          type: boolean
        hasTaxId:
          type: boolean
        hasIdentificationNumber:
          type: boolean
        version:
          type: integer
          minimum: 1
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      required:
        - error
        - code
        - msg
        - status
      description: >-
        Canonical OMSX error envelope, matching the webrpc shape every OMSX
        service emits. Names and numeric codes are stable identifiers defined in
        `schema/omsx/errors.ridl`.
      properties:
        error:
          type: string
          description: Stable error name from schema/omsx/errors.ridl
          example: Unauthorized
        code:
          type: integer
          description: Stable numeric code from schema/omsx/errors.ridl
          example: 1000
        msg:
          type: string
          description: Human-readable message (kept stable across releases)
          example: unauthorized access
        cause:
          type: string
          description: >-
            Optional internal cause for operator triage; filtered before
            reaching end customers
          example: signature
        status:
          type: integer
          description: HTTP status mirrored in the body for client convenience
          example: 401
    BusinessBeneficiaryInput:
      type: object
      description: >-
        Full replacement of non-sensitive beneficiary facts. Omitted
        non-sensitive values are cleared. Sensitive identifiers are write-only;
        omission preserves their values and an empty string clears them. Enum
        values use camelCase.
      required:
        - roles
      properties:
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        fullNameAsOnDocument:
          type: string
        nationality:
          type: string
        address:
          $ref: '#/components/schemas/BusinessAddress'
        email:
          type: string
        emailType:
          $ref: '#/components/schemas/BusinessEmailType'
        phone:
          type: string
        phoneType:
          $ref: '#/components/schemas/BusinessPhoneType'
        title:
          type: string
        roles:
          type: array
          items:
            type: string
            enum:
              - beneficialOwner
              - controller
              - director
              - signatory
              - representative
        ownershipPercentage:
          type: string
        hasControl:
          type: boolean
        politicallyExposedPerson:
          type: boolean
        regO:
          type: boolean
        riskRating:
          $ref: '#/components/schemas/BusinessRiskRating'
        taxIdType:
          $ref: '#/components/schemas/BusinessTaxIDType'
        identificationType:
          type: string
          enum:
            - driversLicense
            - passport
            - idCard
            - socialSecurityCard
            - other
        issuingAuthority:
          type: string
        issuingCountry:
          type: string
        issuingState:
          type: string
        issuedDate:
          type: string
        expirationDate:
          type: string
        verifiedDate:
          type: string
        birthDate:
          type: string
          writeOnly: true
        taxId:
          type: string
          writeOnly: true
        identificationNumber:
          type: string
          writeOnly: true
    BusinessAddress:
      type: object
      properties:
        line1:
          type: string
        line2:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        country:
          type: string
    BusinessEmailType:
      type: string
      enum:
        - personal
        - work
        - other
    BusinessPhoneType:
      type: string
      enum:
        - home
        - mobile
        - work
        - fax
    BusinessRiskRating:
      type: string
      enum:
        - low
        - medium
        - high
    BusinessTaxIDType:
      type: string
      enum:
        - ein
        - vat
        - foreign
        - ssn
        - itin
        - foreignTin
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token from POST /auth/token

````