OTP Service

create OTP Configuration entry

post

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

Body
Responses
200
Request acknowledged sucessfully
application/json
post
POST /egov-otp/v110/otp/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "otp": {
    "otp": "text",
    "uuid": "text",
    "identity": "text",
    "tenantId": "text",
    "isValidationSuccessful": "text"
  }
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "otp": [
    {
      "otp": "text",
      "uuid": "text",
      "identity": "text",
      "tenantId": "text",
      "isValidationSuccessful": "text"
    }
  ]
}

validate OTP Configuration entry

post

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

Body
Responses
200
Request acknowledged sucessfully
application/json
post
POST /egov-otp/v110/otp/v1/_validate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "otp": {
    "otp": "text",
    "uuid": "text",
    "identity": "text",
    "tenantId": "text",
    "isValidationSuccessful": "text"
  }
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "otp": [
    {
      "otp": "text",
      "uuid": "text",
      "identity": "text",
      "tenantId": "text",
      "isValidationSuccessful": "text"
    }
  ]
}

search OTP Configuration entry using uuid

post

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

Body
Responses
200
Request acknowledged sucessfully
application/json
post
POST /egov-otp/v110/otp/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "otp": {
    "otp": "text",
    "uuid": "text",
    "identity": "text",
    "tenantId": "text",
    "isValidationSuccessful": "text"
  }
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "otp": [
    {
      "otp": "text",
      "uuid": "text",
      "identity": "text",
      "tenantId": "text",
      "isValidationSuccessful": "text"
    }
  ]
}

Last updated

Was this helpful?