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

# List beneficiaries for a customer

> List beneficiaries with cursor-based pagination.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/customers/{customerId}/beneficiaries
openapi: 3.1.0
info:
  title: Nuvera API
  description: Nuvera Payment Platform REST API
  version: '1.0'
  contact: {}
servers:
  - url: http://localhost:45000
security: []
tags: []
paths:
  /api/v1/customers/{customerId}/beneficiaries:
    get:
      tags:
        - Beneficiaries
      summary: List beneficiaries for a customer
      description: List beneficiaries with cursor-based pagination.
      operationId: BeneficiaryController_list
      parameters:
        - name: customerId
          required: true
          in: path
          schema:
            type: string
        - name: customerId
          required: true
          in: query
          schema:
            type: string
        - name: status
          required: false
          in: query
          schema:
            type: string
            enum:
              - PENDING_REVIEW
              - CORRECTION_REQUESTED
              - APPROVED
              - REJECTED
              - SUSPENDED
        - name: cursor
          required: false
          in: query
          schema:
            type: string
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryListOutputDto_Output'
      security:
        - x-api-key: []
          signed-request: []
components:
  schemas:
    BeneficiaryListOutputDto_Output:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              customerId:
                type: string
              country:
                type: string
              companyName:
                type: string
              address:
                type: string
              zipCode:
                type: string
              currencyCode:
                type: string
              bankName:
                type: string
              bankBic:
                type: string
              bankCountryCode:
                type: string
              bankAddress:
                type: string
              accountNumber:
                anyOf:
                  - type: string
                  - type: 'null'
              iban:
                anyOf:
                  - type: string
                  - type: 'null'
              wireRoutingNumber:
                anyOf:
                  - type: string
                  - type: 'null'
              achRoutingNumber:
                anyOf:
                  - type: string
                  - type: 'null'
              intermediaryBank:
                anyOf:
                  - type: string
                  - type: 'null'
              status:
                type: string
              createdAt:
                type: string
              updatedAt:
                type: string
              screening:
                anyOf:
                  - type: object
                    properties:
                      screeningSubjectId:
                        type: string
                      status:
                        type: string
                        enum:
                          - NOT_SCREENED
                          - PENDING
                          - CLEAR
                          - UNDER_REVIEW
                          - CLEARED
                          - CONFIRMED_HIT
                      paymentHold:
                        type: boolean
                      openMatchCount:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      highestSeverity:
                        anyOf:
                          - type: string
                            enum:
                              - BLOCKING
                              - ADVISORY
                          - type: 'null'
                      lastScreenedAt:
                        anyOf:
                          - type: string
                          - type: 'null'
                    required:
                      - screeningSubjectId
                      - status
                      - paymentHold
                      - openMatchCount
                      - highestSeverity
                      - lastScreenedAt
                    additionalProperties: false
                  - type: 'null'
            required:
              - id
              - customerId
              - country
              - companyName
              - address
              - zipCode
              - currencyCode
              - bankName
              - bankBic
              - bankCountryCode
              - bankAddress
              - accountNumber
              - iban
              - wireRoutingNumber
              - achRoutingNumber
              - intermediaryBank
              - status
              - createdAt
              - updatedAt
            additionalProperties: false
        nextCursor:
          anyOf:
            - type: string
            - type: 'null'
        hasMore:
          type: boolean
      required:
        - items
        - nextCursor
        - hasMore
      additionalProperties: false
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: Nuvera API application secret key
    signed-request:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: RS256 per-request signed JWT

````