New Business User
| Name | Description | Introduced In |
|---|---|---|
| requestOTPPreLoginMB | The API initiates the Multi-Factor Authentication (MFA) process for the new account opening flow. | 2020.04 |
| verifyOTPPreLoginMB | This API verifies the Multi-Factor Authentication (MFA) flow that was initiated by the user. | 2020.04 |
| requestUpdateSecurityQuestionsOTP | This API initiates the Multi-Factor Authentication (MFA) process for resetting the security questions. | 2020.04 |
| verifyUpdateSecurityQuestionsOTP | This API verifies the Multi-Factor Authentication (MFA) flow that was initiated by the user. | 2020.04 |
requestOTPPreLoginMB
|
Description: |
This API initiates the Multi-Factor Authentication (MFA) process for the new account opening flow. |
|
Method: |
POST |
|
URL: |
/services/data/v1/RBObjects/operations/DbxUser/requestOTPPreLoginMB |
|
Security Level: |
Public |
|
Body Request: |
Parameters Phone (Mandatory) Specifies the phone number that the user provided during the opening of the account. MFAAttrbutes (Mandatory) Specifies the various MFA Attributes and the corresponding details. MFAAttrbutes/serviceKey (Mandatory) Specifies the service key for the current instance of the MFA flow. This key must be sent in a subsequent call for a resend OTP request. MFAAttrbutes/OTP (Mandatory) Specifies the One Time Password number. MFAAttrbutes/OTP/securityKey (Mandatory) Specifies the security key that must return by the first call to this API. This key must be sent in a subsequent call for a resend OTP request. {
"MFAAttributes": {
"serviceKey": "3ac66eb8-1276-4445-9f7c-6aa1317cea7c",
"OTP":{
"phone":"326522",
"email":"700214",
"securityKey":"abcd"
}
}
}
|
|
Response: |
Parameters MFAAttrbutes Specifies the various MFA Attributes and the corresponding details. MFAAttrbutes/sacMaxResendRequestsAllowed Specifies the maximum resend requests that a user can make through OTP. MFAAttrbutes/remainingResendAttempts Specifies the remaining resend requests that a user can make through OTP. MFAAttrbutes/serviceKey Specifies the service key for the current instance of the MFA flow. success Specifies the success message. MFAAttrbutes/sacMaxResendRequestsAllowed Specifies the remaining resend requests that a user can make through OTP. MFAAttrbutes/communicationType Specifies the type of communication. MFAAttrbutes/sacPreferenceCriteria Specifies the preference criteria for the communication type. MFAAttrbutes/customerCommunication Specifies a JSON of options through which customers can communicate. MFAAttrbutes/customerCommunication/phone Specifies an array of phone details. MFAAttrbutes/customerCommunication/phone/masked Specifies the phone number with a few masked digits. MFAAttrbutes/customerCommunication/phone/unmasked Specifies the unmasked digits. MFAAttrbutes/customerCommunication/phone/referenceId Specifies the reference ID for the communication done through the phone. MFAAttrbutes/customerCommunication/emailId Specifies an array of email details. MFAAttrbutes/customerCommunication/phone/masked Specifies the email ID with a few masked characters. MFAAttrbutes/customerCommunication/phone/unmasked Specifies the unmasked characters. MFAAttrbutes/customerCommunication/phone/referenceId Specifies the reference ID for the communication done through email. MFAAttrbutes/isMFARequired Specifies whether Multi-Factor Authentication is required. The value is Boolean. MFAAttrbutes/MFAType Specifies the type of Multi-Factor Authentication. There are different types such as secure code or a phone call. MFAAttrbutes/serviceKey Specifies the service key required for Multi-Factor Authentication. {
"success": "OTP request sent successfully.",
"opstatus": "0",
"httpStatusCode": "0",
"MFAAttributes": {
"sacCodeLength": "3",
"remainingResendAttempts": "3",
" sacMaxResendRequestsAllowed”:”11”
}}
{
"MFAAttributes": {
"communicationType": "DISPLAY_ALL",
"sacPreferenceCriteria": "DISPLAY_ALL",
"customerCommunication": {
"phone": [
{
"masked": "+99XXXXXX07",
"unmasked": "370083",
"referenceId": "370083"
}
],
"email": [
{
"masked": "sowXXXXXXXXXXXXX@temenos.com",
"unmasked": "904300",
"referenceId": "904300"
}
]
},
"isMFARequired": "true",
"MFAType": "SECURE_ACCESS_CODE",
"serviceKey": "c449a331-1f54-400c-a42a-176dbeb8f9bd"
}
}
|
| Error Codes |
|
verifyOTPPreLoginMB
|
Description: |
This API verifies the Multi-Factor Authentication (MFA) flow that was initiated by the user. |
|||||||
|
Method: |
POST |
|||||||
|
URL: |
/services/data/v1/RBObjects/operations/DbxUser/verifyOTPPreLoginMB |
|||||||
|
Security Level: |
Public |
|||||||
|
Header Request: |
X-Kony-Authorization |
|||||||
|
Body Request: |
Parameters MFAAttrbutes (Mandatory) Specifies the various MFA Attributes and the corresponding details. MFAAttrbutes/serviceKey (Mandatory) Specifies the service key for the current instance of the MFA flow. This key must be sent in a subsequent call for a resend OTP request. MFAAttrbutes/OTP (Mandatory) Specifies the OTP details. MFAAttrbutes/OTP/securityKey (Mandatory) Specifies the security key that must return by the first call to this API. This key must be sent in a subsequent call for a resend OTP request. MFAAttrbutes/OTPOTP (Mandatory) Specifies the OTP number. {
"MFAAttributes": {
"serviceKey": "3ac66eb8-1276-4445-9f7c-6aa1317cea7c",
"OTP": {
"securityKey": "6b47df94-59ba-43af-8c4e-51d1fab55dc6",
"otp": "99413"
}
}
}
|
|||||||
|
Response: |
Parameters /success Specifies an array of group and the corresponding details. /isOtpVerified Specifies whether the OTP is verified. The value is Boolean. {
"success": "Secure Access Code has been sent",
"isOtpVerified": "true",
"opstatus": "0",
"httpStatusCode": "0"
}
|
|||||||
| Error Codes |
|
|||||||
| Service Flow: |
|
requestUpdateSecurityQuestionsOTP
|
Description: |
This API initiates the Multi-Factor Authentication (MFA) process for resetting the security questions. |
||||||||||||
|
Method: |
POST |
||||||||||||
|
URL: |
services/data/v1/ExternalUserManagement/operations/ExternalUsers_2/requestUpdateSecurityQuestionsOTP |
||||||||||||
|
Security Level: |
Authenticated |
||||||||||||
|
Header Request: |
X-Kony-Authorization |
||||||||||||
|
Body Request: |
Parameters MFAAttrbutes (Mandatory) Specifies the various MFA Attributes and the corresponding details. MFAAttrbutes/serviceKey (Mandatory) Specifies the service key for the current instance of the MFA flow. This key must be sent in a subsequent call for a resend OTP request. MFAAttrbutes/OTP (Mandatory) Specifies the One Time Password number. MFAAttrbutes/OTP/securityKey (Mandatory) Specifies the security key that must return by the first call to this API. This key must be sent in a subsequent call for a resend OTP request. {
"MFAAttributes": {
"serviceKey": "3ac66eb8-1276-4445-9f7c-6aa1317cea7c",
"OTP":{
"phone":"326522",
"email":"700214",
"securityKey":"abcd"
}
}
}
|
||||||||||||
|
Response: |
Parameters /success Specifies an array of group and the corresponding details. MFAAttrbutes Specifies the various MFA Attributes and the corresponding details. MFAAttrbutes/sacMaxResendRequestsAllowed Specifies the maximum resend requests that a user can make through OTP. MFAAttrbutes/remainingResendAttempts Specifies the remaining resend attempts that a user can make through OTP. MFAAttrbutes/sacMaxResendRequestsAllowed Specifies the remaining resend requests that a user can make through OTP. MFAAttrbutes/communicationType Specifies the type of communication. MFAAttrbutes/sacPreferenceCriteria Specifies the preference criteria for the communication type. MFAAttrbutes/customerCommunication Specifies a JSON of options through which customers can communicate. MFAAttrbutes/customerCommunication/phone Specifies an array of phone details. MFAAttrbutes/customerCommunication/phone/masked Specifies the phone number with a few masked digits. MFAAttrbutes/customerCommunication/phone/unmasked Specifies the unmasked digits. MFAAttrbutes/customerCommunication/phone/referenceId Specifies the reference ID for the communication done through the phone. MFAAttrbutes/customerCommunication/emailId Specifies an array of email details. MFAAttrbutes/customerCommunication/phone/masked Specifies the email ID with a few masked characters. MFAAttrbutes/customerCommunication/phone/unmasked Specifies the unmasked characters. MFAAttrbutes/customerCommunication/phone/referenceId Specifies the reference ID for the communication done through email. MFAAttrbutes/isMFARequired Specifies whether Multi-Factor Authentication is required. The value is Boolean. MFAAttrbutes/MFAType Specifies the type of Multi-Factor Authentication. There are different types such as secure code or a phone call. MFAAttrbutes/serviceKey Specifies the service key required for Multi-Factor Authentication. {
"success": "OTP request sent successfully.",
"opstatus": "0",
"httpStatusCode": "0",
"MFAAttributes": {
"sacCodeLength": "3",
"remainingResendAttempts": "3",
" sacMaxResendRequestsAllowed":"11"
}}
"MFAAttributes": {
"communicationType": "DISPLAY_ALL",
"sacPreferenceCriteria": "DISPLAY_ALL",
"customerCommunication": {
"phone": [
{
"masked": "+99XXXXXX07",
"unmasked": "370083",
"referenceId": "370083"
}
],
"email": [
{
"masked": "sowXXXXXXXXXXXXX@temenos.com",
"unmasked": "904300",
"referenceId": "904300"
}
]
},
"isMFARequired": "true",
"MFAType": "SECURE_ACCESS_CODE",
"serviceKey": "c449a331-1f54-400c-a42a-176dbeb8f9bd"
}
}
|
||||||||||||
| Error Codes |
|
||||||||||||
| Service Flow: |
|
verifyUpdateSecurityQuestionsOTP
|
Description: |
This API verifies the Multi-Factor Authentication (MFA) flow that was initiated by the user. |
|||||||||
|
Method: |
POST |
|||||||||
|
URL: |
services/data/v1/ExternalUserManagement/operations/ExternalUsers_2/verifyUpdateSecurityQuestionsOTP |
|||||||||
|
Security Level: |
Authenticated App User |
|||||||||
|
Header Request: |
X-Kony-Authorization |
|||||||||
|
Body Request: |
Parameters MFAAttrbutes (Mandatory) Specifies the various MFA Attributes and the corresponding details. MFAAttrbutes/serviceKey (Mandatory) Specifies the service key for the current instance of the MFA flow. This key must be sent in a subsequent call for a resend OTP request. MFAAttrbutes/OTP (Mandatory) Specifies the OTP details. MFAAttrbutes/OTP/securityKey (Mandatory) Specifies the security key that must return by the first call to this API. This key must be sent in a subsequent call for a resend OTP request. MFAAttrbutes/OTPOTP (Mandatory) Specifies the OTP number. {
"MFAAttributes": {
"serviceKey": "3ac66eb8-1276-4445-9f7c-6aa1317cea7c",
"OTP": {
"securityKey": "6b47df94-59ba-43af-8c4e-51d1fab55dc6",
"otp": "99413"
}
}
}
|
|||||||||
|
Response: |
Parameters /success Specifies an array of group and the corresponding details. /isOtpVerified Specifies whether the OTP is verified. The value is Boolean. {
"success": "Secure Access Code has been sent",
"isOtpVerified": "true",
"opstatus": "0",
"httpStatusCode": "0"
}
|
|||||||||
| Error Codes |
|
|||||||||
| Service Flow: |
|
In this topic