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

# Get beneficiary

> Retrieve a beneficiary by its identifier. The beneficiary type is resolved automatically.



## OpenAPI

````yaml GET /v1/beneficiaries/{beneficiaryId}
openapi: 3.0.0
info:
  title: nxos API
  version: 1.0.0
  contact:
    name: nxos
    url: https://nxos.io
  description: |-
    The nxos platform API provides programmatic access to accounts, balances,
    quotes, and trades. All endpoints require API key authentication.
servers:
  - url: https://api.nxos.io
    description: Production
    variables: {}
  - url: https://api.sandbox.nxos.io
    description: Sandbox
    variables: {}
security: []
tags:
  - name: Accounts
  - name: Quotes
  - name: Beneficiaries
  - name: Fiat Payouts
  - name: Crypto Payouts
  - name: Nxosnet
  - name: Fees
  - name: Funding Methods
  - name: Transactions
  - name: Organizations
  - name: Authorizations
  - name: Webhooks
    description: >-
      Register an HTTPS endpoint to receive events (organization verification
      and

      transaction status changes) instead of polling. Deliveries are signed;
      verify

      the `svix-signature` header before acting on an event.


      See the [Webhooks guide](https://docs.nxos.io/core-concepts/webhooks) for
      the

      delivery format, signature verification, retries, and broker behavior.
      Payload

      shapes are documented in the `…Event` models below.
paths:
  /v1/beneficiaries/{beneficiaryId}:
    get:
      tags:
        - Beneficiaries
      description: >-
        Retrieve a beneficiary by its identifier. The beneficiary type is
        resolved automatically.
      operationId: Beneficiaries_get
      parameters:
        - $ref: '#/components/parameters/ApiKeyAuth'
        - name: beneficiaryId
          in: path
          required: true
          schema:
            type: string
        - name: accountId
          in: query
          required: true
          description: Account this beneficiary belongs to.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Beneficiary'
        '400':
          description: The server could not understand the request due to invalid syntax.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '429':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
components:
  parameters:
    ApiKeyAuth:
      name: Authorization
      in: header
      required: true
      description: 'Bearer token. Format: `Bearer <api_key>`'
      schema:
        type: string
  schemas:
    Beneficiary:
      type: object
      required:
        - object
        - beneficiaryId
        - accountId
        - type
        - nickname
        - status
        - entityType
        - email
        - phoneNumber
        - firstName
        - lastName
        - businessName
        - country
        - addressLine1
        - addressLine2
        - city
        - region
        - zipCode
        - crypto
        - bank
        - nxosnet
        - createdAt
      properties:
        object:
          type: string
          enum:
            - beneficiary
          description: Object type. Always `beneficiary`.
        beneficiaryId:
          type: string
          description: Unique beneficiary identifier.
        accountId:
          type: string
          description: Account this beneficiary belongs to.
        type:
          allOf:
            - $ref: '#/components/schemas/BeneficiaryType'
          description: Beneficiary type.
        nickname:
          type: string
          description: Display name for the beneficiary.
        status:
          allOf:
            - $ref: '#/components/schemas/BeneficiaryStatus'
          description: Current status.
        entityType:
          type: string
          enum:
            - INDIVIDUAL
            - BUSINESS
          nullable: true
          description: Entity type.
        email:
          type: string
          nullable: true
          description: Email address.
        phoneNumber:
          type: string
          nullable: true
          description: Phone number.
        firstName:
          type: string
          nullable: true
          description: First name (individuals).
        lastName:
          type: string
          nullable: true
          description: Last name (individuals).
        businessName:
          type: string
          nullable: true
          description: Business name (businesses).
        country:
          type: string
          nullable: true
          description: Country code (ISO 3166-1 alpha-2).
        addressLine1:
          type: string
          nullable: true
          description: Address line 1.
        addressLine2:
          type: string
          nullable: true
          description: Address line 2.
        city:
          type: string
          nullable: true
          description: City.
        region:
          type: string
          nullable: true
          description: Region / state / province.
        zipCode:
          type: string
          nullable: true
          description: ZIP / postal code.
        crypto:
          type: object
          allOf:
            - $ref: '#/components/schemas/CryptoBeneficiaryDetails'
          nullable: true
          description: >-
            Crypto-specific details. Present when type is `CRYPTO`, otherwise
            `null`.
        bank:
          type: object
          allOf:
            - $ref: '#/components/schemas/BankBeneficiaryDetails'
          nullable: true
          description: >-
            Bank-specific details. Present when type is `BANK`, otherwise
            `null`.
        nxosnet:
          type: object
          allOf:
            - $ref: '#/components/schemas/NxosnetBeneficiaryDetails'
          nullable: true
          description: >-
            Internal NXOS→NXOS details. Present when type is `NXOSNET`,
            otherwise `null`.
        createdAt:
          allOf:
            - $ref: '#/components/schemas/dateTimeString'
          description: When the beneficiary was created.
      description: |-
        A beneficiary (recipient) registered for payouts from an account.
        All responses share this shape — the `type` field indicates which detail
        object (`crypto` or `bank`) is populated; the other will be `null`.
        Shared identity fields may be `null` in list and create responses.
      example:
        object: beneficiary
        beneficiaryId: bene_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
        accountId: acct_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
        type: CRYPTO
        nickname: Treasury Wallet
        status: ACTIVE
        entityType: INDIVIDUAL
        email: treasury@example.com
        phoneNumber: null
        firstName: John
        lastName: Doe
        businessName: null
        country: US
        addressLine1: null
        addressLine2: null
        city: null
        region: null
        zipCode: null
        crypto:
          chainName: ethereum
          chainDisplayName: Ethereum
          platform: EVM
          address: '0x1234567890abcdef1234567890abcdef12345678'
        bank: null
        nxosnet: null
        createdAt: '2025-03-10T12:00:00.000Z'
    Error400:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: invalid_request
          message: The request body is malformed or missing required fields.
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    Error401:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: missing_api_key
          message: No Authorization header provided.
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    Error404:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: not_found
          message: The requested resource was not found.
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    Error429:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: rate_limited
          message: 'Rate limit exceeded: 1000 requests per minute. Retry in 23 seconds.'
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    Error500:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: internal_error
          message: An unexpected server error occurred.
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    BeneficiaryType:
      type: string
      enum:
        - CRYPTO
        - BANK
        - NXOSNET
      description: Beneficiary type.
    BeneficiaryStatus:
      type: string
      enum:
        - ACTIVE
        - INACTIVE
        - BLOCKED
        - ARCHIVED
      description: Beneficiary status.
    CryptoBeneficiaryDetails:
      type: object
      required:
        - chainName
        - chainDisplayName
        - platform
        - address
      properties:
        chainName:
          type: string
          description: Blockchain network name (e.g., `ethereum`, `solana`).
        chainDisplayName:
          type: string
          nullable: true
          description: Human-readable chain name. May be null on create responses.
        platform:
          type: string
          nullable: true
          description: >-
            Chain platform (e.g., `EVM`, `SOLANA`). May be null on create
            responses.
        address:
          type: string
          description: On-chain wallet address.
      description: Crypto-specific beneficiary details.
    BankBeneficiaryDetails:
      type: object
      required:
        - bankName
      properties:
        bankName:
          type: string
          description: Bank name.
        swiftCode:
          type: string
          nullable: true
          description: SWIFT / BIC code.
        iban:
          type: string
          nullable: true
          description: IBAN.
        bankCountry:
          type: string
          nullable: true
          description: Bank country (ISO 3166-1 alpha-2).
        method:
          type: string
          nullable: true
          description: Transfer method (e.g., `WIRE`, `SEPA`, `ACH`).
        currency:
          type: string
          nullable: true
          description: Payout currency code (e.g., `USD`, `EUR`).
        intermediaryBankName:
          type: string
          nullable: true
          description: Intermediary bank name.
        intermediarySwiftCode:
          type: string
          nullable: true
          description: Intermediary SWIFT / BIC code.
        intermediaryBankAddress:
          type: string
          nullable: true
          description: Intermediary bank address.
      description: Bank-specific beneficiary details.
    NxosnetBeneficiaryDetails:
      type: object
      required:
        - targetHandle
        - targetOrganizationName
        - showOrganizationName
      properties:
        targetHandle:
          type: string
          description: The target organization's claimed nxosnet handle.
        targetOrganizationName:
          type: string
          nullable: true
          description: >-
            Target organization's display name. `null` when the target has opted
            out of exposing it.
        showOrganizationName:
          type: boolean
          description: Whether the target organization exposes its name to senders.
      description: Internal NXOS→NXOS beneficiary details.
    dateTimeString:
      type: string
      description: ISO 8601 timestamp string.
    ErrorBody:
      type: object
      required:
        - code
        - message
        - requestId
      properties:
        code:
          allOf:
            - $ref: '#/components/schemas/ErrorCode'
          description: Machine-readable error code.
        message:
          type: string
          description: Human-readable error message.
        requestId:
          type: string
          description: Unique identifier for this request, useful for debugging.
    ErrorCode:
      type: string
      enum:
        - missing_api_key
        - authentication_failed
        - invalid_api_key
        - forbidden
        - not_found
        - organization_not_found
        - account_not_found
        - quote_not_found
        - beneficiary_not_found
        - transaction_not_found
        - funding_method_not_found
        - authorization_not_found
        - nxosnet_handle_not_found
        - quote_expired
        - quote_already_used
        - beneficiary_already_archived
        - beneficiary_not_archived
        - beneficiary_blocked
        - nxosnet_not_enabled
        - nxosnet_handle_taken
        - chain_send_failed
        - idempotency_key_in_use
        - idempotency_request_in_flight
        - invalid_request
        - insufficient_funds
        - validation_error
        - share_token_invalid
        - verification_import_unsupported
        - rate_limited
        - webhooks_unavailable
        - internal_error
      description: All possible error codes returned by the API.

````