``
\nThis API allows users to manage their accounts and apply for loans. Administrators have additional capabilities to manage users and loan applications.
\nhttp://localhost:8080
Endpoint: POST /users/register
Description: Register a new user.
\nRequest Body:
\n {\n \"email\": \"string\",\n \"password\": \"string\"\n }\n\nResponses:
\n200 OK: User registered successfully.
400 Bad Request: Invalid request format.
500 Internal Server Error: Registration failed.
Endpoint: POST /users/login
Description: Authenticate a user and generate access and refresh tokens.
\nRequest Body:
\n {\n \"email\": \"string\",\n \"password\": \"string\"\n }\n\nResponses:
\n200 OK: Tokens issued.
400 Bad Request: Invalid request format.
401 Unauthorized: Authentication failed.
Endpoint: GET /users/verify-email
Description: Verify user's email address.
\nQuery Parameters:
\nemail (string): The user's email address.
token (string): Verification token.
Responses:
\n200 OK: User verified successfully.
500 Internal Server Error: Verification failed.
Endpoint: POST /users/password-reset/:email
Description: Request a password reset.
\nPath Parameter:
\nemail (string): The user's email address.Responses:
\n200 OK: Reset request message.
500 Internal Server Error: Password reset request failed.
Endpoint: POST /users/password-update
Description: Reset the user's password.
\nQuery Parameters:
\nemail (string): The user's email address.
token (string): Reset token.
password (string): New password.
Responses:
\n200 OK: Password updated successfully.
500 Internal Server Error: Password update failed.
Endpoint: GET /users/profile
Description: Retrieve user profile by ID (requires authentication).
\nResponses:
\n200 OK: User profile.
401 Unauthorized: Authentication required.
404 Not Found: User not found.
Endpoint: GET /users/token/refresh
Description: Refresh the user's access and refresh tokens.
\nRequest Body:
\n {\n \"email\": \"string\",\n \"password\": \"string\"\n }\n\nResponses:
\n200 OK: New access and refresh tokens.
400 Bad Request: Invalid request format.
401 Unauthorized: Invalid credentials.
Endpoint: GET /admin/users
Description: Retrieve a list of all users (admin only).
\nResponses:
\n200 OK: List of users.
401 Unauthorized: Admin access required.
Endpoint: GET /admin/users/:id
Description: Retrieve a user profile by ID (admin only).
\nPath Parameter:
\nid (string): User ID.Responses:
\n200 OK: User profile.
401 Unauthorized: Admin access required.
404 Not Found: User not found.
Endpoint: DELETE /admin/users/:id
Description: Delete a user by ID (admin only).
\nPath Parameter:
\nid (string): User ID.Responses:
\n200 OK: User deleted.
401 Unauthorized: Admin access required.
404 Not Found: User not found.
403 Forbidden: Cannot delete admin user.
400 Bad Request: The request could not be understood or was missing required parameters.
401 Unauthorized: Authentication credentials were missing or invalid.
403 Forbidden: The request is understood but not allowed.
404 Not Found: The requested resource could not be found.
500 Internal Server Error: An error occurred on the server.
Endpoint: POST /loans/
Description: Apply for a new loan (requires authentication).
\n{ \"amount\": \"number\", \"term\": \"number\" }
\nResponses:
\n201 Created: Loan application created.
400 Bad Request: Invalid request format.
401 Unauthorized: Authentication required.
500 Internal Server Error: Application failed.
Endpoint: GET /loans/:id
Description: Retrieve the status of a specific loan.
\nPath Parameter:
\nid (string): Loan ID.Responses:
\n200 OK: Loan status.
404 Not Found: Loan not found.
Endpoint: GET /admin/loans
Description: Retrieve all loan applications (admin only).
\nQuery Parameters:
\nstatus (string): Filter by loan status.
order (string): Sort order (e.g., ascending, descending).
Responses:
\n200 OK: List of loans.
401 Unauthorized: Admin access required.
Endpoint: PATCH /admin/loans/:id/status
Description: Update the status of a loan application (admin only).
\nPath Parameter:
\nid (string): Loan ID.{ \"status\": \"string\" }
\nResponses:
\n200 OK: Loan status updated.
400 Bad Request: Invalid request format.
401 Unauthorized: Admin access required.
500 Internal Server Error: Status update failed.
Endpoint: DELETE /admin/loans/:id
Description: Delete a specific loan application (admin only).
\nPath Parameter:
\nid (string): Loan ID.Responses:
\n200 OK: Loan deleted.
401 Unauthorized: Admin access required.
500 Internal Server Error: Deletion failed.