Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/harshalw2003/BidAuc/llms.txt

Use this file to discover all available pages before exploring further.

BidAuc uses a phone-based OTP flow for all authentication. Before you can register a new account or sign in to an existing one, you must request a one-time password for the target phone number. This endpoint initiates that flow by generating an OTP tied to the provided number and (in production) delivering it via SMS.

​
Endpoint

POST /user/generateOtp
No authentication is required for this endpoint.

​
Request body

​
phoneNumber
string
required
The 10-digit phone number to send the OTP to (e.g., "9876543210"). Must match the number you will use in the subsequent register or login call.

​
Example request

curl -X POST http://localhost:5000/user/generateOtp \
  -H "Content-Type: application/json" \
  -d '{"phoneNumber": "9876543210"}'

​
Response

​
Success — 200 OK

{
  "message": "OTP Sent successfully",
  "success": true
}
​
message
string
Human-readable status message confirming the OTP was dispatched.
​
success
boolean
true when the OTP was created and sent without errors.

​
Error

{
  "message": "Error Sending OTP",
  "success": false,
  "error": "<error detail>"
}
​
message
string
Indicates the OTP could not be sent.
​
success
boolean
false when the operation failed.
​
error
string
Internal error detail for debugging.
In development, Twilio SMS delivery is disabled. The OTP is always 123456 regardless of the phone number provided. Do not rely on this value in production builds.

Build docs developers (and LLMs) love

Get started for freeTalk to us