---
title: "FileUploadOrAttachRequest"
url: "https://developer.pexa.co.uk/apis/lodgement-v1-v1/versions/4cf5cbcd-2fac-43d1-a87a-4c2ddc00ef30/schemas/FileUploadOrAttachRequest"
---

> Full API specification: https://developer.pexa.co.uk/apis/lodgement-v1-v1/versions/4cf5cbcd-2fac-43d1-a87a-4c2ddc00ef30.md

# FileUploadOrAttachRequest

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Lodgement
  version: v1.1.0
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    FileUploadOrAttachRequest:
      required:
        - file
        - documentType
        - documentCategory
      type: object
      properties:
        file:
          type: string
          format: binary
          example: sample_document.pdf
          description: |
            Allowed format: [`PDF`]
        documentType:
          type: string
          example: MORTGAGE_DEED
          description: |
            Allowed values: [`MORTGAGE_DEED`,
             `TR1`,
             `RX3`,
             `BIRTH_CERTIFICATE`,
             `CORRESPONDENCE`,
             `EVIDENCE`,
             `IDENTITY_EVIDENCE`,
             `IDENTITY_FORM`,
             `MARRIAGE_CERTIFICATE`,
             `STATEMENT_OF_TRUTH`,
             `STATUTORY_DECLARATION`,
             `MORTGAGE_OFFER`,
             `REDEMPTION_STATEMENT`,
             `PG82_CERTIFICATE`,
             `COMPANIES_HOUSE_CERTIFICATE`,
             `COMPANIES_HOUSE_EVIDENCE`,
             `LAND_TRANSACTION_TAX`,
             `STAMP_DUTY_LAND_TAX`]
        applicationId:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
          description: To attach the uploaded document to a specific application, the
            corresponding Application ID must be provided. This value is not
            required when uploading a document to Workspace without having to
            attach to an application.
        documentCategory:
          type: string
          example: APPLICATION_DOCUMENT
          description: |
            Allowed values: [`APPLICATION_DOCUMENT`,
             `SUPPORTING_DOCUMENT`,
             `WORKSPACE_SUPPORTING_DOCUMENT`]
        certificationType:
          type: string
          pattern: (CERTIFIED|ORIGINAL|SCANNED)
          example: CERTIFIED
          description: |
            Allowed values: [`CERTIFIED`, `ORIGINAL`, `SCANNED`]
```