post-request

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

Headers

Content-Type: application/JSON
header_secrets: To be shared during integration
pass_key: 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.24_123.43.5 Optional
publicIP Public IP of Transaction device String 192.168.1.1 Optional
ovdType OVD Type String BioAuth Mandatory
ovdData OVD Data (Optional for OTP type-2) String 12 digit Aadhaar numer
E.g-765386439745		 Mandatory
pid PID Data String Base 64 encoded PID data Mandatory
email Email String [email protected] Optional
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

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

Case 1 : For Customer Onboard (otpType=1)

Sample Request Body:

Sample Response Body:

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

Case 2 : For Transactional OTP (otpType=2)

Sample Request Body:

Sample Response Body:

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

 

Sample Request Body(Encrypted):

 

Sample Response Body(Encrypted):

{
"ResponseData": "1K+Qd1aU2j9GvhqAS4J8pd9z0IyYqCoLL5yw+kDq1mrMEItcoXo3ee8QpC36z1
+KOnlFWGtgjtb18WsjmeuUdmr03vq7gnU2/LCLNReE59OOspgJLm
rLadyWej0hj1p3"
}
Notes -
  1. For “otpType”: “1”
    • External Reference number is not required; otpType, ovdType, ovdData, pid, latLong are mandatory.
    • The OTP will be generated from bank's end.
    • The OTP remains valid for 3 minutes.
    • The default OTP for staging is set to '123456' and will be used for validating OTP Type 1 during the process customer flow.
  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.
    • Please validate the OTP by using the fixed code ‘000000’.

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