API ReferenceAuthentication
Request OTP for authentication
POST
/v1/auth/request-otpRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/auth/request-otp" \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com" }'{ "success": true, "statusCode": 200, "message": "Request processed successfully", "timestamp": "2025-10-20T16:30:00.000Z", "path": "/v1/auth/register", "data": { "message": "OTP has been sent to your email" }}{ "success": false, "statusCode": 400, "message": "Validation failed", "errors": [ { "field": "email", "message": "Email must be a valid email address" } ], "timestamp": "2025-10-20T16:30:00.000Z", "path": "/v1/auth/register"}