---
title: "Request a shipment document upload"
method: POST
path: "/shipments/documents"
tags: ["Shipments"]
---

# Request a shipment document upload

`POST /shipments/documents`

## Request

- Base URL: `https://app-sandbox.resolvepay.com/api`
- URL: `https://app-sandbox.resolvepay.com/api/shipments/documents`
- Auth: one of:
  - HTTP bearer
  - HTTP basic
- TypeScript: <https://skmtc.dev/resolvepay/apis/resolve-api-reference/docs/shipments/documents/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a pending proof-of-delivery document before creating a self-fulfilled shipment.
Upload the file with every returned `upload_headers` entry, including
`Content-Type` (the requested `filetype`), poll `/shipments/documents/{file_id}` until
validation succeeds, then supply `file_id` to `/shipments`.

## Request body

- SignUploadRequest
  - `filename` string, required: Original filename for the file to be uploaded.
  - `filetype` string, required: MIME type of the file.

## Response `200`

Pending shipment document upload request.

- ShipmentDocumentUploadResponse
  - `id` string, required
  - `file_id` string, required: Use when creating a self-fulfilled shipment after validation succeeds.
  - `url` string, uri, required: Stable storage URL for the staged document.
  - `upload_url` string, uri, required: Presigned S3 URL for uploading the file. Use this URL to PUT the file content.
  - `upload_expires_at` string, date-time, required
  - `object_key` string, required
  - `transfer_method` 'presigned_upload', required
  - `upload_headers` object, required
  - `validation_profile` 'merchant_invoice_shipment_document_default', required

## Other responses

- `400`: Bad request error
- `401`: Unauthorized error
- `429`: Rate limit error

---

[API](https://skmtc.dev/resolvepay/apis/resolve-api-reference.md) - [All operations](https://skmtc.dev/resolvepay/apis/resolve-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/resolvepay/apis/resolve-api-reference/revisions/c62edc454aaa?raw)