OTP Services

Generate OTP

This API is associated with sending OTP to user on the Sunbird Platform.

• The endpoint for Generate OTP is otp/v1/generate
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

POSThttps://staging.sunbirded.org/api/otp/v1/generate

Header parameters

Body

application/json

The body refers to the format of the request.

• The body contains metadata about the notification to be sent.

request*Request

Response

200400500

OK ! Successful operation."Generate OTP" operation was successfully executed.

Body

application/json

resultSend Otp Result

idstring

API Identifier

verstring

API version information

tsstring

API execution timespan

paramsResponse Parameter

responseCodeobject

API response code

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/otp/v1/generate', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "userId": "372175df-7f44-48df-8aa5-4t6228996b06s",
        "key": "[e-mail]",
        "type": "email"
      }
    }),
});
const data = await response.json();

Response

200400500

{
  "result": {
    "response": "text"
  },
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": {}
}

Verify OTP

This API is associated with verifying the OTP of the user on the Sunbird Platform.

• The endpoint for Verifiy OTP is otp/v1/verify
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• The Otp provided in the request is verified with the available otp generated for the user within the sunbird system.

POSThttps://staging.sunbirded.org/api/otp/v1/verify

Header parameters

Body

application/json

The body refers to the format of the request.

• The body contains metadata about the notification to be sent.

request*Request

Response

200400500

OK ! Successful operation."Verify Otp" operation was successfully executed.

Body

application/json

resultSend Otp Result

idstring

API Identifier

verstring

API version information

tsstring

API execution timespan

paramsResponse Parameter

responseCodeobject

API response code

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/otp/v1/verify', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "userId": "372175df-7f44-48df-8aa5-4t6228996b06s",
        "key": "[e-mail]",
        "type": "email",
        "otp": "79562"
      }
    }),
});
const data = await response.json();

Response

200400500

{
  "result": {
    "response": "text"
  },
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": {}
}