Operations

Retrieve an upload

Retrieve the metadata for an existing upload by its ID.

GET

/ v1 / uploads / {upload_id}

Retrieve the metadata for an existing upload. The response includes the file format, size, SHA-256 hash, retention type, and creation time.

This endpoint returns upload metadata only. You cannot download the file content through the API.

The Retrieve Upload endpoint replaces the Get File endpoint. The File resource is soft-deprecated but remains available for backward compatibility.

Path Parameters

upload_id

string

required

The unique identifier of the upload.

Returns

Returns a 200 OK status code and an upload object on success, or an error otherwise.

// GET https://api.signatureapi.com/v1/uploads/{upload_id}
// X-API-Key: key_test_...

// HTTP/1.1 200 OK
{
  "id": "upl_1sAAaVfabdt0esVjmSTmLA",
  "retention": "temporary",
  "url": "https://api.signatureapi.com/v1/uploads/upl_1sAAaVfabdt0esVjmSTmLA",
  "format": "pdf",
  "sha_256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "size": 102400,
  "created_at": "2025-12-30T12:00:00.000Z",
  "expires_at": "2025-12-31T12:00:00.000Z"
}

// HTTP/1.1 200 OK
{
  "id": "upl_3joO7lxE8HVhOZmkCHFCxK",
  "retention": "permanent",
  "key": "contract-template-v2",
  "url": "https://api.signatureapi.com/v1/uploads/upl_3joO7lxE8HVhOZmkCHFCxK",
  "format": "docx",
  "sha_256": "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789",
  "size": 234567,
  "created_at": "2025-12-30T12:00:00.000Z"
}