Consents

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a list of consents associated with an applicant. For a list of available consents in the system, see Consents (global).

URI
/api/v9/applicants/ID/consents

List associated consents

Get a list of consent associations for the applicant in question.

This request does not return the consents themselves, but rather represents the relationships between an applicant and consents. Follow the consent URI in the response to retrieve further information about the consent in question.

Syntax
GET /api/v9/applicants/123/consents
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/applicants/123/consents"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`X-Count`	`2`	Number of returned consents

Response codes

Response code	Description
`200 OK`	The list of consents was successfully returned

Example response

Response
{
  "1": {
    "decided": "2025-08-05T12:13:02+00:00",
    "decision": "Accept",
    "consent": "/api/v9/applicants/consents/1"
  },
  "2": {
    "decided": "2025-11-24T12:07:18+00:00",
    "decision": "Reject",
    "consent": "/api/v9/applicants/consents/2"
  }
}

Photo

Consent