Document
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a single applicant document (binary data).
URI
/api/v9/applications/ID/documents/IDGET 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 |