SCA Solicited User Enrollment

Name Description Introduced In
customerSearch This API is used in the application to search for a customer. During the enrollment process if the customer is already enrolled, then this API can be used to search for the customer. 2020.10
fetchUserProfile This API is used in the application to fetch the profile of the user. During the enrollment process if the customer is already enrolled, then this API can be used to fetch the profile of the customer. 2020.10
updateCustomerDetailsForAdmin This API is used in the application to update customer details. 2020.10
sendActivationCodeForEnrollment This API is used in the application during the enrollment process to send an activation code to the user through phone number. The user ID of the customer is sent through the mail. 2020.10
validateActivationCodeForEnrollment This API is used in the application during the enrollment procedure to validate the activation code that has been sent to the user through the phone number or email. 2020.10
UpdatePasswordForActivationFlow This API is used in the application to update the user password. If the user has forgotten his/her credentials, this API allows the user to update the password while trying to activate the fetched profile. 2020.10
getCustomerBasicInformation This API allows the user to fetch the basic information about the customer from the customer profile. 2020.10
ClosedcustomerSearch
 
Description:

This API is used in the application to search for a customer. During the enrollment process if the customer is already enrolled, then this API can be used to search for the customer.
Method: Custom Verb
URL: /services/data/v1/RBObjects/operations/search/customerSearch
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

phone

Specifies the phone number of the user.

username

Specifies the username.

cardorAccountnumber

Specifies the account number of the user.

id

Specifies a unique ID of the user.

companyId

Specifies the unique ID of the company.

email

Specifies the email ID of the user.

applicationId

Specifies the unique ID of the application.

IDType

pageOffset

Specifies the row from where the data must be retrieved. The offset value is often used together with the limit.

pageSize

 Specifies the number of rows that must be returned in the result.

sortVariable

Specifies the variable based on which the fetched customers are sorted.

sortDirection

Specifies the direction of sorting (Ascending/Descending).

searchType

Specifies the type of search.

{
    "_phone": "",
    "_username": "",
    "_cardorAccountnumber": "",
    "_id": "2023122351",
    "_companyId": "",
    "_email": "",
    "_applicationId": null,
    "_IDType": "",
    "_IDValue": "",
    "_pageOffset": "0",
    "_pageSize": "100",
    "_sortVariable": "name",
    "_sortDirection": "ASC",
    "_searchType": "CUSTOMER_SEARCH"
}
Response:
ClosedView the Response Parameters

/Status

Specifies the status of the search.

/SortVariable

Specifies the variable based on which the fetched customers are sorted.

/SortDirection

Specifies the direction of sorting (Ascending/Descending).

/customerbasicinfo_view

Specifies a JSON that contains basic information details about the customer.

/customerbasicinfo_view/PrimaryEmailAddress

Specifies the primary email address of the customer.

/customerbasicinfo_view/isCustomerEnrolled

Specifies whether the customer is already enrolled in the application. The value is Boolean.

/customerbasicinfo_view/CustomerStatus_id

Specifies the unique ID for the status of the customer in the enrollment process.

/customerbasicinfo_view/PrimaryPhoneNumber

Specifies the primary phone number of the customer.

/customerbasicinfo_view/isCustomerAccessiable

Specifies whether the customer is accessible. The value is Boolean.

/customerbasicinfo_view/OLBCustomerFlags

Specifies a JSON of Online Banking Customer flag details.

/customerbasicinfo_view/OLBCustomerFlags/Status

Specifies the status of the customer flag.

/customerbasicinfo_view/OLBCustomerFlags/LockedOn

/PageSize

 Specifies the number of rows that must be returned in the result.

/Configuration

Specifies a JSON of configuration details.

/Configuration/value

Specifies the value of the configurations.

/records

Specifies an array of records JSON Objects.

/records/DateOfBirth

Specifies the date of birth of the user.

/records/PrimaryEmailAddress

Specifies the primary email address of the user.

/records/PrimaryPhoneNumber

Specifies the primary phone number of the user.

/records/FirstName

Specifies the first name of the user.

/records/name

Specifies the name of the user.

/records/LastName

Specifies the last name of the user.

/records/id

Specifies the unique ID of the record.

/records/createdts

Specifies the time-stamp and date on which the record was created.

/TotalResultsFound

Specifies the total number of results that have been fetched.

/PageOffset

Specifies the row from where the data must be retrieved. The offset value is often used together with the limit.

