OTP Services

PreviousConsent Management NextTenant Configurations

Last updated 2 years ago

Was this helpful?

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.

post

/otp/v1/generate

Header parameters

Authorizationstringrequired

To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

Body

requestRequestrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/otp/v1/generate' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"userId":"372175df-7f44-48df-8aa5-4t6228996b06s","key":"amit@gmail.com","type":"email"}}'

200

400

500

{
  "id": "api.otp.generate",
  "ver": "v1",
  "ts": "2020-12-01 10:49:01:948+0000",
  "responseCode": "OK",
  "params": {
    "resmsgid": null,
    "msgid": "12eb0ca45ce4c776fab994d120bedd41",
    "err": null,
    "status": "success",
    "errmsg": "null."
  },
  "result": {
    "response": "SUCCESS"
  }
}

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

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.