SCA Solicited User Enrollment

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.

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"
}

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.

None

This API is used in the application to update customer details.

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\"}]"
}

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"
}

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.

Parameters

Id

Specifies the unique ID of the user.

{
    "id":"2023121885"
}

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

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. Validation should take place in authentication server and not in infinity.

Parameters

UserName

Specifies the unique ID of the username.

activationCode

Specifies the activation code sent to the user through mobile.

{
    "UserName":"9874808317",
    "activationCode":"DEQ8x"
}

Parameters

/isActivationCodeValid

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

{
    "isActivationCodeValid": "true",
    "opstatus": 0,
    "serviceKey": "2e323da0-607b-4d23-8082-019e55dfc92c",
    "httpStatusCode": 0
}

Error Response

{
   "isActivationCodeValid":"false",
   "httpStatusCode": 0,
   "opstatus": 0 
}

• Error Code: 10741
  Error Message: Failed to validate activation code
• Error Code: 10742
  Error Message: Invalid parameters please give valid details.
• Error Code: 10743
  Error Message: Failed to generate Service Key

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. These validations must be validated in the authentication server.

Parameters

serviceKey

Specifies the service key for updating the password.

Password

Specifies the new password that must be updated.

{
    "serviceKey":"59b0be9f-fabb-40e3-bbc0-b79f1e91dcf7", // serviceKey picked from validateActivationCodeForEnrollment service response
    "Password":"Kony@1234"
}

Success Response

{
    "status": "true",
    "opstatus": 0,
    "httpStatusCode": 0
}

Error Response

{
    "dbpErrMsg: "Invalid parameters please give valid details",
    "dbpErrCode: "10742",
    "opstatus": 0,
    "httpStatusCode": 200
}

• Error Code: 10742
  Error Message: Invalid parameters please give valid details.
• Error Code: 10744
  Error Message: Unable to set the password

This API allows the user to fetch the basic information about the customer from the customer profile.

Parameters

Customer_id

Specifies the unique ID of the customer.

{
    "Customer_id":"1002496540"
}

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
}