openapi: 3.2.0
info:
  title: Moov Files API
  version: v2026.01.00
  contact:
    name: Moov Developer Support
    email: help@moov.io
    url: https://moov.io
  license:
    name: Unlicensed
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: 'Operations tagged Files across 2 of this provider''s published API definitions: moov-api-v2026.01.00-openapi.yml, moov-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.moov.io
  description: Production API host
  variables: {}
security:
- BasicAuth: []
tags:
- name: Files
paths:
  /accounts/{accountID}/files:
    post:
      operationId: uploadFile
      description: 'Upload a file and link it to the specified Moov account.


        The maximum file size is 20MB. Each account is allowed a maximum of 50 files. Acceptable file types include csv, jpg, pdf,

        and png.


        To access this endpoint using an access token

        you''ll need to specify the `/accounts/{accountID}/files.write` scope.'
      parameters:
      - $ref: '#/components/parameters/VersionHeader'
      - name: accountID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request completed successfully.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileDetails'
        '400':
          description: The server could not understand the request due to invalid syntax.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
        '401':
          description: The request contained missing or expired authentication.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '403':
          description: The user is not authorized to make the request.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '404':
          description: The requested resource was not found.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '409':
          description: The request conflicted with the current state of the target resource.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
        '422':
          description: The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileValidationError'
        '429':
          description: Request was refused due to rate limiting.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '500':
          description: The request failed due to an unexpected error.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '504':
          description: The request failed because a downstream service failed to respond.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
      tags:
      - Files
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FileUploadRequestMultiPart'
            encoding:
              file:
                contentType: text/csv, image/png, image/jpeg, application/pdf
              filePurpose:
                contentType: text/plain
              metadata:
                contentType: application/json
      x-speakeasy-name-override: upload
      summary: Upload file
      x-summary-source: derived
    get:
      operationId: listFiles
      description: 'List all the files associated with a particular Moov account.


        To access this endpoint using an access token

        you''ll need to specify the `/accounts/{accountID}/files.read` scope.'
      parameters:
      - $ref: '#/components/parameters/VersionHeader'
      - name: accountID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request completed successfully.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FileDetails'
        '401':
          description: The request contained missing or expired authentication.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '403':
          description: The user is not authorized to make the request.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '429':
          description: Request was refused due to rate limiting.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '500':
          description: The request failed due to an unexpected error.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '504':
          description: The request failed because a downstream service failed to respond.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
      tags:
      - Files
      x-speakeasy-name-override: list
      summary: List files
      x-summary-source: derived
    servers:
    - url: https://api.moov.io
      description: Production API host
      variables: {}
  /accounts/{accountID}/files/{fileID}:
    get:
      operationId: getFileDetails
      description: 'Retrieve file details associated with a specific Moov account.


        To access this endpoint using an access token

        you''ll need to specify the `/accounts/{accountID}/files.read` scope.'
      parameters:
      - $ref: '#/components/parameters/VersionHeader'
      - name: accountID
        in: path
        required: true
        schema:
          type: string
      - name: fileID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request completed successfully.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileDetails'
        '401':
          description: The request contained missing or expired authentication.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '403':
          description: The user is not authorized to make the request.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '404':
          description: The requested resource was not found.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '429':
          description: Request was refused due to rate limiting.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '500':
          description: The request failed due to an unexpected error.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '504':
          description: The request failed because a downstream service failed to respond.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
      tags:
      - Files
      x-speakeasy-name-override: get
      summary: Get file details
      x-summary-source: derived
    servers:
    - url: https://api.moov.io
      description: Production API host
      variables: {}
components:
  schemas:
    FileUploadRequestMultiPart:
      type: object
      properties:
        file:
          type: string
          format: binary
          description: The file to upload. Valid types are `csv`, `png`, `jpeg`, `pdf`.
        filePurpose:
          $ref: '#/components/schemas/FilePurpose'
        metadata:
          allOf:
          - $ref: '#/components/schemas/FileUploadMetadata'
          description: Additional metadata to be stored with the file.
      required:
      - file
      - filePurpose
    FileValidationError:
      type: object
      properties:
        error:
          type: string
        file:
          type: string
        FileName:
          type: string
        filePurpose:
          type: string
        metadata:
          type: string
    FileUploadMetadata:
      type: object
      properties:
        representative_id:
          type: string
          format: ID
          description: The representative ID that the file is for. Required when filePurpose is `representativeVerification`.
        comment:
          type: string
          description: Comments or notes about the file.
      description: Additional metadata to be stored with the file.
    FilePurpose:
      type: string
      enum:
      - business_verification
      - representative_verification
      - individual_verification
      - merchant_underwriting
      - account_requirement
      - identity_verification
      description: The purpose of the file being uploaded.
      example: representative_verification
    FileStatus:
      type: string
      enum:
      - pending
      - approved
      - rejected
      description: The file's status.
      example: pending
    FileDetails:
      type: object
      required:
      - fileID
      - fileName
      - accountID
      - filePurpose
      - fileStatus
      - metadata
      - fileSizeBytes
      - createdOn
      - updatedOn
      properties:
        fileID:
          type: string
        fileName:
          type: string
          maxLength: 64
          example: logo.png
        accountID:
          type: string
        filePurpose:
          $ref: '#/components/schemas/FilePurpose'
        fileStatus:
          $ref: '#/components/schemas/FileStatus'
        metadata:
          type: string
          format: json
          example: '{"error_code": "document-name-mismatch", "requirement_id": "document.individual.verification", "representative_id": "c63ab175-251d-497e-a267-7346d087e180", "comment": "testing comment"'
        decisionReason:
          type: string
          example: not correct file
        fileSizeBytes:
          type: integer
        createdOn:
          type: string
          format: date-time
        updatedOn:
          type: string
          format: date-time
      description: Describes a file linked to a Moov account.
    GenericError:
      type: object
      required:
      - error
      properties:
        error:
          type: string
  parameters:
    VersionHeader:
      name: X-Moov-Version
      in: header
      required: false
      description: 'Set this header to v2026.01.00 to use the API described in this specification.

        When omitted, the server defaults to v2024.01.00, the earliest supported version, which may not match the behavior documented here.

        An unrecognized well-formed version uses the latest supported version that is not newer than the requested version, when one exists.

        For example, `v2026.08.00` uses `v2026.07.00`.

        A malformed value, such as `2022`, returns a `404` response.'
      schema:
        type: string
        enum:
        - v2026.01.00
        example: v2026.01.00
        x-speakeasy-ignore: true
      x-speakeasy-ignore: true
  securitySchemes:
    BasicAuth:
      type: http
      scheme: Basic
externalDocs:
  url: https://docs.moov.io/
  description: Moov Guides and API Documentation
x-refined-from:
- moov-api-v2026.01.00-openapi.yml
- moov-openapi.yml