Store an upload

Convert a temporary upload into a permanent upload that does not expire.

POST /v1/uploads/{uploadId}/store

Request

// POST https://api.signatureapi.com/v1/uploads/{uploadId}/store
// X-API-Key: key_test_...
// Content-Type: application/json

{
    "key": "contract-template-v2"
}

Response

// HTTP Status Code 200

{
  "id": "upl_1sAAaVfabdt0esVjmSTmLA",
  "retention": "permanent",
  "key": "contract-template-v2",
  "url": "https://api.signatureapi.com/v1/uploads/upl_1sAAaVfabdt0esVjmSTmLA",
  "format": "pdf",
  "sha_256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "size": 102400,
  "created_at": "2025-12-30T12:00:00.000Z"
}

Convert a temporary upload into a permanent upload. The file is moved to permanent storage and no longer expires. A unique key is required to identify the permanent upload.

Use this endpoint when you want to reuse a file across multiple envelopes without re-uploading it each time. For example, store a company logo or a contract template that you reference repeatedly.

Once stored, the upload’s retention changes from temporary to permanent and the expires_at property is removed. The upload id and url remain the same.

Path Parameters

uploadId · string · required

The unique identifier of the upload to store.

Body Parameters

key · string · required

A unique identifier for the upload within your account. Only lowercase letters, numbers, hyphens, and underscores are allowed. Maximum 100 characters.

// POST https://api.signatureapi.com/v1/uploads/{uploadId}/store
// X-API-Key: key_test_...
// Content-Type: application/json

{
    "key": "acme-logo"
}

Returns

Returns a 200 OK status code and an upload object with retention set to permanent, or an error otherwise.

Request

// POST https://api.signatureapi.com/v1/uploads/{uploadId}/store
// X-API-Key: key_test_...
// Content-Type: application/json

{
    "key": "contract-template-v2"
}

Response

// HTTP Status Code 200

{
  "id": "upl_1sAAaVfabdt0esVjmSTmLA",
  "retention": "permanent",
  "key": "contract-template-v2",
  "url": "https://api.signatureapi.com/v1/uploads/upl_1sAAaVfabdt0esVjmSTmLA",
  "format": "pdf",
  "sha_256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "size": 102400,
  "created_at": "2025-12-30T12:00:00.000Z"
}