DIGIT-API's
  1. OTPConfig
DIGIT-API's
  • Using DIGIT-PLAYGROUND
  • User
    • Manage
      • Create User
      • Search All Users
      • Search Active Users
      • Create User Without OTP Validation
      • Update User Without OTP Validation
      • Get User
      • Update Profile
    • Authenticate
      • Logout
      • Reset Password
      • Login
  • Master Data V1
    • List
      POST
    • Search
      POST
  • Master Data V2
    • Create Schema
      • Create Schema
    • Search Schema
      • Seach Schema
    • Add Data
      • Create
    • Seach Data
      • Seach Data
    • Update data
      • Updata
  • Access-control
    • Action
      • Authorize User
      • Get the list of actions based on either roles or features.
      • Create a new action.
      • Update existing action(s).
      • getAllMDMSActions
      • Validate a particular action for a given tenant and roles of the tenant
    • Role
      • Get the list of roles based on role codes.
      • Create a new role.
      • Update existing role(s).
    • Role-Action
      • Create mapping for role and action(s).
  • Workflow-v2
    • WorkFlow
      • Create new workflow entry for a given application number(businessId).
      • Process search of the applicaition
      • Get the list of workflow applications defined in the system.
      • Get the count of applications satisfying the given criteria
      • Get the nearing sla count of workflow applications defined in the system.
      • Get the list of status count workflow applications defined in the system.
    • Escalate
      • Get the list of escalate workflow applications defined in the system.
      • Get the list of workflow applications defined in the system.
    • BusinessServiceV2
      • Create new v2 BuinessService.
      • Updates a existing v2 BuinessService.
      • Get the list of v2 BusinessServices defined in the system.
    • BusinessService
      • Create new BuinessService.
      • Updates a existing BuinessService.
      • Get the list of BusinessServices defined in the system.
  • Filestore
    • Upload File
      • Uploads different kinds of files to server.
    • Search
      • Search file url based on tenantid and filestoreid.
      • Search file url based on tenantid and tag name.
      • Get metadata of file based on tenantId and filestoreId.
      • Search file url based on tenantid and filestoreid.
  • Idgen
    • IdGeneration Controller
    • Create new id.
  • Location
    • Boundary
      • Search Location
      • It Will provide the List of boundaries based on search criteria Like "Srikakulam Municipality","Zone-1","Zone-2" etc.
    • Geography
      • Handles all requests related to Geographical boundaries by providing appropriate GeoJson and other associated data
    • Tenant
      • Resolves a given latitude / longitude to the corresponding tenant Id
  • Enc-Service
    • Crypto
      • Encrypts the given input value/s OR values of the object.
      • Decrypts the given input value/s OR values of the object.
      • Provide signature for a given value.
      • Check if the signature is correct for the provided value.
      • Deactivate the keys for the given tenant and generate new keys. It will deactivate both symmetric and asymmetric keys for the provided tenant.
      • cryptoRotateAllKeys
  • PG-Service
    • transactions-api-controller
      • transactionsV1AvailableGatewaysPost
      • transactionsV1CreatePost
      • transactionsV1SearchPost
      • transactionsV1UpdatePost
  • URL-Shortening
    • egov-url-shortening service endpoints
      • shorten given url
      • redirects user to orignal url identified by id
  • Indexer
    • egov-indexer service
      • This endpoint is used to start legacy index job to reindex records from DB. The data is fetched from DB by calling api mentioned in request in batches. The is useful when some record is present in DB but missing on index.
      • This endpoint is used to start indexing job to reindex records from one index to another index.
      • This endpoint is used to index one record on a index. The information to pick correct config is provided with the data to be indexed.
      • Index data in row
  • PDF-Service
    • PDF-Service endpoints
      • Generate PDF and store output pdfs to filestore and return their filestoreids. The information is also saved into DB so that using _search endpoint we can retrieve already generated pdfs.
      • Generates pdf without storing any information on filestore or in DB. The generated pdf would be returned as binary response
      • Get filestoreids and other information about already generated pdf by searching on jobid or entityid with other optional search parameters
  • Report
    • Report Meta
      • createv1
      • getReportDatav1
      • Metadata API for report definition
    • Report
      • Search API for report data
  • eGov-OTP
    • OTPConfig
      • create OTP Configuration entry
        POST
      • validate OTP Configuration entry
        POST
      • search OTP Configuration entry using uuid
        POST
  • User-OTP
    • user otp send
  • Localization
    • Create Message
      • create massage
    • Fetch Message
      • fetch message
    • Update message
      • update message
    • Delete message
      • delete mesage
    • Upsert message
      • upsert message
  • Service Request
    • Service Defination Create
      • Create service defination
    • Service Defination search
      • Search service defination
    • Service create
      • service create
    • Service Search
      • Service search
  • Audit Service
  1. OTPConfig

create OTP Configuration entry

POST
/otp/v1/_create
OTPConfig
Last modified:2024-05-22 10:52:28
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

Request

Header Params
Content-Type
string 
optional
Example:
application/json
Body Params text/plain
Example
Example:{ "RequestInfo": { "apiId": null, "ver": null, "ts": null, "action": "POST", "did": null, "key": null, "msgId": "5bfa85e7-dfa1-47c8-98b2-747bf552be86", "authToken": "50b80fa6-bec2-438e-a168-ce5ad53770b5" }, "otp": { "identity": "forth", "tenantId": "pg" } }

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://unified-dev.digit.org/otp/v1/_create' \
--header 'Content-Type: application/json' \
--data-raw '{
     "RequestInfo": {
        "apiId": null,
        "ver": null,
        "ts": null,
        "action": "POST",
        "did": null,
        "key": null,
        "msgId": "5bfa85e7-dfa1-47c8-98b2-747bf552be86",
        "authToken": "50b80fa6-bec2-438e-a168-ce5ad53770b5"
    },
    "otp": {
        "identity": "forth",
        "tenantId": "pg"
    }
}'

Responses

🟢200Request acknowledged sucessfully
application/json
Body
ResponseInfo
object 
optional
otp
object (Otp) 
optional
otp
string 
optional
this is the five digit otp number ,this is mandatory in validate end point should pass otp value in /otp/v1/_validate end point, in other end point it is read only
<= 128 characters
uuid
string 
optional
this is otp reference id, this is mandatory in search end point (/otp/v1/_search), and in other end point it is read only.
<= 36 characters
identity
string 
required
identity is username or mobile number. this is mandatory field in create and validate end point end point is(/otp/v1/_create, and /otp/v1/_validat) and optional field in /otp/v1/_search end point
<= 100 characters
tenantId
string 
required
Unique Identifier of the tenantId to which user primarily belongs and it is mandatory field in all the end points shoiuld pass this value
<= 256 characters
isValidationSuccessful
string 
optional
it return true or false this is optional or read only property in all end point,
Example
{
    "ResponseInfo": {},
    "otp": {
        "otp": "string",
        "uuid": "string",
        "identity": "string",
        "tenantId": "string",
        "isValidationSuccessful": "string"
    }
}
🟠400Request failed
Modified at 2024-05-22 10:52:28
Previous
Search API for report data
Next
validate OTP Configuration entry
Built with