Beautifully designed backend verification for developers. Authentication enabled, fully documented, and ready for integration.
Create a new user account. Returns user details and an access token to be used for subsequent requests.
{
"name": "John Doe",
"email": "john@example.com",
"password": "strongPassword123"
}
{
"success": true,
"statusCode": 200,
"message": "User newly created successfully",
"data": {
"accessToken": "ey...",
"needsPasswordChange": false
}
}
Authenticate an existing user. Requires email and password.
{
"email": "john@example.com",
"password": "strongPassword123"
}
{
"success": true,
"statusCode": 200,
"message": "User logged in successfully",
"data": {
"accessToken": "ey...",
"needsPasswordChange": false
}
}
Generate a new access token using a refresh token.
{
"cookies": {
"refreshToken": "..."
}
}
{
"success": true,
"statusCode": 200,
"message": "New access token generated successfully",
"data": {
"accessToken": "ey..."
}
}
Change the current user's password.
{
"oldPassword": "strongPassword123",
"newPassword": "newStrongPassword456"
}
{
"success": true,
"statusCode": 200,
"message": "Password changed successfully"
}
Initiate password reset flow.
{
"email": "john@example.com"
}
{
"success": true,
"statusCode": 200,
"message": "Reset link sent to email"
}
Verify email address using a one-time code.
{
"email": "john@example.com",
"oneTimeCode": "123456"
}
{
"success": true,
"statusCode": 200,
"message": "Email verified successfully"
}
Reset the password using a verified token/code.
{
"email": "john@example.com",
"newPassword": "newStrongPassword789",
"token": "reset_token_here"
}
{
"success": true,
"statusCode": 200,
"message": "Password reset successfully"
}
Permanently delete the user account.
{
"password": "currentPassword123"
}
{
"success": true,
"statusCode": 200,
"message": "Account deleted successfully"
}
Retrieve the profile information of the currently logged-in user.
{
"success": true,
"statusCode": 200,
"message": "Profile retrieved successfully",
"data": {
"_id": "651a...",
"name": "John Doe",
"email": "john@example.com",
"image": "..."
}
}
Update the current user's profile information.
{
"name": "John Updated",
"image": "https://example.com/new-pic.jpg"
}
{
"success": true,
"statusCode": 200,
"message": "Profile updated successfully",
"data": {
"name": "John Updated",
...
}
}
Get public information of a specific user by their ID.
{
"success": true,
"statusCode": 200,
"message": "User retrieved successfully",
"data": {
"_id": "651a...",
"name": "Jane Doe",
"email": "jane@example.com"
}
}
Get a list of all users.
{
"success": true,
"statusCode": 200,
"message": "Users retrieved successfully",
"data": [
{ "name": "User 1", ... },
{ "name": "User 2", ... }
]
}
Create a new post.
{
"description": "My first post on this platform!",
"image": "https://example.com/post.jpg"
}
{
"success": true,
"statusCode": 200,
"message": "Post created successfully",
"data": {
"_id": "...",
"description": "My first post...",
"userId": "..."
}
}
Get all posts. This is a public endpoint.
{
"success": true,
"statusCode": 200,
"message": "Posts retrieved successfully",
"data": [
{ "description": "Post 1", ... },
{ "description": "Post 2", ... }
]
}
Get a single post by ID.
{
"success": true,
"statusCode": 200,
"message": "Post retrieved successfully",
"data": {
"_id": "...",
"description": "..."
}
}
Add a comment to a post.
{
"postId": "651a...",
"comment": "This is a great post!"
}
{
"success": true,
"statusCode": 200,
"message": "Comment created successfully",
"data": { ... }
}
Get a single comment by ID.
{
"success": true,
"statusCode": 200,
"message": "Comment retrieved successfully",
"data": {
"_id": "...",
"comment": "This is a great post!",
"postId": "..."
}
}
Get all comments.
{
"success": true,
"statusCode": 200,
"message": "Comments retrieved successfully",
"data": [ ... ]
}
Upload a single file (image).
multipart/form-data
Field name: image
{
"success": true,
"statusCode": 200,
"message": "File stored successfully",
"data": "url_to_image"
}
Upload multiple files.
multipart/form-data
Field name: image
(multiple)
{
"success": true,
"statusCode": 200,
"message": "Files stored successfully",
"data": [ "url1", "url2" ]
}