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

# Post v3files

> Uploads a given file and returns its internal ID.



## OpenAPI

````yaml /lumx_openapi.yaml post /v3/files/
openapi: 3.0.3
info:
  title: Lumenaza external API
  version: 3.8.0 (v3)
  description: Specification of the Lumenaza external API.
servers:
  - url: https://api.lumenaza.de/
    description: Produktivserver
  - url: https://api.test.lumenaza.de/
    description: Testserver
security: []
tags:
  - name: Community Data API
    description: >-
      The API is used to retrieve master data and measurement data for a
      community. A community is defined by all customers that belong to your
      company
  - name: Consumer API
    description: >-
      Manage consumers, their contracts, products, readings, and charges or
      credits
  - name: Consumption Forecast API
    description: Retrieve consumption forecasts for grid contracts
  - name: Customer Portal API
    description: Request a customer portal password reset
  - name: Customer API
    description: Retrieve product and pricing information for a customer contract
  - name: Files API
    description: Upload files and receive identifiers for use in other API requests
  - name: Market Partner API
    description: List market partners and retrieve market partner bills and payment advices
  - name: Master Data API
    description: Submit and track changes to customer and redispatch master data
  - name: Migration API
    description: Migrate consumer contracts and add contracts during migration
  - name: Offer Calculator API
    description: Calculate customer offers for a tariff and the supplied parameters
  - name: Price Calculator API
    description: >-
      Retrieve day-ahead electricity prices, local utility prices, and estimated
      CO₂ savings
  - name: Producer API
    description: >-
      Manage producers, their contracts, plants, feed-in data, and charges or
      credits
  - name: User Documents API
    description: List and retrieve documents associated with users and their contracts
  - name: Validation API
    description: >-
      Validate market location identifiers, IBANs, and preferred delivery start
      dates
paths:
  /v3/files/:
    post:
      tags:
        - Files API
      description: Uploads a given file and returns its internal ID.
      operationId: files_create
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FileUpload'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FileUpload'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileResponse'
          description: ''
components:
  schemas:
    FileUpload:
      type: object
      properties:
        document_type:
          allOf:
            - $ref: '#/components/schemas/DocumentTypeEnum'
          description: >-
            Type of the uploaded user document. Legacy misspellings of
            remote-controllability types are accepted and normalized.


            * `initial_assignment` - Erstzuordnung

            * `initial_assignment_agreement` - Vollmacht zur Erstzuordnung

            * `remote_controllability_agreement` - FST-Vollmacht

            * `remote_controllabilty_agreement` - FST-Vollmacht

            * `remote_controllability_declaration` - FST-Erklärung

            * `remote_controllabilty_declaration` - FST-Erklärung

            * `remote_controllability_protocol` - FST-Protokoll

            * `remote_controllabilty_protocol` - FST-Protokoll

            * `remote_controllability_proof` - FST-Nachweis

            * `remote_controllabilty_proof` - FST-Nachweis

            * `installation_receipt` - Einbaubeleg
        file:
          type: string
          format: uri
          description: >-
            Document file. Accepted file types are pdf, jpg, png, heic; accepted
            extensions are .pdf, .jpg, .jpeg, .png, .heic. The file content type
            and extension must match.
      required:
        - document_type
        - file
    FileResponse:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
      required:
        - id
    DocumentTypeEnum:
      enum:
        - initial_assignment
        - initial_assignment_agreement
        - remote_controllability_agreement
        - remote_controllabilty_agreement
        - remote_controllability_declaration
        - remote_controllabilty_declaration
        - remote_controllability_protocol
        - remote_controllabilty_protocol
        - remote_controllability_proof
        - remote_controllabilty_proof
        - installation_receipt
      type: string
      description: |-
        * `initial_assignment` - Erstzuordnung
        * `initial_assignment_agreement` - Vollmacht zur Erstzuordnung
        * `remote_controllability_agreement` - FST-Vollmacht
        * `remote_controllabilty_agreement` - FST-Vollmacht
        * `remote_controllability_declaration` - FST-Erklärung
        * `remote_controllabilty_declaration` - FST-Erklärung
        * `remote_controllability_protocol` - FST-Protokoll
        * `remote_controllabilty_protocol` - FST-Protokoll
        * `remote_controllability_proof` - FST-Nachweis
        * `remote_controllabilty_proof` - FST-Nachweis
        * `installation_receipt` - Einbaubeleg

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.