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

# Create a new API key

> Create a new API key for third-party integration



## OpenAPI

````yaml /olive-openapi.json post /api-keys
openapi: 3.0.0
info:
  description: >-
    API Gateway for OLIVE NFC Card Payment System - Comprehensive payment, card
    management, agent operations, and admin authentication. All /api/v1 routes
    require authentication using either API Key or JWT token.
  title: OLIVE NFC Card Payment API
  termsOfService: http://swagger.io/terms/
  contact:
    name: API Support
    email: support@olive.sl
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
  - url: https://olive-gateway-a6ba.onrender.com/api/v1
security: []
paths:
  /api-keys:
    post:
      tags:
        - API Keys
      summary: Create a new API key
      description: Create a new API key for third-party integration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/handler.CreateAPIKeyRequest'
        description: API key details
        required: true
      responses:
        '201':
          description: API key created
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
      security:
        - ApiKeyAuth: []
components:
  schemas:
    handler.CreateAPIKeyRequest:
      type: object
      required:
        - name
        - scopes
      properties:
        description:
          type: string
        expires_in_days:
          type: integer
        integration_type:
          description: whatsapp, smart_pay, vult, agent_app
          type: string
        ip_whitelist:
          type: array
          items:
            type: string
        name:
          type: string
        rate_limit:
          type: integer
        scopes:
          type: array
          minItems: 1
          items:
            type: string
  securitySchemes:
    ApiKeyAuth:
      description: >-
        API Key for third-party integrations (WhatsApp, Smart PAY, VULT).
        Format: 'Bearer olive_live_xxxxxxxxxxxxx'
      type: apiKey
      name: Authorization
      in: header

````