ClosedView the Response Sample Code 
{
    "Status": "Records returned: 1",
    "SortVariable": "name",
    "SortDirection": "ASC",
    "customerbasicinfo_view": {
        "PrimaryEmai/lAddress": "srirama.sadineni@temenos.com",
        "isCustomerEnrolled": "false",
        "CustomerStatus_id": "SID_CUS_NEW",
        "PrimaryPhoneNumber": "+918143589876",
        "isCustomerAccessiable": true,
        "customerStatus": "SID_CUS_NEW",
        "OLBCustomerFlags": {
            "Status": "NEW",
            "LockedOn": ""
        }
    },
    "PageSize": "100",
    "Configuration": {
        "value": "0"
    },
    "records": [
        {
            "DateOfBirth": "1990-09-09",
            "PrimaryEmailAddress": "srirama.sadineni@temenos.com",
            "PrimaryPhoneNumber": "+91-8143589876",
            "FirstName": "RolfGerling",
            "name": "RolfGerling Gerling",
            "LastName": "Gerling",
            "id": "2023122351",
            "createdts": "2022-05-24"
        }
    ],
    "opstatus": 0,
    "TotalResultsFound": 1,
    "PageOffset": "0",
    "httpStatusCode": 0
}
Error Code(s): None
ClosedfetchUserProfile
 
Description:

This API is used in the application to fetch the profile of the user. During the enrollment process if the customer is already enrolled, then this API can be used to fetch the profile of the customer.
Method: Custom Verb
URL: /services/data/v1/RBObjects/operations/search/customerSearch
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

None
Response:
ClosedView the Response Parameters

/records

Specifies an array of records JSON Objects.

/records/DateOfBirth

Specifies the date of birth of the user.

/records/userFirstName

Specifies the first name of the user.

/records/userLastName

Specifies the last name of the user.

/records/maritalStatus

Specifies the marital status of the user.

/records/noOfDependents

Specifies the number of dependents of the user.

/records/gender

Specifies the gender of the user.

/records/feedbackUserId

Specifies the unique ID generated for the feedback provided by the user.

/records/isCustomerEnrolled

Specifies whether the customer is enrolled. The value is Boolean.

/records/isActivationLinkSent

Specifies whether the activation link is sent to the user. The value is Boolean.

/records/customerStatus

Specifies the status of the customer in the enrollment process.

/records/isSecurityQuestionConfigured

Specifies whether the security questions are configured in the application. The value is Boolean.

/records/ContactNumbers

Specifies the JSON Object details of the contact numbers.

/records/ContactNumbers/id

Specifies the unique ID of the contact number.

/records/ContactNumbers/Type_id

Specifies the ID for the type of contact number.

/records/ContactNumbers/isPrimary

Specifies whether the contact number is primary. The value is Boolean.

/records/ContactNumbers/Value

Specifies the contact number.

/records/ContactNumbers/phoneNumber

Specifies the contact number.

/records/ContactNumbers/phoneCountryCode

Specifies the country code for the contact number.

/records/ContactNumbers/Extension

Specifies the extension detail for the contact number.

/records/EmailIds

Specifies an array of JSON Objects of the Email IDs.

/records/ContactNumbers/id

Specifies the unique ID of the email.

/records/ContactNumbers/Type_id

Specifies the ID for the type of email ID.

/records/ContactNumbers/isPrimary

Specifies whether the email ID is primary. The value is Boolean.

/records/ContactNumbers/Value

Specifies the email ID.

/records/ContactNumbers/Extension

Specifies the extension detail for the email ID.

ClosedView the Response Sample Code 
{
    "records": [
        {
            "dateOfBirth": "1990-09-09",
            "DateOfBirth": "1990-09-09",
            "userfirstname": "RolfGerling",
            "userlastname": "Gerling",
            "LastName": "Gerling",
            "maritalStatus": "Married",
            "noOfDependents": "4",
            "gender": "Male",
            "feedbackUserId": "10cdf48c-5637-4e5d-88ef-5901330b3d62",
            "isCustomerEnrolled": "false",
            "isActivationLinkSent": "false",
            "customerStatus": "SID_CUS_NEW",
            "isSecurityQuestionConfigured": "false",
            "Addresses": [],
            "ContactNumbers": [
                {
                    "id": "2020-08-18",
                    "Type_id": "COMM_TYPE_PHONE",
                    "isPrimary": "true",
                    "Value": "9951482007",
                    "phoneNumber": "9951482007",
                    "phoneCountryCode": "91",
                    "Extension": "Personal"
                }
            ],
            "EmailIds": [
                {
                    "id": "2020-08-18",
                    "Type_id": "COMM_TYPE_EMAIL",
                    "isPrimary": "true",
                    "Value": "sowmya.vandanapu@temenos.com",
                    "Extension": "Personal"
                }
            ]
        }
    ],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s): None
