OTP Service

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/v110/otp/v1/_create

Body

application/json

required parameters have to be populated

otp*Createotp (object)

Response

200400

Request acknowledged sucessfully

Body

*/*

otparray of Createotp (object)

Request

JavaScriptCurlPython

const response = await fetch('/egov-otp/v110/otp/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "otp": {
        "identity": "text",
        "tenantId": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "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/v110/otp/v1/_validate

Body

application/json

required parameters have to be populated

otp*Createotp (object)

Response

200400

Request acknowledged sucessfully

Body

*/*

otparray of Createotp (object)

Request

JavaScriptCurlPython

const response = await fetch('/egov-otp/v110/otp/v1/_validate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "otp": {
        "identity": "text",
        "tenantId": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "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/v110/otp/v1/_search

Body

application/json

required parameters have to be populated

otp*Createotp (object)

Response

200400

Request acknowledged sucessfully

Body

*/*

otparray of Createotp (object)

Request

JavaScriptCurlPython

const response = await fetch('/egov-otp/v110/otp/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "otp": {
        "identity": "text",
        "tenantId": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "otp": [
    {
      "otp": "text",
      "uuid": "text",
      "identity": "text",
      "tenantId": "text",
      "isValidationSuccessful": "text"
    }
  ]
}