{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0a5e07a2-a665-4e10-abda-e5dbfd8bbff3","name":"Loan Tracker","description":"\\`\\`\n\n# Loan Tracker API Documentation\n\n## Overview\n\nThis API allows users to manage their accounts and apply for loans. Administrators have additional capabilities to manage users and loan applications.\n\n## Base URL\n\n`http://localhost:8080`\n\n## User Endpoints\n\n### Register a User\n\n- **Endpoint:** `POST /users/register`\n    \n- **Description:** Register a new user.\n    \n- **Request Body:**\n    \n    ``` json\n      {\n        \"email\": \"string\",\n        \"password\": \"string\"\n      }\n    \n     ```\n    \n- **Responses:**\n    \n    - `200 OK`: User registered successfully.\n        \n    - `400 Bad Request`: Invalid request format.\n        \n    - `500 Internal Server Error`: Registration failed.\n        \n\n### Authenticate a User\n\n- **Endpoint:** `POST /users/login`\n    \n- **Description:** Authenticate a user and generate access and refresh tokens.\n    \n- **Request Body:**\n    \n    ``` json\n      {\n        \"email\": \"string\",\n        \"password\": \"string\"\n      }\n    \n     ```\n    \n- **Responses:**\n    \n    - `200 OK`: Tokens issued.\n        \n    - `400 Bad Request`: Invalid request format.\n        \n    - `401 Unauthorized`: Authentication failed.\n        \n\n### Verify Email\n\n- **Endpoint:** `GET /users/verify-email`\n    \n- **Description:** Verify user's email address.\n    \n- **Query Parameters:**\n    \n    - `email` (string): The user's email address.\n        \n    - `token` (string): Verification token.\n        \n- **Responses:**\n    \n    - `200 OK`: User verified successfully.\n        \n    - `500 Internal Server Error`: Verification failed.\n        \n\n### Request Password Reset\n\n- **Endpoint:** `POST /users/password-reset/:email`\n    \n- **Description:** Request a password reset.\n    \n- **Path Parameter:**\n    \n    - `email` (string): The user's email address.\n        \n- **Responses:**\n    \n    - `200 OK`: Reset request message.\n        \n    - `500 Internal Server Error`: Password reset request failed.\n        \n\n### Reset Password\n\n- **Endpoint:** `POST /users/password-update`\n    \n- **Description:** Reset the user's password.\n    \n- **Query Parameters:**\n    \n    - `email` (string): The user's email address.\n        \n    - `token` (string): Reset token.\n        \n    - `password` (string): New password.\n        \n- **Responses:**\n    \n    - `200 OK`: Password updated successfully.\n        \n    - `500 Internal Server Error`: Password update failed.\n        \n\n### Find User by ID\n\n- **Endpoint:** `GET /users/profile`\n    \n- **Description:** Retrieve user profile by ID (requires authentication).\n    \n- **Responses:**\n    \n    - `200 OK`: User profile.\n        \n    - `401 Unauthorized`: Authentication required.\n        \n    - `404 Not Found`: User not found.\n        \n\n### Refresh Token\n\n- **Endpoint:** `GET /users/token/refresh`\n    \n- **Description:** Refresh the user's access and refresh tokens.\n    \n- **Request Body:**\n    \n    ``` json\n      {\n        \"email\": \"string\",\n        \"password\": \"string\"\n      }\n    \n     ```\n    \n- **Responses:**\n    \n    - `200 OK`: New access and refresh tokens.\n        \n    - `400 Bad Request`: Invalid request format.\n        \n    - `401 Unauthorized`: Invalid credentials.\n        \n\n## Admin Endpoints\n\n### Get All Users\n\n- **Endpoint:** `GET /admin/users`\n    \n- **Description:** Retrieve a list of all users (admin only).\n    \n- **Responses:**\n    \n    - `200 OK`: List of users.\n        \n    - `401 Unauthorized`: Admin access required.\n        \n\n### Find User by ID (Admin)\n\n- **Endpoint:** `GET /admin/users/:id`\n    \n- **Description:** Retrieve a user profile by ID (admin only).\n    \n- **Path Parameter:**\n    \n    - `id` (string): User ID.\n        \n- **Responses:**\n    \n    - `200 OK`: User profile.\n        \n    - `401 Unauthorized`: Admin access required.\n        \n    - `404 Not Found`: User not found.\n        \n\n### Delete User (Admin)\n\n- **Endpoint:** `DELETE /admin/users/:id`\n    \n- **Description:** Delete a user by ID (admin only).\n    \n- **Path Parameter:**\n    \n    - `id` (string): User ID.\n        \n- **Responses:**\n    \n    - `200 OK`: User deleted.\n        \n    - `401 Unauthorized`: Admin access required.\n        \n    - `404 Not Found`: User not found.\n        \n    - `403 Forbidden`: Cannot delete admin user.\n        \n\n## Error Codes\n\n- `400 Bad Request`: The request could not be understood or was missing required parameters.\n    \n- `401 Unauthorized`: Authentication credentials were missing or invalid.\n    \n- `403 Forbidden`: The request is understood but not allowed.\n    \n- `404 Not Found`: The requested resource could not be found.\n    \n- `500 Internal Server Error`: An error occurred on the server.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"37276877","team":6410705,"collectionId":"0a5e07a2-a665-4e10-abda-e5dbfd8bbff3","publishedId":"2sAXjGduTp","public":true,"publicUrl":"https://documenter-api.postman.tech/view/37276877/2sAXjGduTp","privateUrl":"https://go.postman.co/documentation/37276877-0a5e07a2-a665-4e10-abda-e5dbfd8bbff3","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2024-08-27T15:43:17.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/2af910ce3b460a89c2d20fc61c2ebbf64f4cf6227a50c0a784f086999cb06bd6","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAXjGduTp"}