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

# Create Beneficiary

> Create VertoFX Beneficiary

<Note>
  This endpoint requires authentication. Include your Bearer token in the Authorization header.
</Note>

## Description

**Description:**\
The `/integrations/vertofx/beneficiaries` endpoint allows creation of new beneficiaries in the VertoFX system.

**Method:** `POST`

**Request Payload:**

| Parameter              | Type   | Description                          |
| ---------------------- | ------ | ------------------------------------ |
| firstName              | string | First name of the beneficiary        |
| lastName               | string | Last name of the beneficiary         |
| email                  | string | Email address of the beneficiary     |
| bankName               | string | Name of the beneficiary's bank       |
| accountNumber          | string | Bank account number                  |
| currency               | string | Currency code (e.g., USD, EUR, NGN)  |
| beneficiaryCountryCode | string | Country code of the beneficiary      |
| beneficiaryAddress     | string | Address of the beneficiary           |
| beneficiaryCity        | string | City of the beneficiary              |
| beneficiaryPostcode    | string | Postal code of the beneficiary       |
| beneficiaryEntityType  | string | Type of entity (individual, company) |

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  const response = await fetch('https://api.royalti.io/integrations/vertofx/beneficiaries', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      "firstName": "sample-firstName",
      "lastName": "sample-lastName",
      "email": "sample-email",
      "bankName": "sample-bankName",
      "accountNumber": "sample-accountNumber",
      "currency": "sample-currency",
      "beneficiaryCountryCode": "sample-beneficiaryCountryCode",
      "beneficiaryAddress": "sample-beneficiaryAddress",
      "beneficiaryCity": "sample-beneficiaryCity",
      "beneficiaryPostcode": "sample-beneficiaryPostcode",
      "beneficiaryEntityType": "sample-beneficiaryEntityType",
      "beneficiaryCompanyName": "sample-beneficiaryCompanyName"
    })
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
    'https://api.royalti.io/integrations/vertofx/beneficiaries',
    headers={
      'Authorization': f'Bearer {token}'
    },
    json={"firstName":"sample-firstName","lastName":"sample-lastName","email":"sample-email","bankName":"sample-bankName","accountNumber":"sample-accountNumber","currency":"sample-currency","beneficiaryCountryCode":"sample-beneficiaryCountryCode","beneficiaryAddress":"sample-beneficiaryAddress","beneficiaryCity":"sample-beneficiaryCity","beneficiaryPostcode":"sample-beneficiaryPostcode","beneficiaryEntityType":"sample-beneficiaryEntityType","beneficiaryCompanyName":"sample-beneficiaryCompanyName"}
  )

  data = response.json()
  print(data)
  ```

  ```bash cURL theme={null}
  curl -X POST https://api.royalti.io/integrations/vertofx/beneficiaries \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"firstName":"sample-firstName","lastName":"sample-lastName","email":"sample-email","bankName":"sample-bankName","accountNumber":"sample-accountNumber","currency":"sample-currency","beneficiaryCountryCode":"sample-beneficiaryCountryCode","beneficiaryAddress":"sample-beneficiaryAddress","beneficiaryCity":"sample-beneficiaryCity","beneficiaryPostcode":"sample-beneficiaryPostcode","beneficiaryEntityType":"sample-beneficiaryEntityType","beneficiaryCompanyName":"sample-beneficiaryCompanyName"}'

  ```
</CodeGroup>


## OpenAPI

````yaml post /integrations/vertofx/beneficiaries
openapi: 3.0.0
info:
  title: Royalti.io API
  description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
  version: 2.6.0
  contact:
    name: Royalti.io Support
    email: support@royalti.io
    url: https://royalti.io
  license:
    name: Proprietary
    url: https://royalti.io/terms
servers:
  - url: https://api.royalti.io
    description: Production server
  - url: https://api-dev.royalti.io
    description: Development server
  - url: http://localhost:8084
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Accounting
    description: Accounting and financial transaction operations
  - name: DDEX
    description: DDEX operations (ERN/MEAD, messages, delivery, providers)
  - name: Label
    description: Label management operations
  - name: Internal Webhooks
    description: Internal system webhooks for royalty processing and downloads
  - name: Payment Webhooks
    description: Payment processor webhook endpoints
  - name: Billing Webhooks
    description: Stripe billing and subscription webhooks
  - name: Infrastructure Webhooks
    description: Cloudflare domain and SSL webhooks
  - name: Distribution Webhooks
    description: Digital distribution platform webhooks (FUGA)
paths:
  /integrations/vertofx/beneficiaries:
    post:
      tags:
        - VertoFx
      summary: Create Beneficiary
      description: >-
        Create VertoFX Beneficiary


        **Description:**  

        The `/integrations/vertofx/beneficiaries` endpoint allows creation of
        new beneficiaries in the VertoFX system.


        **Method:** `POST`


        **Request Payload:**


        | Parameter | Type | Description |

        | --- | --- | --- |

        | firstName | string | First name of the beneficiary |

        | lastName | string | Last name of the beneficiary |

        | email | string | Email address of the beneficiary |

        | bankName | string | Name of the beneficiary's bank |

        | accountNumber | string | Bank account number |

        | currency | string | Currency code (e.g., USD, EUR, NGN) |

        | beneficiaryCountryCode | string | Country code of the beneficiary |

        | beneficiaryAddress | string | Address of the beneficiary |

        | beneficiaryCity | string | City of the beneficiary |

        | beneficiaryPostcode | string | Postal code of the beneficiary |

        | beneficiaryEntityType | string | Type of entity (individual, company)
        |
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                firstName:
                  type: string
                  description: First name of the beneficiary
                lastName:
                  type: string
                  description: Last name of the beneficiary
                email:
                  type: string
                  format: email
                  description: Email address of the beneficiary
                bankName:
                  type: string
                  description: Name of the beneficiary's bank
                accountNumber:
                  type: string
                  description: Bank account number
                currency:
                  type: string
                  description: Currency code (e.g., USD, EUR, NGN)
                beneficiaryCountryCode:
                  type: string
                  description: Country code of the beneficiary
                beneficiaryAddress:
                  type: string
                  description: Address of the beneficiary
                beneficiaryCity:
                  type: string
                  description: City of the beneficiary
                beneficiaryPostcode:
                  type: string
                  description: Postal code of the beneficiary
                beneficiaryEntityType:
                  type: string
                  enum:
                    - individual
                    - company
                  description: Type of entity
                beneficiaryCompanyName:
                  type: string
                  description: Company name (if entity type is company)
              required:
                - firstName
                - lastName
                - email
                - bankName
                - accountNumber
                - currency
                - beneficiaryCountryCode
                - beneficiaryAddress
                - beneficiaryCity
                - beneficiaryEntityType
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                  message:
                    type: string
              example:
                success: true
                message: Beneficiary created successfully
                data:
                  id: 4755
                  reference: RP-12122024-007
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Authorization header using the Bearer scheme. Format: "Bearer
        {token}"

````