OTP

OTP Service APIs

Enables OTP creation, validation and search functions.

create OTP Configuration entry

create OTP Configuration this API is internaly call from v1/_send end point, this end point present in user-otp service no need of explicity call

POST/egov-otp//otp/v1/_create

Body

*/*

required parameters have to be populated

RequestInfo*RequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

otp*Createotp (object)

Response

200400

Request acknowledged sucessfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

otparray of Createotp (object)

Request

JavaScriptCurlPython

const response = await fetch('/egov-otp//otp/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ts": 0,
        "ver": "text"
      },
      "otp": {
        "identity": "text",
        "tenantId": "text"
      }
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "otp": [
    {
      "otp": "text",
      "uuid": "text",
      "identity": "text",
      "tenantId": "text",
      "isValidationSuccessful": "text"
    }
  ]
}

validate OTP Configuration entry

validate OTP Configuration this end point is validate the otp respect to mobilenumber

POST/egov-otp//otp/v1/_validate

Body

*/*

required parameters have to be populated

RequestInfo*RequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

otp*Createotp (object)

Response

200400

Request acknowledged sucessfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

otparray of Createotp (object)

Request

JavaScriptCurlPython

const response = await fetch('/egov-otp//otp/v1/_validate', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ts": 0,
        "ver": "text"
      },
      "otp": {
        "identity": "text",
        "tenantId": "text"
      }
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "otp": [
    {
      "otp": "text",
      "uuid": "text",
      "identity": "text",
      "tenantId": "text",
      "isValidationSuccessful": "text"
    }
  ]
}

search OTP Configuration entry using uuid

search the mobile number and otp using uuid ,uuid nothing but otp reference number

POST/egov-otp//otp/v1/_search

Body

*/*

required parameters have to be populated

RequestInfo*RequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

otp*Createotp (object)

Response

200400

Request acknowledged sucessfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

otparray of Createotp (object)

Request

JavaScriptCurlPython

const response = await fetch('/egov-otp//otp/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ts": 0,
        "ver": "text"
      },
      "otp": {
        "identity": "text",
        "tenantId": "text"
      }
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "otp": [
    {
      "otp": "text",
      "uuid": "text",
      "identity": "text",
      "tenantId": "text",
      "isValidationSuccessful": "text"
    }
  ]
}