> ## Documentation Index > Fetch the complete documentation index at: https://docs.prophia.com/llms.txt > Use this file to discover all available pages before exploring further. # CREATE Document via Upload > Uploads a Document as multipart form data and attaches it to a Lease. Any file type is accepted, up to 200MB. Only documents whose filename ends in `.pdf` are processed into Pages and Tags. To upload a document to a building or property level folder, simply use the buildingId or propertyId as the leaseId in the request. **Required capabilities:** `WRITE:DOCUMENT` ## OpenAPI ````yaml /api-reference/openapi.json post /rest/v2/accounts/{accountId}/docs/upload openapi: 3.1.0 info: title: Prophia API Documentation license: name: Apache 2.0 url: http://springdoc.org version: v2.495.0 servers: - url: https://api.prophia.com description: Prophia API security: - apiKey: [] tags: - name: Accounts description: >- Accounts are the top-level scope for everything in the API. Start here: list your accounts to find the `accountId` every other path requires. - name: Properties description: >- Properties group one or more buildings under a single asset within an account. - name: Buildings description: Buildings are the physical structures where leases and spaces live. - name: Building Spaces description: >- Building spaces are the units inside a building — suites, floors, storage. A space's `suiteNumber` is the canonical name that tag `applicableSpaces` entries reference by string match. - name: Leases description: >- Leases are the agreements occupying building spaces. Each lease carries its source documents and the tags (structured terms) extracted from them. - name: Documents description: >- Documents are the source files attached to leases — original leases, amendments, memorandums, etc. - name: Tags description: >- Tags are the structured lease terms Prophia extracts from documents — a rent amount, a renewal option, a key date — each cited to its location in the source document. STANDARD tags carry a typed `value`; COMPLEX tags carry option details in `tagComponents`. - name: Custom Terms description: >- Custom terms are account-level definitions of extra lease terms your team tracks beyond Prophia's standard set. Tags created from them are ordinary tags with `isCustomTag: true` — the definition and its tag instances are separate resources. - name: Custom Fields description: >- Custom Fields are Account-level fields your team tracks on Buildings beyond Prophia's standard set. A `SINGLE` field holds free text per Building; a `MULTI` field holds one of a fixed list of options. Assignments set a field's value on a Building. - name: Loans description: >- Loans are the financing agreements secured by an account's buildings. Each loan carries its source documents and the terms read from them: summary terms, covenants and reporting deliverables. Loans is a Labs feature in beta, and its endpoints may change. x-beta: true paths: /rest/v2/accounts/{accountId}/docs/upload: post: tags: - Documents summary: CREATE Document via Upload description: >- Uploads a Document as multipart form data and attaches it to a Lease. Any file type is accepted, up to 200MB. Only documents whose filename ends in `.pdf` are processed into Pages and Tags. To upload a document to a building or property level folder, simply use the buildingId or propertyId as the leaseId in the request. **Required capabilities:** `WRITE:DOCUMENT` operationId: createDocViaUpload parameters: - name: accountId in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/V2UploadLeaseDocForm' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/V2LeaseDocModel' '400': description: Invalid input — request body failed validation or business rules content: application/json: schema: $ref: '#/components/schemas/V2ErrorResponse' example: error: Invalid Input errorCode: InvalidInput message: dba cannot be blank status: 400 BAD_REQUEST timestamp: '2026-09-02T20:41:03.118Z' localizedMessage: dba cannot be blank '401': description: >- The credential was rejected before the request reached the endpoint — for example a JWT was presented where an API key is required. Only `error` is populated on this path content: application/json: schema: $ref: '#/components/schemas/V2ErrorResponse' example: error: JWT authentication is not supported. Use an API key. '403': description: >- The API key is valid but lacks a required capability or role, the account does not have the REST write module enabled, or the key's building permissions do not cover the requested resource. The message names the missing capabilities only in the first case content: application/json: schema: $ref: '#/components/schemas/V2ErrorResponse' example: error: Access Denied errorCode: AccessDenied message: 'Not authorized. Missing capabilities: WRITE:DOCUMENT' status: 403 FORBIDDEN timestamp: '2026-09-02T20:41:03.118Z' localizedMessage: 'Not authorized. Missing capabilities: WRITE:DOCUMENT' '404': description: No such resource is visible to the account named in the path content: application/json: schema: $ref: '#/components/schemas/V2ErrorResponse' example: error: Entity Not Found errorCode: EntityNotFound message: This entity is not found in the system. status: 404 NOT_FOUND timestamp: '2026-09-02T20:41:03.118Z' localizedMessage: This entity is not found in the system. '409': description: >- A non-deleted Document with this filename already exists on the Lease; nothing is stored content: application/json: schema: $ref: '#/components/schemas/V2ErrorResponse' example: error: Non Unique Entry errorCode: NonUniqueEntry message: 'This entity is required to be unique: lease.pdf' status: 409 CONFLICT timestamp: '2026-09-02T20:41:03.118Z' localizedMessage: 'This entity is required to be unique: lease.pdf' components: schemas: V2UploadLeaseDocForm: type: object description: Multipart form fields for a document upload. properties: file: type: string format: binary description: The file to upload. Any file type is accepted. leaseId: type: string description: >- Lease to attach the Document to. Must belong to the Account in the path and to a Building your api key can access. To upload a file to a Building or Property folder, simply provide the appropriate Building or Property id (UUID) in this field. Note: Does not accept `Lease.customId`. filename: type: string description: >- Name to store the Document under. Defaults to the uploaded file's own name. This is also what decides whether the file is processed: a name ending in `.pdf` runs Prophia's ingestion pipeline, anything else is stored and attached as-is with no pages or tags. Filenames must be unique for non-deleted documents residing in the same Lease. title: type: string description: Display title for the Document. Defaults to `filename` when omitted. docCategory: type: string description: >- Category to file the Document under. When omitted from this request and the document is processed (a `.pdf` filename), Prophia's AI will attempt to set the category automatically, with any discrepancies cleaned up during the subsequent onboarding process. Certain categories may be excluded from Reports (usually less critical, non-deal-related categories). enum: - Main Lease Agreement - Extension - Amendment - Expansion - Amendment - Contraction - Amendment - Move - Amendment - Correction - Amendment - New Rights - Amendment - Other - Amendment - Commencement Letter - Work Letter - Lease Abstract - Stacking Plan - Floorplan - Site Plan - Letter of Credit - Letter of Intent - Certificate of Insurance - Notices - Termination Notices - Assignment and Assumption Agreement - Telecom/Antenna Agreement - Storage Agreement - Other - Sublease Agreement - Consent to Sublease - Parking Agreement - Licensing Agreement - Guaranty - Estoppel - Management Office Agreement - Loan Agreement - Letter Agreement - JV Agreement - Closing Document - Purchase & Sale Agreement - Management Agreement - Brokerage Listing Agreement - Real Estate Tax Bills - Capital Projects - Service Agreement - Subordination, Non-Disturbance and Attornment Agreement - Ground Lease - Memorandum of Lease - Rent Roll required: - file - leaseId V2LeaseDocModel: type: object description: >- Representation of a Lease Document. Each Document belongs to one Lease and cannot be duplicated within a single Lease. properties: id: type: string description: Prophia internal Document ID (UUID). readOnly: true filename: type: string description: >- Name of the document from your file system. This can not be duplicated for multiple files in the same Lease. title: type: string description: Display title; defaults to the filename when not set. numberOfPages: type: integer format: int32 description: 1-based count of pages in the Document. readOnly: true docCategory: type: string description: >- Document classification. Certain Document categories may determine which Tags and in-app features the Document is included in. If left blank, Prophia's AI will inspect the Document and set it accordingly, with a human review to follow. The AI will not overwrite an existing category if one is already set. enum: - Main Lease Agreement - Extension - Amendment - Expansion - Amendment - Contraction - Amendment - Move - Amendment - Correction - Amendment - New Rights - Amendment - Other - Amendment - Commencement Letter - Work Letter - Lease Abstract - Stacking Plan - Floorplan - Site Plan - Letter of Credit - Letter of Intent - Certificate of Insurance - Notices - Termination Notices - Assignment and Assumption Agreement - Telecom/Antenna Agreement - Storage Agreement - Other - Sublease Agreement - Consent to Sublease - Parking Agreement - Licensing Agreement - Guaranty - Estoppel - Management Office Agreement - Loan Agreement - Letter Agreement - JV Agreement - Closing Document - Purchase & Sale Agreement - Management Agreement - Brokerage Listing Agreement - Real Estate Tax Bills - Capital Projects - Service Agreement - Subordination, Non-Disturbance and Attornment Agreement - Ground Lease - Memorandum of Lease - Rent Roll createdAt: type: string format: date-time description: When the Document was uploaded to Prophia. readOnly: true documentStatus: type: string description: >- Processing state: `processing` while the document is in Prophia's AI ingestion pipeline, then `incomplete` followed by any account specific statuses (defined by/through our operations team) and ultimately `complete` when the Document has been fully processed. To understand how this plays into the broader onboarding state of the Lease and Building see our understanding onboarding conceptual guide. readOnly: true splitStatus: type: string description: >- Whether this Document was split into parts. `single` is an ordinary Document, `combined` is an original that was split (its data lives on its parts), and `split` is a part cut from an original. enum: - single - combined - split readOnly: true originalDocId: type: string description: >- For a part (`splitStatus` = `split`), the ID of the original Document it was cut from. Omitted otherwise. readOnly: true V2ErrorResponse: type: object properties: error: type: string description: Stable error category example: Invalid Input errorCode: type: string description: Stable error code suitable for programmatic handling example: InvalidInput message: type: string description: Human-readable detail; may aggregate multiple field errors status: type: string description: >- HTTP status of the response as code and reason phrase, matching the response's own status line example: 404 NOT_FOUND timestamp: type: string format: date-time description: When the error was produced, as an ISO-8601 UTC instant example: '2026-09-02T20:41:03.118Z' localizedMessage: type: string description: >- Same text as `message`; present because the body is a serialized exception. Prefer `message` securitySchemes: apiKey: type: apiKey description: >- Prophia API key — either an account key (grants admin level permissions) or a user key with the REST scope. Send it in the `X-API-Key` header, or equivalently as `Authorization: Bearer `. JWTs are rejected on /rest endpoints with 401. name: X-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.