User OTP Service

Overview

User-OTP service handles the OTP for user registration, user log in and password reset for a particular user.

Pre-requisites

Before you proceed with the documentation, make sure the following pre-requisites are met -

• Java 17

• egov-user service is running

• egov-localization service is running

• egov-otp service is running

Key Functionalities

The User-OTP service sends the OTP to the user on login request, on password change request and during new user registration.

Deployment Details

1. Deploy the latest version of user-otp.

2. Make sure egov-otp is running.

3. Add Role-Action mapping for APIs.

Integration Details

Integration Scope

User-OTP service handles the OTP for user registration, user login and password reset for a particular user.

Integration Benefits

• Can perform user registration, login, and password reset.

• In the future, if we want to expose the application to citizens then it can be done easily.

Integration Steps

1. To integrate, the host of user-otp module should be overwritten in the helm chart.

2. /user-otp/v1/_send should be added as the endpoint for sending OTP to the user via sms or email

Reference Docs

Play around with the API's : DIGIT-Playground

Doc Links

Title	Link
API Postman Collection	Postman Collection

API Details

BasePath /user-otp/v1/[API endpoint]

Method

a) POST /_send

This method sends the OTP to a user via sms or email based on the below parameters -

Input Field	Description	Mandatory	Data Type
tenantId	Unique id for a tenant.	Yes	String
mobileNumber	Mobile number of the user	Yes	String
type	OTP type ex: login/register/password reset	Yes	String
userType	Type of user ex: Citizen/Employee	No	String

Producers

• Following are the Producer topic.

  • egov.core.notification.sms.otp :- This topic is used to send OTP to user mobile number.

  • org.egov.core.notification.email :- This topic is used to send OTP to user email id.