ClosedupdateCustomerDetailsForAdmin
 
Description:

This API is used in the application to update customer details.
Method: Custom Verb
URL: /services/data/v1/RBObjects/operations/DbxUser/updateCustomerDetailsForAdmin
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

customerID

Specifies the unique ID of the customer.

phoneNumbers

Specifies an array of phone numbers JSON Objects.

EmailIds

Specifies an array of email ID JSON Objects. 

{
    "Customer_id": "2023122351",   
    "phoneNumbers": "[{\"isPrimary\":\"1\",\"phoneNumber\":\"8143589876\",\"phoneCountryCode\":\"+91\",\"Extension\":\"Personal\",\"id\":\"2020-01-01\", \"phoneCountryCode\":\"+91\"}]",
    "EmailIds": "[{\"value\":\"srirama.sadineni@temenos.com\",\"isPrimary\":\"1\",\"Extension\":\"Personal\",\"id\":\"2020-01-01\"}]"
}
Response:

Parameters

/status

Specifies the status of the operation.

/success

Specifies the success message.

{
    "Status": "Operation successful",
    "opstatus_UpdateCustomerDetailsOperation": 0,
    "success": "success",
    "opstatus_UpdateCustomerInParty": 0,
    "opstatus": 0,
    "httpStatusCode": 0,
    "status": "Operation successful"
}
Error Code(s): None
ClosedsendActivationCodeForEnrollment
 
Description:

This API is used in the application during the enrollment process to send an activation code to the user through phone number. The user ID of the customer is sent through the mail.
Method: Custom Verb
URL: /services/data/v1/RBObjects/operations/DbxUser/sendActivationCodeForEnrollment
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

Id

Specifies the unique ID of the user.

{
    "id":"2023121885"
}
Response: 
{
    "opstatus": 0,
    "status": "success",
    "httpStatusCode": 0
}
Error Code(s): None
ClosedvalidateActivationCodeForEnrollment
 
Description:

This API is used in the application during the enrollment procedure to validate the activation code that has been sent to the user through the phone number or email.

Method: Custom Verb
URL: /services/data/v1/RBObjects/operations/DbxUser/validateActivationCodeForEnrollment
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

UserName

Specifies the unique ID of the username.

activationCode

Specifies the activation code sent to the user through mobile.

{
    "UserName":"1819175598",
    "activationCode":"rIcFEoBpFZ"
}
Response:

Parameters

/isActivationCodeValid

Specifies whether the typed activation code is valid. The value is Boolean.

{
   "isActivationCodeValid":"true",
   "httpStatusCode": 0,
   "opstatus": 0,
   "serviceKey":"abcd"  
}

Error Response

{
   "isActivationCodeValid":"false",
   "httpStatusCode": 0,
   "opstatus": 0 
}
Error Code(s): None
ClosedUpdatePasswordForActivationFlow
 
Description:

This API is used in the application to update the user password. If the user has forgotten his/her credentials, this API allows the user to update the password while trying to activate the fetched profile.
Method: Custom Verb
URL: /services/data/v1/RBObjects/operations/DbxUser/UpdatePasswordForActivationFlow
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

serviceKey

Specifies the service key for updating the password.

Password

Specifies the new password that must be updated.

{
    "serviceKey": "abcd",
    "Password": "Kony@1234"
}
Response:

Success Response

{
    "status: "success",
    "opstatus": 0,
    "httpStatusCode": 200
}

Error Response

{
    "dbpErrMsg: "Invalid parameters please give valid details",
    "dbpErrCode: "10742",
    "opstatus": 0,
    "httpStatusCode": 200
}
Error Code(s): None
ClosedgetCustomerBasicInformation
 
Description:

This API allows the user to fetch the basic information about the customer from the customer profile.
Method: Custom Verb
URL: /services/data/v1/RBObjects/operations/search/getCustomerBasicInformation
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

Customer_id

Specifies the unique ID of the customer.

{
    "Customer_id":"1002496540"
}
Response:

Parameters

/customerbasicinfo_view

Specifies a JSON that contains basic information details about the customer.

/customerbasicinfo_view/accountLockoutTime

/customerbasicinfo_view/CustomerType_Description

Specifies the description of the type of customer.

/customerbasicinfo_view/isActivationLinkSent

Specifies whether the activation link is sent. The value is Boolean.

/customerbasicinfo_view/isCombinedUser

/customerbasicinfo_view/CustomerStatus_name

Specifies the name for the status of the customer.

/customerbasicinfo_view/isCustomerAccessiable

Specifies whether the customer is accessible. The value is Boolean.

/customerbasicinfo_view/combinedUserId

/customerbasicinfo_view/IsEnrolledForOlb

Specifies whether the customer is enrolled for Online Banking. The value is Boolean.

/customerbasicinfo_view/OLBCustomerFlags

Specifies a JSON of Online Banking Customer flag details.

/customerbasicinfo_view/OLBCustomerFlags/Status

Specifies the status of the customer flag.

/customerbasicinfo_view/OLBCustomerFlags/LockedOn

/customerbasicinfo_view/Name

Specifies the name of the customer.

/customerbasicinfo_view/IsStaffMember

Specifies whether the customer is a staff member. The value is Boolean.

/customerbasicinfo_view/customerStatus

Specifies the status of the customer.

/customerbasicinfo_view/CustomerType_Name

Specifies the name for the type of customer.

/customerbasicinfo_view/CustomerType_id

Specifies the unique ID based on the customer type.

/customerbasicinfo_view/DateOfBirth

Specifies the date of birth of the user.

/customerbasicinfo_view/lockCount

/customerbasicinfo_view/IsAssistConsented

Specifies whether the assistance provided to the user is with consent. The value is Boolean.

/customerbasicinfo_view/isCustomerEnrolled

Specifies whether the customer is enrolled in the application. The value is Boolean.

/customerbasicinfo_view/FirstName

Specifies the first name of the customer.

/customerbasicinfo_view/IsOlbAllowed

Specifies whether the Online Banking application is available for the customer. The value is Boolean.

/customerbasicinfo_view/SSN

Specifies the Social Security Number of the customer.

/customerbasicinfo_view/PrimaryEmailAddress

Specifies the primary email address of the customer.

/customerbasicinfo_view/CustomerStatus_id

Specifies the unique ID that is based on the status of the customer.

/customerbasicinfo_view/Username

Specifies the unique ID for the username of the customer.

/customerbasicinfo_view/Customer_id

Specifies the unique ID of the customer.

/customerbasicinfo_view/PrimaryPhoneNumber

Specifies the primary phone number of the customer.

/customerbasicinfo_view/CustomerSince

Specifies the date from which the user has been part of the application.

/customerbasicinfo_view/isEagreementSigned

Specifies whether the electronic agreement is signed. The value is Boolean.

/customerbasicinfo_view/LastName

Specifies the last name of the customer.

{
   "customerbasicinfo_view":{
      "accountLockoutTime":"1440",
      "CustomerType_Description":"Retail Banking user",
      "isActivationLinkSent":"true",
      "isCombinedUser":"false",
      "CustomerStatus_name":"Customer Active",
      "isCustomerAccessiable":true,
      "combinedUserId":"",
      "IsEnrolledForOlb":"false",
      "OLBCustomerFlags":{
         "Status":"ACTIVE",
         "LockedOn":""
      },
      "Name":"John  Bailey",
      "IsStaffMember":"false",
      "customerStatus":"SID_CUS_ACTIVE",
      "CustomerType_Name":"Retail Banking",
      "CustomerType_id":"TYPE_ID_RETAIL",
      "DateOfBirth":"1985-05-05",
      "lockCount":"0",
      "IsAssistConsented":"true",
      "isCustomerEnrolled":"true",
      "FirstName":"John",
      "IsOlbAllowed":"false",
      "SSN":"065452564",
      "PrimaryEmailAddress":"dbxuser@infinity.com",
      "CustomerStatus_id":"SID_CUS_ACTIVE",
      "Username":"dbpolbuser",
      "Customer_id":"1002496540",
      "PrimaryPhoneNumber":"+91-4258303691",
      "CustomerSince":"2019-01-28 17:02:20.0",
      "isEagreementSigned":"false",
      "LastName":"Bailey"
   },
   "Configuration":{
      "value":"1440"
   },
   "opstatus":0,
   "httpStatusCode":0
}
Error Code(s): None

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?