OTP

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

RequestInfoobjectrequired

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.

otpobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/otp/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

application/json

200

400

200

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

Request acknowledged sucessfully

validate OTP Configuration entry

post

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

Body

RequestInfoobjectrequired

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.

otpobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/otp/v1/_validate' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

application/json

200

400

200

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

Request acknowledged sucessfully

search OTP Configuration entry using uuid

post

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

Body

RequestInfoobjectrequired

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.

otpobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/otp/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

application/json

200

400

200

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

Request acknowledged sucessfully