PostalForm

PostalForm Documents API

The Documents API from PostalForm — 2 operation(s) for documents.

Documentation GitHub OpenAPI

Operations 2

POST /api/v1/documents/upload-intent Create a PDF upload intent #

POST /api/v1/documents/{document_id}/complete Mark an uploaded document complete after the object is present #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/postalform-com:postalform-com-documents-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: PostalForm Projects Public Documents API
  version: '2026-05-06'
  description: Public PostalForm Projects API for customer SDKs. Includes document uploads, quotes, mail orders, credits, API keys, and signed customer webhooks.
servers:
- url: https://projects.postalform.com
tags:
- name: Documents
paths:
  /api/v1/documents/upload-intent:
    post:
      summary: Create a PDF upload intent
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                content_type:
                  type: string
                  const: application/pdf
                byte_size:
                  type: integer
                  minimum: 1
                  maximum: 26214400
                  description: PDF size in bytes. Projects currently limits uploads to 25 MiB while preparation runs inside the Worker memory budget.
                page_count:
                  type: integer
                  minimum: 1
                  description: Optional known PDF page count. Used for quote validation and pricing if supplied.
              required:
              - content_type
              - byte_size
      responses:
        '200':
          description: Upload instructions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadIntent'
      operationId: createUploadIntent
      tags:
      - Documents
  /api/v1/documents/{document_id}/complete:
    post:
      summary: Mark an uploaded document complete after the object is present
      security:
      - bearerAuth: []
      parameters:
      - $ref: '#/components/parameters/DocumentId'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                page_count:
                  type: integer
                  minimum: 1
                  description: Optional PDF page count if it was not supplied during upload-intent creation.
      responses:
        '200':
          description: Validated document.
          content:
            application/json:
              schema:
                type: object
                properties:
                  document_id:
                    type: string
                  status:
                    type: string
                    enum:
                    - validated
      operationId: completeDocumentUpload
      tags:
      - Documents
components:
  schemas:
    UploadIntent:
      type: object
      properties:
        document_id:
          type: string
        upload_url:
          type: string
          format: uri
        upload_method:
          type: string
          enum:
          - PUT
        expires_at:
          type: string
          format: date-time
  parameters:
    DocumentId:
      name: document_id
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer