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
ClosedrequestOTPPreLoginMB
 

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
  • Error Code: 10570
    Error Message: Unable to determine MFA configuration
  • Error Code: 10571
    Error Message: Please provide phone number
  • Error Code: 10572
    Error Message: OTP Requests are exceeded more than the limit allowed for a day
  • Error Code: 10573
    Error Message: OTP request limit is exceeded than allowed number
ClosedverifyOTPPreLoginMB
 

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
  • Error Code: 10580
    Error Message: Secure Access Code has expired. Request a resend
  • Error Code: 10581
    Error Message: Secure Access Code didn't match. Recheck.
  • Error Code: 10582
    Error Message: Invalid security key or service key.
  • Error Code: 10583
    Error Message: Exceeded maximum number of attempts.
Service Flow:
Integration Services Backend Services
services/dbpMFAServices/VerifyPreLoginOTPMB

  • services/dbpRbLocalServicesdb/dbxdb_OTP_get

    • Storage Name: OTP

  • services/dbpRbLocalServicesdb/dbxdb_OTP_delete

    • Storage Name: OTP
  • services/dbpRbLocalServicesdb/dbxdb_OTP_update
    • Storage Name: OTP
ClosedrequestUpdateSecurityQuestionsOTP
 

Description:

This API initiates the Multi-Factor Authentication (MFA) process for resetting the security questions.

Method:

POST

URL:

services/data/v1/RBObjects/operations/DbxUser/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
  • Error Code: 10541
    Error Message: Secure Access Code has expired. Request a resend
  • Error Code: 10542
    Error Message: Secure Access Code didn't match. Recheck.
  • Error Code: 10543
    Error Message: Invalid security key or service key.
  • Error Code: 10544
    Error Message: Exceeded maximum number of attempts.
  • Error Code: 10585
    Error Message: Unable to determine MFA configuration
  • Error Code: 10586
    Error Message: Unable to determine MFA Configuration
  • Error Code: 10587
    Error Message: Invalid service Key
  • Error Code: 10588
    Error Message: Invalid request payload
Service Flow:
Integration Services Backend Services
services/dbpMFAServices/RequestOTPPreLogin
  • services/dbpRbLocalServicesdb/dbxdb_OTP_get
    • Storage Name: OTP
  • services/dbpRbLocalServicesdb/dbxdb_OTP_create
    • Storage Name: OTP
  • services/dbpRbLocalServicesdb/dbxdb_otpcount_get
    • Storage Name: otpcount
  • services/dbpRbLocalServicesdb/dbxdb_otpcount_create
    • Storage Name: otpcount
  • services/dbpRbLocalServicesdb/dbxdb_otpcount_update
    • Storage Name: otpcount
  • services/dbpRbLocalServicesdb/dbxdb_mfaservice_get
    • Storage Name: mfaservice
  • services/dbpRbLocalServicesdb/dbxdb_mfaservice_create
    • Storage Name: mfaservice
  • services/dbpRbLocalServicesdb/dbxdb_mfaservice_update
    • Storage Name: mfaservice
ClosedverifyUpdateSecurityQuestionsOTP
 

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/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
  • Error Code: 10546
    Error Message: Unable to determine MFA Configuration
  • Error Code: 10547
    Error Message: Unable to determine MFA Configuration
  • Error Code: 10548
    Error Message: Invalid service key
  • Error Code: 10549
    Error Message: Invalid Request Payload
  • Error Code: 10551
    Error Message: Secure Access Code has expired. Request a resend
  • Error Code: 10552
    Error Message: Secure Access Code didn't match. Recheck
  • Error Code: 10553
    Error Message: Invalid security key or service key
  • Error Code: 10554
    Error Message: Exceeded maximum number of attempts
  • Error Code: 10550
    Error Message: Unable to determine MFA Configuration
Service Flow:
Integration Services Backend Services
services/dbpMFAServices/ VerifyOTPPreLogin
  • services/dbpRbLocalServicesdb/dbxdb_OTP_get
    • Storage Name: OTP
  • services/dbpRbLocalServicesdb/dbxdb_OTP_create
    • Storage Name: OTP
  • services/dbpRbLocalServicesdb/dbxdb_OTP_update
    • Storage Name: OTP
  • services/dbpRbLocalServicesdb/dbxdb_mfaservice_get
    • Storage Name: mfaservice
  • services/dbpRbLocalServicesdb/dbxdb_mfaservice_create
    • Storage Name: mfaservice

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?