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

# Get beneficiary field requirements for a currency

> Returns required and optional beneficiary fields based on destination currency. Aggregates requirements across all providers that support the currency.



## OpenAPI

````yaml /openapi.json get /v1/payouts/requirements
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Comprehensive payment platform API supporting fiat and crypto payments,
    currency conversion, and compliance management
  title: Zuba Payment Platform API
  version: '1.0'
servers: []
security: []
tags:
  - description: Manage M2M API keys and credentials
    name: API Keys
  - description: Internal ledger accounts and transactions
    name: Ledger
  - description: Handle incoming payments and deposits
    name: Pay-ins
  - description: Manage payouts, beneficiaries, and SEPA transfers
    name: Payouts
  - description: Manage outbound webhook endpoints and deliveries
    name: Webhooks
paths:
  /v1/payouts/requirements:
    get:
      tags:
        - Payouts
      summary: Get beneficiary field requirements for a currency
      description: >-
        Returns required and optional beneficiary fields based on destination
        currency. Aggregates requirements across all providers that support the
        currency.
      operationId: PayoutController_getPayoutRequirements
      parameters:
        - description: Destination currency (e.g. NGN, EUR, USD, GBP)
          in: query
          name: currency
          required: true
          schema:
            example: NGN
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryFieldRequirementsDto'
          description: Beneficiary field requirements for the currency
        '401':
          description: Unauthorized
        '404':
          description: No providers available for the currency
      security:
        - bearer: []
components:
  schemas:
    BeneficiaryFieldRequirementsDto:
      properties:
        optional:
          description: Fields that may optionally be provided
          example:
            - email
            - addressLine2
            - countrySubdivision
          items:
            type: string
          type: array
        required:
          description: Fields that must be provided for this corridor
          example:
            - address
            - city
            - postcode
          items:
            type: string
          type: array
      required:
        - required
        - optional
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      description: Enter Auth0 JWT token
      scheme: bearer
      type: http

````