Dartmouth API Developer Portal
Financial Aid Applicants API
Returns information about financial aid status for undergraduate applicants. Information is available for active aid years only.
Rating
Attribute | Value |
---|---|
Highly Available | Yes |
Cache Refresh Interval | 30 minutes |
Filtering | Yes |
Required Scopes
Scope | Description |
---|---|
api:financial_aid:read.sensitive | This scope is required in order to read financial aid status. Granting of this scope is via the Financial Aid Office |
api:financial_aid:read.highlysensitive | This scope is required in order to read birth_date, is_veteran, and questbridge_scholar_code. Granting of this scope is via the Financial Aid Office |
api:financial_aid:read.ssn | This scope is required in order to read ssn. Granting of this scope is via the Financial Aid Office |
urn:dartmouth:people:private | This optional scope is required in order to get financial aid status for FERPA-protected students. Granting of this scope is via the Undergraduate Registrars Office |
Request
GET /api/financial_aid/applicants/{id}
Required Headers
Authorization: Bearer {jwt}
Parameters
Parameter Name | Type | Description | Valid values | Required |
---|
(standard filter parameters as documented in the introduction section of this portal)
Notes on usage
When {id} is excluded from the URL, all records are returned as a collection. Standard filtering via URL parameters is also available and returns a collection; the collection will be empty if no records are qualified by the filtering.
There is one record for each pidm+aid_year_code.
This API will typically be used to get a set of records via filtering (e.g. aid_year_code=2122&is_application_complete=false)
Business Logic
The {id} attribute is a unique hexidecimal string generated when the object is initially cached.
Returns
Status Code | Description |
---|---|
200 | {id} requested exists or was not specified |
404 | {id} requested does not exist |
Sample Request
https://api.dartmouth.edu/api/financial_aid/applicants/641de7ce71d990dd15d05661
Sample Return
{
"address": {
"street1": "404 Sunset Hill Rd",
"street2": null,
"street3": null,
"city": "Randolph",
"state_id": "VT",
"postal_code": "05060",
"country": null
},
"aid_year_code": "2324",
"birth_date": "2005-08-31T04:00:00Z",
"cache_date": "2023-07-20T12:31:18Z",
"citizenship_country": "United States of America",
"citizenship_type_id": "U",
"dartid": "@02890000",
"early_decision_code": "U1",
"email_address": "jdoe@gmail.comXXX",
"first_name": "Joyce",
"id": "641de7ce71d990dd15d05661",
"is_application_complete": true,
"is_usa_citizen": true,
"is_veteran": false,
"last_name": "Doe",
"latest_decision_code": "U1",
"middle_name": null,
"name": "Joyce Doe",
"name_prefix": null,
"name_suffix": null,
"officer_initials": "XXX",
"parent_email_address": "parent@gmail.comXXX",
"pidm": 3068438,
"preferred_first_name": "Joyce",
"questbridge_scholar_code": null,
"school_id": "UG",
"ssn": "*****2749"
}