OTP
Last updated
Was this helpful?
Last updated
Was this helpful?
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 /v1/_create HTTP/1.1
Host: otp
Content-Type: */*
Accept: */*
Content-Length: 479
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "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 this end point is validate the otp respect to mobilenumber
POST /v1/_validate HTTP/1.1
Host: otp
Content-Type: */*
Accept: */*
Content-Length: 479
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "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 the mobile number and otp using uuid ,uuid nothing but otp reference number
POST /v1/_search HTTP/1.1
Host: otp
Content-Type: */*
Accept: */*
Content-Length: 479
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "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"
}
]
}