ZIP archive

Mon, 01 Jan 0001 00:00:00 +0000

Represents a ZIP archive with all documents attached to an application.

URI

/api/v9/applications/ID/documents/zip

Download attached documents

Retrieve all documents attached to an application as a ZIP archive (binary data).

DreamApply organizes the ZIP archive using the following rules:

Source retrieval: The archive includes documents uploaded via the Documents section of the application edit page and those uploaded via tasks (including active and trashed tasks). Task-related files are placed in folders named after the specific task.
Duplicate file names: If multiple files have the same name, DreamApply appends a unique suffix to differentiate them.
PDF previews: For PDF files with 9 or fewer pages, DreamApply automatically generates JPEG previews — one preview file per PDF page. By default, the ZIP archive includes both the original PDF files and previews. To download only the original PDF files without previews, use the skip-extracted-pages parameter.

You can also download documents attached to a specific task. For details, see GET api/applications/ID/tasks/ID/documents/zip.

Document

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single applicant document (binary data).

URI

/api/v9/applications/ID/documents/ID

Get a document

Retrieve the document (binary) data.

Syntax

GET /api/v9/applications/123/documents/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/documents/1"

Response headers

Header	Value	Description
`Content-Type`	`image/jpeg`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`Last-Modified`	`2025-05-16T14:59:53+00:00`	Date and time when the document was last modified

Response codes

Response code	Description
`200 OK`	The binary data of the document was successfully returned
`404 Not Found`	This document does not belong to this application

Documents on DreamApply Knowledge Base