Send OTP to a user.

POST /api/v1/send-otp

Send OTP to a user email.

application/json

Body Required

email string Required

The email address of the user.

Responses

401 */*

Unauthorized
Hide response attribute Show response attribute object
- error object
  
  Hide error attributes Show error attributes object
  
  code string
  
  message string
  
  target string
  
  details array[object]
  
  Hide details attributes Show details attributes object
  
  code string
  
  message string
  
  target string
404 */*

Not Found
Hide response attribute Show response attribute object
- error object
  
  Hide error attributes Show error attributes object
  
  code string
  
  message string
  
  target string
  
  details array[object]
  
  Hide details attributes Show details attributes object
  
  code string
  
  message string
  
  target string
500 */*

Internal Server Error
Hide response attribute Show response attribute object
- error object
  
  Hide error attributes Show error attributes object
  
  code string
  
  message string
  
  target string
  
  details array[object]
  
  Hide details attributes Show details attributes object
  
  code string
  
  message string
  
  target string
400 */*

Bad Request
Hide response attribute Show response attribute object
- error object
  
  Hide error attributes Show error attributes object
  
  code string
  
  message string
  
  target string
  
  details array[object]
  
  Hide details attributes Show details attributes object
  
  code string
  
  message string
  
  target string
200 */*

OTP sent.
Hide response attribute Show response attribute object
- message string

POST /api/v1/send-otp

curl \
 --request POST 'http://localhost:8080/api/v1/send-otp' \
 --header "Content-Type: application/json" \
 --data '{"email":"abc@xyz.com"}'

Request examples

{
  "email": "abc@xyz.com"
}

Response examples (401)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ]
  }
}

Response examples (404)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ]
  }
}

Response examples (500)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ]
  }
}

Response examples (400)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ]
  }
}

Response examples (200)

{
  "message": "string"
}