> ## 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.

# Add VertoFx Integrations

> Create VertoFX Integration

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

## Description

**Endpoint:** `/integrations/vertofx`\
**Method:** `POST`

**Request Body**

| Field    | Type   | Required | Description                               |
| -------- | ------ | -------- | ----------------------------------------- |
| name     | string | Yes      | Name of the VertoFX integration instance. |
| apiKey   | string | Yes      | API key for the VertoFX integration.      |
| clientId | string | Yes      | Client ID for the VertoFX integration.    |

This endpoint allows you to create a new integration instance for VertoFX by providing a name, an API key, and a client ID.

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  const response = await fetch('https://api.royalti.io/integrations/vertofx', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      "name": "sample-name",
      "apiKey": "sample-apiKey",
      "clientId": "sample-clientId",
      "memo": "sample-memo"
    })
  });

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

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

  response = requests.post(
    'https://api.royalti.io/integrations/vertofx',
    headers={
      'Authorization': f'Bearer {token}'
    },
    json={"name":"sample-name","apiKey":"sample-apiKey","clientId":"sample-clientId","memo":"sample-memo"}
  )

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

  ```bash cURL theme={null}
  curl -X POST https://api.royalti.io/integrations/vertofx \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name":"sample-name","apiKey":"sample-apiKey","clientId":"sample-clientId","memo":"sample-memo"}'

  ```
</CodeGroup>


## OpenAPI

````yaml post /integrations/vertofx
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:
    post:
      tags:
        - VertoFx
      summary: Add VertoFx Integrations
      description: >-
        Create VertoFX Integration


        **Endpoint:** `/integrations/vertofx`  

        **Method:** `POST`


        **Request Body**


        | Field | Type | Required | Description |

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

        | name | string | Yes | Name of the VertoFX integration instance. |

        | apiKey | string | Yes | API key for the VertoFX integration. |

        | clientId | string | Yes | Client ID for the VertoFX integration. |


        This endpoint allows you to create a new integration instance for
        VertoFX by providing a name, an API key, and a client ID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Name of the VertoFX integration instance
                apiKey:
                  type: string
                  description: API key for the VertoFX integration
                clientId:
                  type: string
                  description: Client ID for the VertoFX integration
                memo:
                  type: string
                  description: Optional memo for the integration
              required:
                - name
                - apiKey
                - clientId
              example:
                name: Royalti Demo Verto Integrations
                apiKey: 9JP4FKWP0TMTDFPYHGSEIUGFBWEFHGSLQVSHJF2KTR17HGSGHFKHGDBSJFVG
                clientId: H812JHVLSDKJFBVKLJDBSFVBDFUVS86Y5
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  enabled:
                    type: boolean
                  settings:
                    type: object
                    properties:
                      apiKey:
                        type: string
                      clientId:
                        type: string
                  memo:
                    type: string
                    nullable: true
                  TenantId:
                    type: integer
                  IntegrationId:
                    type: string
                  updatedAt:
                    type: string
                    format: date-time
                  createdAt:
                    type: string
                    format: date-time
                  metadata:
                    type: object
                    nullable: true
              example:
                id: d3fa97e3-2573-4695-9d1d-516f8b11d874
                name: Royalti Demo Verto Integrations
                enabled: true
                settings:
                  apiKey: 9JP4FKWP0TMTDFPYHGSEIUGFBWEFHGSLQVSHJF2KTR17HGSGHFKHGDBSJFVG
                  clientId: H812JHVLSDKJFBVKLJDBSFVBDFUVS86Y5
                memo: null
                TenantId: 2
                IntegrationId: a4ab3109-b247-431c-a7c0-fd004a851475
                updatedAt: '2024-04-11T21:14:49.622Z'
                createdAt: '2024-04-11T21:14:49.622Z'
                metadata: null
        '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}"

````