{"info":{"_postman_id":"4ff35d4e-c3d8-4ddf-a41a-75ec5bedf722","name":"RoiScholar API","description":"

Complete API documentation for the RoiScholar STEM Education Loan Clarity Platform.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"50840775","collectionId":"4ff35d4e-c3d8-4ddf-a41a-75ec5bedf722","publishedId":"2sBXqKoL8Z","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-05-02T11:17:25.000Z"},"item":[{"name":"Auth","item":[{"name":"Register","id":"2457918b-5c37-46aa-8d50-fe23c762a724","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"password\": \"password123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://roischolar.onrender.com/api/auth/register","description":"

This endpoint registers a new user as part of the authentication flow of the RoiScholar API. It accepts a POST request to https://roischolar.onrender.com/api/auth/register with a JSON body containing three required fields: name (the user's full name), email (a valid email address), and password (the user's chosen password). Upon successful registration, a new user account is created and the user can proceed to authenticate using the login endpoint.

\n","urlObject":{"path":["auth","register"],"host":["https://roischolar.onrender.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"2457918b-5c37-46aa-8d50-fe23c762a724"},{"name":"Login","id":"0240b001-4857-40c2-9564-78a36088454c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"john@example.com\",\n \"password\": \"password123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://roischolar.onrender.com/api/auth/login","description":"

StartFragment

Auth

Register — POST /auth/register
\n
Login — POST /auth/login
\n
Get Profile (Me) — GET /auth/me
\n
Update Password — PUT /auth/updatepassword
\n

Universities

Search Universities — GET /universities/search
\n
Compare Universities — GET /universities/compare
\n

Scholarships

List Scholarships — GET /scholarships

Applications

Submit Application — POST /applications
\n
List My Applications — GET /applications
\n

ROI & Loans

Calculate Loan — POST /loan/calculate
\n
Get Salary Data — GET /roi/salary-data
\n

EndFragment

\n","urlObject":{"path":["auth","login"],"host":["https://roischolar.onrender.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0240b001-4857-40c2-9564-78a36088454c"},{"name":"Get Profile (Me)","id":"68fca373-c807-45c5-bf56-d3e6e42a9e29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your_jwt_token_here"}]},"isInherited":false},"method":"GET","header":[],"url":"https://roischolar.onrender.com/api/auth/me","description":"

StartFragment

Auth

Register — POST /auth/register
\n
Login — POST /auth/login
\n
Get Profile (Me) — GET /auth/me
\n
Update Password — PUT /auth/updatepassword
\n

Universities 5. Search Universities — GET /universities/search 6. Compare Universities — GET /universities/compare

Scholarships 7. List Scholarships — GET /scholarships

Applications 8. Submit Application — POST /applications 9. List My Applications — GET /applications

ROI & Loans 10. Calculate Loan — POST /loan/calculate 11. Get Salary Data — GET /roi/salary-data

EndFragment

\n","urlObject":{"path":["auth","me"],"host":["https://roischolar.onrender.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"68fca373-c807-45c5-bf56-d3e6e42a9e29"},{"name":"Update Password","id":"fd18a340-cf74-47c7-aa21-a1f75e1fab30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your_jwt_token_here"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"currentPassword\": \"password123\",\n \"newPassword\": \"newSecurePass456\"\n}","options":{"raw":{"language":"json"}}},"url":"https://roischolar.onrender.com/api/auth/updatepassword","description":"

StartFragment

Register

This endpoint registers a new user as part of the authentication flow of the RoiScholar API.

Method & URL POST https://roischolar.onrender.com/api/auth/register

Request Body (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`name`	string	The user's full name
`email`	string	A valid email address
`password`	string	The user's chosen password

Behavior Upon successful registration, a new user account is created and the user can proceed to authenticate using the login endpoint.

EndFragment

\n","urlObject":{"path":["auth","updatepassword"],"host":["https://roischolar.onrender.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd18a340-cf74-47c7-aa21-a1f75e1fab30"}],"id":"a54fb398-3b51-42ba-aa14-9dc71928eeee","description":"

The Auth folder contains all endpoints related to user authentication and account management in the RoiScholar API. It covers the full authentication lifecycle — from registering a new account and logging in, to retrieving the authenticated user's profile and updating their password.

Endpoints included:

POST /auth/register — Register a new user account
POST /auth/login — Authenticate and receive an access token
GET /auth/me — Retrieve the currently authenticated user's profile
PUT /auth/updatepassword — Update the authenticated user's password

All protected endpoints in this folder require a valid Bearer token in the Authorization header.

\n","_postman_id":"a54fb398-3b51-42ba-aa14-9dc71928eeee"},{"name":"Universities","item":[{"name":"Search Universities","id":"c33e313d-fbfa-483d-8fe7-53ff516a02e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://roischolar.onrender.com/api/universities/search?q=Stanford","description":"

StartFragment

Register

This endpoint registers a new user as part of the authentication flow of the RoiScholar API.

Method & URL POST https://roischolar.onrender.com/api/auth/register

Request Body (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`name`	string	The user's full name
`email`	string	A valid email address
`password`	string	The user's chosen password

Behavior Upon successful registration, a new user account is created. The user can then proceed to authenticate using the login endpoint.

\n","urlObject":{"path":["universities","search"],"host":["https://roischolar.onrender.com/api"],"query":[{"key":"q","value":"Stanford"}],"variable":[]}},"response":[],"_postman_id":"c33e313d-fbfa-483d-8fe7-53ff516a02e6"},{"name":"Compare Universities","id":"3cb14906-a124-488c-9596-052f10aaef4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://roischolar.onrender.com/api/universities/compare?ids=id1,id2","urlObject":{"path":["universities","compare"],"host":["https://roischolar.onrender.com/api"],"query":[{"key":"ids","value":"id1,id2"}],"variable":[]}},"response":[],"_postman_id":"3cb14906-a124-488c-9596-052f10aaef4d"}],"id":"c90af3c9-f8ac-42ef-a075-51615b41e769","description":"

The Universities folder contains endpoints for discovering and evaluating universities within the RoiScholar platform. Users can search for universities by name or keyword and compare multiple institutions side by side to support informed decision-making for STEM education.

Endpoints included:

GET /universities/search — Search for universities by name or keyword (e.g., ?q=Stanford)
\n
GET /universities/compare — Compare two or more universities by their IDs (e.g., ?ids=id1,id2)
\n

\n","_postman_id":"c90af3c9-f8ac-42ef-a075-51615b41e769"},{"name":"Scholarships","item":[{"name":"List Scholarships","id":"83ac8e77-2167-4a4c-b3f4-c384deae8ee9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://roischolar.onrender.com/api/scholarships","description":"

StartFragment

Register

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`name`	The user's full name
`email`	A valid email address
`password`	The user's chosen password

Upon successful registration, a new user account is created and the user can proceed to authenticate using the login endpoint.

\n","urlObject":{"path":["scholarships"],"host":["https://roischolar.onrender.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"83ac8e77-2167-4a4c-b3f4-c384deae8ee9"}],"id":"d610bbed-9e55-449d-af27-9b94160b9197","description":"

The Scholarships folder provides endpoints for browsing available scholarships on the RoiScholar platform. Users can retrieve a list of scholarships to explore funding opportunities relevant to their STEM education goals.

Endpoints included:

GET /scholarships — Retrieve a list of all available scholarships

\n","_postman_id":"d610bbed-9e55-449d-af27-9b94160b9197"},{"name":"Applications","item":[{"name":"Submit Application","id":"03baff79-5c63-4313-9f1c-1da134972074","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your_jwt_token_here"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"universityName","value":"Stanford University","type":"text"},{"key":"degreeName","value":"MS in Computer Science","type":"text"},{"key":"fullName","value":"John Doe","type":"text"},{"key":"email","value":"john@example.com","type":"text"},{"key":"documents","type":"file","value":null}]},"url":"https://roischolar.onrender.com/api/applications","description":"

StartFragment

This endpoint registers a new user as part of the authentication flow of the RoiScholar API.

Method & URL POST https://roischolar.onrender.com/api/auth/register

Request Body (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`name`	string	The user's full name
`email`	string	A valid email address
`password`	string	The user's chosen password

Behavior Upon successful registration, a new user account is created and the user can proceed to authenticate using the login endpoint.

\n","urlObject":{"path":["applications"],"host":["https://roischolar.onrender.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"03baff79-5c63-4313-9f1c-1da134972074"},{"name":"List My Applications","id":"69587ec6-9b66-4d2d-99d0-20496ef9a628","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your_jwt_token_here"}]},"isInherited":false},"method":"GET","header":[],"url":"https://roischolar.onrender.com/api/applications","description":"

StartFragment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`name`	The user's full name
`email`	A valid email address
`password`	The user's chosen password

Upon successful registration, a new user account is created and the user can proceed to authenticate using the login endpoint.

\n","urlObject":{"path":["applications"],"host":["https://roischolar.onrender.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"69587ec6-9b66-4d2d-99d0-20496ef9a628"}],"id":"8f8d14c5-28f9-4c99-9876-b195ddd2ee94","description":"

The Applications folder contains endpoints for managing scholarship or university applications within the RoiScholar platform. Authenticated users can submit new applications and retrieve a list of their previously submitted applications.

Endpoints included:

POST /applications — Submit a new application
GET /applications — List all applications submitted by the authenticated user

These endpoints require a valid Bearer token in the Authorization header.

\n","_postman_id":"8f8d14c5-28f9-4c99-9876-b195ddd2ee94"},{"name":"ROI & Loans","item":[{"name":"Calculate Loan","id":"4f6984f8-cf02-4f48-adf7-f8e4279a1445","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 50000,\n \"interestRate\": 10,\n \"tenure\": 10\n}","options":{"raw":{"language":"json"}}},"url":"https://roischolar.onrender.com/api/loan/calculate","description":"

StartFragment

This endpoint registers a new user as part of the authentication flow of the RoiScholar API.

Method & URL POST https://roischolar.onrender.com/api/auth/register

Request Body (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`name`	string	The user's full name
`email`	string	A valid email address
`password`	string	The user's chosen password

Behavior Upon successful registration, a new user account is created and the user can proceed to authenticate using the login endpoint.

\n","urlObject":{"path":["loan","calculate"],"host":["https://roischolar.onrender.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f6984f8-cf02-4f48-adf7-f8e4279a1445"},{"name":"Get Salary Data","id":"8efd93e7-49c4-4d06-817b-f048a3622761","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://roischolar.onrender.com/api/roi/salary-data?country=USA°ree=Computer Science","description":"

StartFragment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`name`	The user's full name
`email`	A valid email address
`password`	The user's chosen password

Upon successful registration, a new user account is created and the user can proceed to authenticate using the login endpoint.

\n","urlObject":{"path":["roi","salary-data"],"host":["https://roischolar.onrender.com/api"],"query":[{"key":"country","value":"USA"},{"key":"degree","value":"Computer Science"}],"variable":[]}},"response":[],"_postman_id":"8efd93e7-49c4-4d06-817b-f048a3622761"}],"id":"4a3b7c60-8f2b-4597-9d14-a347098695c5","description":"

The ROI & Loans folder contains endpoints for financial analysis and return-on-investment calculations within the RoiScholar platform. Users can calculate estimated loan repayments and retrieve salary data by country and degree to evaluate the financial viability of their STEM education choices.

Endpoints included:

POST /loan/calculate — Calculate estimated loan repayment details based on provided parameters
GET /roi/salary-data — Retrieve salary data filtered by country and degree (e.g., ?country=USA&degree=Computer Science)

\n","_postman_id":"4a3b7c60-8f2b-4597-9d14-a347098695c5"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"5ed943b8-e471-4094-b870-854d582c2e71"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"dce6c921-39af-4737-88c9-8cdfa256ef23"}}],"variable":[{"key":"baseUrl","value":"https://roischolar.onrender.com/api"},{"key":"token","value":"your_jwt_token_here"}]}