post-request

Description: This API is used to send the OTP to the customer.
Base URL: https://apidev.iserveu.online/{EndPoint}
Endpoint: /common/dmt-lite/unified/otp/send

Headers

Content-Type: application/JSON
client_id: To be shared during integration
client_secret: To be shared during integration

 

Request Body Parameters

Parameters Description Data Type Validation with Sample Mandatory/ Optional
customerMobileNumber Customer Mobile Number String 10 digit mobile number
E.g-8144094480
Mandatory
externalRefNumber External Reference Number (Max. limit 6 to 22). (Mandatory for OTP type 2) String min-6 & max-22 char/digit
E.g-1432452
Mandatory
requestedAmount Requested Amount(Mandatory for OTP type 2) String 1001 Optional
username Username String isutestapi1 Mandatory
otpType OTP Type would be 1 for Customer Registration and 2 for Transaction String 1 Mandatory
latLong Comma separated Latitude Longitude String 123.23,21.345 Optional
publicIP Public IP of Transaction device String 192.168.1.1 Optional
ovdType OVD Type String Aadhaar Card Mandatory
ovdData OVD Data (Optional for OTP type-2) String 12 digit Aadhaar numer
E.g-765386439745
Mandatory
paramA To be used as per client requirement String to be used as per descretion Optional
paramB To be used as per client requirement String to be used as per descretion Optional
paramC To be used as per client requirement String to be used as per descretion Optional

Sample Request Body


NOTE -
  1. For “otpType”: “1”
    • External Reference number is not required; OVD data is mandatory.
    • The OTP remains valid for 10 minutes.
    • If the OTP is not received or if it expires, the user can request a resend after 30 seconds.
    • The user is allowed 5 attempts to enter the correct OTP.
  2. For “otpType”: “2”
    • External Reference number is mandatory; OVD data is optional.
    • To regenerate the OTP, the client Reference ID must be changed.
    • For OTP Type 2, the external reference ID, mobile number, and user name should remain the same in both the Send OTP and OTP validation.

Response Body Parameters

Parameters Description Data Type
status Transaction Enquiry Status Code. String
statusCode Code of the transaction status String
statusDesc Status Description String
paramA To be used as per client requirement String
paramB To be used as per client requirement String
paramC To be used as per client requirement String

Sample Response Body


Success:

{
  "status": "SUCCESS",
  "statusCode": "0",
  "statusDesc": "OTP Sent Successfully."
  "paramA": " ",
  "paramB": " ",
  "paramC": " "
}

Failed:

{
  "status": "FAILED",
  "statusCode": "1",
  "statusDesc": "Failed to send OTP"
  "paramA": "",
  "paramB": "",
  "paramC": ""
}

Response Codes

Status Code Response Type Description HTTP Status Code
0 SUCCESS OTP Sent Successfully 200
-1 FAILED Requested Amount Must Not be EMPTY Or Only Number Allowed 200