Messaging
| Name | Description | Introduced In |
|---|---|---|
| requestMFAOTP | This API allows requests the application to send a One Time Password (OTP) to the registered email ID or phone number. | 2021.01 |
| requestOTP | This API allows | 2020.04 |
| verifyOTP | This API | 2020.04 |
| isMFAEnabled | This API retrieves the service key and this service key is passed to the requestMFAOtp API to request the application to send an OTP to the customer. | 2021.01 |
| verifyMFAOTP | This API validates the One Time Password (OTP) sent by the application to the registered email ID or phone number. The security key fetched from the response of the requestMFAOtp API is used to validate with the service key. | 2021.01 |
| sendResumeMail | This API sends a mail with an application id and a resume link as soon as the user closes his/her application. | 2021.01 |
requestMFAOtp
| Description: | Requests the application to send a One Time Password (OTP) to the registered email ID or phone number. The service key fetched from the getMFAScenario API is used to perform the request operation. | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/Messaging/operations/OTP/requestMFAOtp | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters serviceKey (Mandatory) Specifies the Multi-Factor Authentication service key value. serviceName (Mandatory) Specifies the name of the Multi-Factor Authentication service. Phone (Mandatory) Specifies the phone number to which the OTP must be sent. The value is fetched from the backend. Email(Mandatory) Specifies the Email ID to which the OTP must be sent. The value is fetched from the backend. {jsondata={"serviceKey":"ee319368-66a1-469b-bcfe-4113febd2bef","serviceName":"USER_VERIFICATION","Phone":"","Email":""}
|
||||
| Response: |
Parameters /success Specifies the success message when the OTP is sent successfully to the customer. /sacCodeLength Specifies the length of the OTP number (number of digits). /remainingResendAttempts Specifies the number of attempts left for sending the OTP. /sacMaxResendRequestsAllowed Specifies the maximum number of attempts available to the user to send the OTP to the customer. /securityKey Specifies the Multi-Factor Authentication service key value. {
"success":"OTP request sent successfully.",
"sacCodeLength":"3",
"remainingResendAttempts":"3",
"sacMaxResendRequestsAllowed":"3",
"opstatus":0,
"securityKey":"c5dd845e-5b3b-41d9-8b38-6bf370496857",
"httpStatusCode":0
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
isMFAEnabled
| Description: | Retrieves the service key and this service key is passed to the requestMFAOtp API to request the application to send an OTP to the customer. If the service key value is returned empty then the MFA authentication does not take place. | |||||
| Method: | POST | |||||
| URL: | {{URL}}/services/data/v1/Messaging/operations/OTP/isMFAEnabled | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters appId (Mandatory) Specifies the unique ID of the application. actionId (Mandatory) Specifies the unique ID of the action (RESUME_AUTHENTICATION/PROSPECT_EXPIRY). {
"appId":"InfinityOnboarding",
"actionId":"USER_VERIFICATION"
}
|
|||||
| Response: |
Parameters serviceKey Specifies the retrieved Multi-Factor Authentication service key value. {
"opstatus":0,
"serviceKey":"ee319368-66a1-469b-bcfe-4113febd2bef",
"httpStatusCode":0
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
verifyMFAOtp
| Description: | Validates the One Time Password (OTP) sent by the application to the registered email ID or phone number. The security key fetched from the response of the requestMFAOtp API is used to validate with the service key. | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/Messaging/operations/OTP/verifyMFAOtp | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters serviceKey (Mandatory) Specifies the Multi-Factor Authentication service key value. serviceName (Mandatory) Specifies the name of the Multi-Factor Authentication service. securityKey (Mandatory) Specifies the security key required for verification. Otp (Mandatory) Specifies the value of the OTP. {
"serviceKey":"a23e6ec9-963a-470e-9793-e5a82d0d6d6c",
"serviceName":"PROSPECT_EXPIRY",
"securityKey":"c5dd845e-5b3b-41d9-8b38-6bf370496857",
"Otp":"601"
}
|
||||
| Response: |
Parameters success Specifies the success message on successful verification. {
"invalidAttempts": "",
"opstatus": 0,
"error": "OTP_EXPIRED",
"MAX_FAILED_ATTEMPTS_ALLOWED": "",
"httpStatusCode": 0
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
sendResumeMail
| Description: | This API is used to send a mail with an application id and a resume link as soon as the user closes his/her application. | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/Messaging/operations/Email/sendResumeMail | ||||
| Security Level: | Anonymous App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters Application_id Specifies the entity definition key. userType Specifies the type of user. Party_id Specifies the ID of the Party Micro Service. {
"Application_id": "M2MKSXX",
"Party_id": "2003811131",
"userType": "NEW_USER"
}
|
||||
| Response: |
Parameters /opstatus_SendResumeMailOperation Specifies the status of the application. Specifies the email address. /EmailType Specifies the email type. /KMSemailMsg Specifies the email message. /KMSemailStatus Specifies the email status. /FirstName Specifies the first name. /Subscribe Specifies the status of subscription. {
"opstatus_SendResumeMailOperation":0,"AdditionalContext":"FirstName:Abc;LastName:Def;ApplicationId:M2MKSXX;ResumeLink:https://dbxlendingdev.konycloud.com/apps/InfinityOnboarding#R_lBzZ7nGfc_Jy6HyiRMwA",
"Email":"lsuman@temenos.com",
"EmailType":"APPLICANT_RESUME_ONBOARDING_APPLICATION",
"KMSemailMsg":"Request Queued. ",
"KMSemailStatus":"true",
"FirstName":"Abc",
"opstatus":0,"opstatus_sendEmail":0,"LastName":"Def",
"Subscribe":"true",
"httpStatusCode":0
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
In this topic