Infinity Origination
The Infinity Origination app enables banks and credit unions to open an account for customers across multiple channels. It seamlessly integrates with other Infinity apps suite and it is also available as a standalone solution, providing a simple and intuitive account opening experience.
The Infinity Origination provides an effortless experience to customers by asking for minimal information, leveraging different Fintech APIs, and enabling immediate account activation. It delivers product selection and account funding for a better experience.
| API | Description | Introduced In |
|---|---|---|
| updateIdentityInfo | Updates the Identity information section in the Onboarding application with details such as ID Type, ID Number, Issued Date, Issued State, and Expiration Date. | 2021.01 |
| getIdentityInfo | Retrieves the details from the Identity Information section in the Onboarding application. | 2021.01 |
| updateAddressInfo | Updates the address information of the user. This API is used when the customer wants to update the address details in the application. | 2021.01 |
| getAddressInfo | Retrieves the details that are provided in the Address Information section, such as city, state, and zip code. This API is used to retrieve the address details during the application registration process. | 2021.01 |
| getAddressSuggestions | Retrieves the address suggestions based on the address that is being typed by the user and the user's current location by using Google APIs. For example, when a user is typing an address, this API creates a circle with the location of the user as the center of the circle. The API then provides address suggestions from locations within the circle that match the address that is being typed by the user. If there are no suggestions that can be provided within the circle, then the API fetches the locations from outside the circle and suggests the addresses to the user. The maximum number of address suggestions that the API can fetch is 5. The API response contains a parameter called Place_ID, which is used by the getFormattedAddress API to fetch additional address details. | 2021.01 |
| getFormattedAddress | Retrieves the additional address details based on the address suggestion that is selected by the applicant. Every address suggestion is associated with a specific place_ID and by using this unique ID, the API fetches the additional details. The address details include information on the street, city, country, and zip code. | 2021.01 |
| updatePersonalInfo | Updates the personal information section with the applicant's and co-applicant's information, such as First Name, Last Name, Date of Birth, Mobile Number, Email ID, and so on. The API fetches the XML data from the Origination Data Microservice (ODMS) and updates the XML file accordingly. | 2021.01 |
| getPersonalInfo | Retrieves and filters the application data from the Origination Data Microservice (ODMS) based on the application ID. The filtered data contains personal information such as First Name, Last Name, Date of Birth, and Email ID, which is sent as a response to the user. | 2021.01 |
| getProductSelection | Retrieves all the selected products from the Origination Data Microservice (ODMS). | 2021.01 |
| updateProductSelection | Updates the selected products in the Origination Data Microservice (ODMS); and the Product IDs in Infinity. | 2021.01 |
| requestMFAOtp | 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. | 2021.01 |
| verifyMFAOtp | 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 |
| createApplication | Creates an application in the Data microservice from the Onboarding application. This API is used in the Personal Information module of the Onboarding application | 2021.01 |
| updateApplication | Updates the application to the Data microservice after obtaining the application status. This API invokes the rules engine to fetch the individual decisions of the applicant and co-applicant, which contain information about the application status. After the API obtains the individual decisions, it submits the application to the Data microservice. | 2021.01 |
| executeIDV | Executes the Identity verification module of an applicant by leveraging a third-party service called IDology. Based on the execution, the API might return a few security questions to complete the identity verification process. The identity verification is done based on the user's response to the questions. | 2021.01 |
| verifyIDVResponse | Verifies the response or answers that are provided by the user to the identity verification questions by leveraging the IDology service. | 2021.01 |
| submitOnBoardingApplication | Updates the application status based on the applicant's status and also notifies the applicant or co-applicant if the application is under review | 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 |
| decryptresumeLink | Retrieves and de-crypts the URL link that is required to resume the process of application creation. | 2021.01 |
| fetchConfigurations | Retrieves the key-value pairs that are present in the Configuration Bundle of the System Configurations in the Spotlight app. | 2021.01 |
| getMembershipEligibilityCriteriaList | Retrieves the eligibility criteria list from the Business Configurations module in the Spotlight app by using the getEligibilityCriteria service. In the Onboarding application, this API is used in the EligibilityCheck module. | 2021.01 |
| getTermsAndConditionsConfigs | Retrieves the URL for Terms and Conditions from the Spotlight application. | 2021.01 |
| getCountries | Retrieves the list of countries from the Spotlight app. | 2021.01 |
| getRegions | Retrieves the list of regions from the Spotlight app. | 2021.01 |
| isSharedTokenValid | Verifies whether the CSR request is authorized a for new customer. | 2021.01 |
| VerifyDocuments | Retrieves the details of the scanned document. The supported documents are Passport and Driving Licence. This API leverages a third-party vendor called AuthenticID. | 2021.01 |
| getProductGroupsWithPurpose | Retrieves the list of product groups based on the purpose. The product groups are displayed as cards on the landing page and the hamburger menu. | 2021.01 |
| getProductsFromProductGroup | Retrieves the list of products that are part of a product group. The list is displayed on the frmProductGroup page. | 2021.01 |
| getProductDetails | Retrieves the details of the product that is selected, when the Learn More (product group page) onClick action is triggered. The API populates the response on the frmProductDetails page. | 2021.01 |
| createFunding | Creates a funding application (a separate JS module) in the Origination Data Microservice (ODMS). The data that is passed to the ODMS includes the parent application ID. | 2021.01 |
| getProductsSelected | Retrieves the product that is selected by the user based on the application ID. The product is retrieved from the customer application and the Party back-end system. | 2021.01 |
| getFundingProducts | Retrieves the products that are selected by the user for funding. This API is used to re-populate the data while the user navigates back to the client app. | 2021.01 |
| getProductsForPurpose | Retrieves the list of products from the Marketing Catalog microservice based on the specified purpose. For example, the Deposit product group contains various products such as Long Term Deposits, 3 year Deposits, and so on. If the user sets the purpose as Onboarding then all the products that are associated with Onboarding are fetched. | 2021.01 |
| getFeaturesForProducts | Retrieves the features that are specific to a product based on the product reference. For example, features such as CARD.ISSUE and E-Statement are fetched for Prime Saving Account product based on the SAVINGS.PRIME.INFINITY reference that is provided by the user | 2021.01 |
| createProspectProfile | Whenever the user submits the details during the process of application creation, the createProspectProfile API creates a prospect in the DBX DB (Backend database) with the details. The API is also connected to the Origination Data Microservice (ODMS) Business Delegates that update the XML applicant data in the ODMS. | 2021.01 |
| updatePropsectProfile | Whenever the user submits the details during the process of application creation, the udpateProspectProfile API updates the DBX DB (Backend database) with these details. The API is also connected to Origination Data Microservice (ODMS) Business Delegates that updates the XML applicant data in the ODMS. | 2021.01 |
| updateLastEditedSection | Updates the last edited section in the Data microservice. The API updates the section every time the screen loads. | 2021.01 |
| updateApplicationStatus | Updates the decision of the application on whether to approve or deny the application from the workspace. | 2021.01 |
| getAllCDPlansForProduct | Retrieves all the Certificate of Deposit plans that are associated with a product. The Certificate of Deposit plans are generated based on the amount range and time period. | 2021.01 |
| verifyStaticSelfie | Verifies the static selfie (Near selfie) with the photo of the client in the document. This API leverages a third party vendor called AuthenticID. | 2021.01 |
| LivelinessSelfie | Verifies the liveliness selfie (Far selfie) with the photo of the client in the document. This API leverages a third party vendor called AuthenticID. | 2021.01 |
| updateSelfieScoreAndResult | Updates the selfie score and result fetched from the Authentic ID to the Origination Data Microservice (ODMS). | 2021.01 |
| updateFundingData | Updates the funding data to the Origination Data Microservice (ODMS). | 2021.01 |
| createInfinityProspect | Creates a new Infinity prospect in the DBX DB. | 2021.01 |
| createInfinityProspectAndLogin | Creates a new Infinity prospect in the DBX Database and performs a silent login for the applicant. | 2021.01 |
| createRetailContract | Creates a new retail contract. | 2021.01 |
| getMFAScenario | 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. | 2021.01 |
| getApplicationDetails | Retrieves the application details stored in the Origination Data Microservice (ODMS) | 2021.01 |
| updateUserActionStatus | Updates the status of a user action in the Origination Data Microservice. | 2021.04 |
| getTask | Retrieves all the details of a task and corresponding task’s application details. | 2021.04 |
| getAllTasksForAppID | Retrieves all tasks for a given application Id from RedHat PAM. | 2021.04 |
| startTask | Initiates action on the task and starts the task in RedHat PAM. | 2021.04 |
| completeTask | Initiates action on the task and completes the task in RedHat PAM. | 2021.04 |
| getTaskDetails | Retrieves all the details of a task from PAM based on task ID and corresponding application Details from ODMS. | 2021.04 |
| getConfigs | Retrieves the configurations stored from microservice. | 2021.04 |
| createConfig | Creates a record or configuration in the microservice. | 2021.04 |
| resumeProspectOnboardingApplication | Retrieves the Origination URL to resume the application for prospect. | 2021.04 |
| resumeCustomerOnboardingApplication | Retrieves the Origination URL to resume the application for customer. | 2021.04 |
| downloadDocument | Retrieves the document that is uploaded through the Infinity Origination app. | 2021.04 |
| CreateUserActionOperation | After an application is submitted and the application status goes to Under Review, this API creates a new user action from the RedHat. | 2021.04 |
| UpdateUserActionOperation | This Api is invoked for each user action response submitted by the user. | 2021.04 |
| GetUserActionOperation | Retrieves the user action responses provided by the user. | 2021.04 |
| AbandonRetailOriginationApplication | Whenever cancel opportunity event is raised from Sales Force, this API updates the application status as Abandoned. | 2021.04 |
| ApplyForCreditCardService | This service is used to create credit card (DBXDB card table). This is an orchestration service provisioning as an enabler to create such accounts on the 3rd party system and is invoked from Redhat workflow. | 2021.04 |
| uploadDocument | Enables uploading and storing of a document in the Document microservice. | 2021.04 |
| AddEntitlementsOperation | Automatically triggered by ODMS on successful updation of PartyId or CIF, and application creation to add an entitlement for the current user. | 2021.04 |
| AddEntitlementbyUserId | Adds entitlements by unique user id. | 2021.04 |
| createAccount | This service is used to create account in Temenos Transact. | 2021.04 |
| UpdateCustomerDetailsOnboarding | This service is used to update Party microservice and/or Temenos Transact depending on the business outcome deployed. | 2021.04 |
updateIdentityInfo
| Description: | Updates the Identity information section in the Onboarding application with details such as ID Type, ID Number, Issued Date, Issued State, and Expiration Date. | ||||||
| Method: | PUT | ||||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/IdentityInfo/updateIdentityInfo | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters FormCode Specifies the unique entity definition code. Application_id Specifies the entity definition key. TaxIdNum Specifies the Tax Identification Number. IdType Specifies the type of Identification. IdNum Specifies the Identity Number. IssuedCountry Specifies the country in which the applicant's ID was issued. IssuedState Specifies the State in which the applicant's ID was issued. IssuedDate Specifies the date on which the applicant's ID was issued. ExpirationDate Specifies the expiration date of the applicant's ID. Party_id Specifies the unique ID of the Party Micro Service. ApplicantType Specifies the type of applicant such as general applicant or co-applicant. SectionProgress Specifies the progress made by the user to the current section (InProgress/Done). BranchReference Specifies the reference code of the branch EntityId Specifies the record ID for the entity item data. {
"FormCode":"onboarding",
"Application_id":"NCF284D",
"TaxIdNum":"1545562",
"IDType":"Driver License",
"IdNumber":"d46546",
"IssuedDate":"",
"ExpirationDate":"2022-01-01",
"Party_id":"2262626",
"ApplicantType":"Applicant",
"SectionProgress":"Done",
"BranchReference":"0000001202",
"EntityId":"5fcf256502eb1f66e4f8bd27"
}
|
||||||
| Response: | //Success Response
{
"opstatus":0,
"httpStatusCode":0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Identity update failed"
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getIdentityInfo
| Description: | Retrieves the details from the Identity Information section in the Onboarding application. | ||||||
| Method: | POST | ||||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/IdentityInfo/getIdentityInfo | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters ApplicantType Specifies the type of applicant (Applicant/Co-Applicant). Application_id Specifies the entity definition key. DateOfBirth Specifies the date of birth of the applicant. //Applicant Case
{
"ApplicantType": "Applicant",
"Application_id": "5Y78JLZ",
"DateOfBirth": "1975-02-02"
}
//Co-Applicant Case
{
"ApplicantType": "CoApplicant",
"Application_id": "5Y78JLZ",
"DateOfBirth": "1975-02-02"
}
|
||||||
| Response: |
Parameters /IssuedDate Specifies the date on which the id has been issued. /ExpirationDate Specifies the expiration date. /IssuedCountry Specifies the country in which the id is issued. /TaxIdNum The Tax Identification Number. /IdNum The Identification Number. /IdType Specifies the type of identification.
{
"IssuedDate":"2005-01-01",
"ExpirationDate":"2025-01-01",
"IssuedCountry":"USA",
"TaxIdNum":"123456789 ",
"IdNum":"1234543210",
"opstatus":0,"IssuedState":"USA",
"IDType":"Passport",
"httpStatusCode":0
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
updateAddressInfo
| Description: | Updates the address information of the user. This API is used when the customer wants to update the address details in the application. | ||||||
| Method: | PUT | ||||||
| URL: | <BASE URI>/services/data/v1/OnBoarding/objects/AddressInfo/updateAddressInfo | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters FormCode Specifies the unique entity definition code. Application_id Specifies the entity definition key. AddressLine1 Specifies the first line address of the applicant. AddressLine2 Specifies the second line address of the applicant. City Specifies the name of the city of the applicant. State Specifies the name of the state of the applicant. Country Specifies the name of the country of the applicant. Zipcode Specifies the zipcode number of the applicant. Party_id Specifies the unique ID of the Party Micro Service. ApplicantType Specifies the type of applicant such as general applicant or co-applicant. SectionProgress Specifies the progress made by the user to the current section (InProgress/Done) {
"FormCode": "onboarding",
"Application_id": "VRCBDZJ",
"AddressLine1": "2042 Peach Orchard Drive",
"AddressLine2": "limne2",
"City": "Falls Church",
"State": "US-VA",
"Country": "US",
"Zipcode": "22043",
"Party_id": "191296",
"ApplicantType": "Applicant",
"SectionProgress": "Done"
}
|
||||||
| Response: | //Success Response
{
"opstatus":0,
"httpStatusCode":0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Address update failed"
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getAddressInfo
| Description: | Retrieves the details that are provided in the Address Information section, such as city, state, and zip code. This API is used to retrieve the address details during the application registration process. | ||||||
| Method: | POST | ||||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/IdentityInfo/getAddressInfo | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters ApplicantType Specifies the type of applicant. Application_id Specifies the entity definition key. DateOfBirth Specifies the date of birth of the applicant. //Applicant Case
{
"ApplicantType": "Applicant",
"Application_id": "5Y78JLZ",
"DateOfBirth": "1975-02-02"
}
//Co-Applicant Case
{
"ApplicantType": "CoApplicant",
"Application_id": "5Y78JLZ",
"DateOfBirth": "1975-02-02"
}
|
||||||
| Response: |
Parameters /AddressLine1 Specifies the address of the applicant. /AddressLine2 Specifies the address of the applicant /City Specifies the city name. /State Specifies the state name. /Country Specifies the country name. /Zipcode Specifies the zipcode number. {
"AddressLine2":"phoneix line2",
"AddressLine1":"phoenix line1",
"State":"NY",
"ZipCode":"",
"PersonalInfo_id":"",
"Country":"USA",
"opstatus":0,"City":"new york",
"httpStatusCode":0
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getAddressSuggestions
| Description: | Retrieves the address suggestions based on the address that is being typed by the user and the user's current location by using Google APIs. For example, when a user is typing an address, this API creates a circle with the location of the user as the center of the circle. The API then provides address suggestions from locations within the circle that match the address that is being typed by the user. If there are no suggestions that can be provided within the circle, then the API fetches the locations from outside the circle and suggests the addresses to the user. The maximum number of address suggestions that the API can fetch is 5. The API response contains a parameter called Place_ID, which is used by the getFormattedAddress API to fetch additional address details. | |||||
| Method: | POST | |||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/IdentityInfo/getAddressInfo | |||||
| Security Level: | Authorized App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters currLatitude Specifies the current latitude. currLatitude Specifies the current latitude. query {
"currLatitude": "17.520886",
"currLatitude": "78.383309",
"query": "kony austin"
}
|
|||||
| Response: |
Locations [] Specifies the Address with the place ID. Parameters Locations/formattedAddress Specifies the formatted address (The suggested address). Locations/place_id Specifies the place id. {
"Locations": [
{
"formattedAddress": "Kony, Bee Caves Road, Austin, TX, USA",
"place_id": "ChIJAXznRt41W4YRP1Dhw1NrYo0"
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
getFormattedAddress
| Description: | Retrieves the additional address details based on the address suggestion that is selected by the applicant. Every address suggestion is associated with a specific place_ID and by using this unique ID, the API fetches the additional details. The address details include information on the street, city, country, and zip code. | |||||
| Method: | POST | |||||
| URL: | {base_url}/services/data/v1/OBLocationsObjServices/operations/Locations/getFormattedAddress | |||||
| Security Level: | Authorized App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters place_id Specifies the id of a particular place. {
"place_id": "ChIJAXznRt41W4YRP1Dhw1NrYo0"
}
|
|||||
| Response: |
Locations [] Specifies the Address with the place ID. Parameters Locations/formattedAddress Specifies the formatted address (The suggested address). Locations/address_components Specifies the various components of an address. Locations/types Specifies the formatted address type. Locations/short_name Specifies the truncated address. Locations/long_name Specifies the complete address. {
"Locations": [
{
"formattedAddress": "9225 Bee Caves Rd #300, Austin, TX 78733, USA",
"address_components": "[{\"types\":[\"subpremise\"],\"short_name\":\"300\",\"long_name\":\"300\"},{\"types\":[\"street_number\"],\"short_name\":\"9225\",\"long_name\":\"9225\"},{\"types\":[\"route\"],\"short_name\":\"Bee Caves Rd\",\"long_name\":\"Bee Caves Road\"},{\"types\":[\"neighborhood\",\"political\"],\"short_name\":\"Barton Creek Highlands\",\"long_name\":\"Barton Creek Highlands\"},{\"types\":[\"locality\",\"political\"],\"short_name\":\"Austin\",\"long_name\":\"Austin\"},{\"types\":[\"administrative_area_level_2\",\"political\"],\"short_name\":\"Travis County\",\"long_name\":\"Travis County\"},{\"types\":[\"administrative_area_level_1\",\"political\"],\"short_name\":\"TX\",\"long_name\":\"Texas\"},{\"types\":[\"country\",\"political\"],\"short_name\":\"US\",\"long_name\":\"United States\"},{\"types\":[\"postal_code\"],\"short_name\":\"78733\",\"long_name\":\"78733\"},{\"types\":[\"postal_code_suffix\"],\"short_name\":\"6202\",\"long_name\":\"6202\"}]"
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Error Code(s): |
None |
|||||
| Service Flow: |
|
updatePersonalInfo
| Description: | Updates the personal information section with the applicant's and co-applicant's information, such as First Name, Last Name, Date of Birth, Mobile Number, Email ID, and so on. The API fetches the XML data from the Origination Data Microservice (ODMS) and updates the XML file accordingly. | ||||||
| Method: | POST | ||||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/PersonalInfo/updatePersonalInfo | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters FormCode Specifies the unique entity definition code. Application_id Specifies the entity definition key. FirstName Specifies the first name of the applicant. LastName Specifies the last name of the applicant. DateOfBirth Specifies the date of birth of the applicant. Specifies the Email address of the applicant. MobileCountryCode Specifies the mobile country code. MobileNumber Specifies the mobile number of the applicant. BranchReference Specifies the reference code of the branch Party_id Specifies the unique ID of the Party Micro Service. ApplicantType Specifies the type of applicant such as general applicant or co-applicant. EntityId Specifies the record ID for the entity item data. {
"FormCode":"onboarding",
"Application_id": "57K6SR4",
"FirstName": "Deekshith",
"LastName": "Sama",
"DateOfBirth": "2000-01-10",
"Email": "deekshithreddy@temenos.com",
"MobileCountryCode": "+91",
"MobileNumber": "8754682294",
"BranchReference": "GB0010001",
"Party_id":"191299",
"ApplicantType": "Applicant",
"SectionProgress": "Done",
"EntityId":"5fcf367802eb1f66e4f8bd42"
}
|
||||||
| Response: | //Success Response
{
"opstatus":0,
"httpStatusCode":0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Personal Info update failed"
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getPersonalInfo
| Description: | Retrieves and filters the application data from the Origination Data Microservice (ODMS) based on the application ID. The filtered data contains personal information such as First Name, Last Name, Date of Birth, and Email ID, which is sent as a response to the user. | |||||||
| Method: | POST | |||||||
| URL: | <BASE URI>/services/data/v1/OnBoarding/objects/PersonalInfo?formCode={entityDefinitionCode}&Application_id={Application_id}&Party_id={partyid} | |||||||
| Security Level: | Authenticated App User | |||||||
| Header Request: |
|
|||||||
| Body Request: |
Parameters ApplicantType (Mandatory) Specifies the type of applicant. Application_id (Mandatory) Specifies the entity definition key. DateOfBirth Specifies the date of birth of the applicant. {
"ApplicantType": "Applicant",
"Application_id": "CYT9NLC",
"DateOfBirth": "1985-05-05"
}
|
|||||||
| Response: |
Parameters /FirstName Specifies the first name of the applicant. /LastName Specifies the last name of the applicant. /DateOfBirth Specifies the date of birth of the applicant. Specifies the email address of the applicant. /MobileCountryCode Specifies the mobile country code. /MobileNumber Specifies the mobile number of the applicant. /ApplicantType Specifies the type of applicant such as general applicant or co-applicant. /Application_id Specifies the entity definition key. {
"DateOfBirth": "1985-05-05",
"MobileNumber": "1234567890",
"Email": "dbxuser@infinity.com",
"Application_id": "CYT9NLC",
"ApplicantType": "Applicant",
"FirstName": "John",
"MobileCountryCode": "+91",
"opstatus": 0,
"LastName": "Bailey",
"httpStatusCode": 0
}
|
|||||||
| Error Code(s): |
|
|||||||
| Service Flow: |
|
getProductSelection
| Description: | Retrieves all the selected products from the Origination Data Microservice (ODMS). | |||||||
| Method: | POST | |||||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/ProductSelection/getProductSelection | |||||||
| Security Level: | Authenticated App User | |||||||
| Header Request: |
|
|||||||
| Body Request: |
Parameters Application_id Specifies the entity definition key. {
"Application_id": "JLV95SP"
}
|
|||||||
| Response: |
Parameters /records Specifies an array of records in a JSON object. /records/DateOfBirth Specifies the date of birth of the user. /records/MobileNumber Specifies the mobile number of the user. /records/Email Specifies the email ID of the user. /records/FirstName Specifies the first name of the user. /records/MobileCountryCode Specifies the mobile country code. /records/Title Specifies the title of the record. /records/LastName Specifies the last name of the user. /records/ID Specifies the unique ID of the product. /records/MiddleName Specifies the middle name of the user. {
"opstatus":0,
"httpStatusCode":0,
"records":[
{
"DateOfBirth":"2000-01-10",
"MobileNumber":"8754682294",
"Email":"deekshithreddy@temenos.com",
"FirstName":"DeekshithReddy",
"MobileCountryCode":"+91",
"Title":"",
"LastName":"Sama",
"ID":"5fcf405102eb1f66e4f8bd4b",
"MiddleName":""
}
]
}
|
|||||||
| Error Code(s): |
Error Code: 73400 |
|||||||
| Service Flow: |
|
updateProductSelection
| Description: | Updates the selected products in the Origination Data Microservice (ODMS); and the Product IDs in Infinity. | ||||||
| Method: | PUT | ||||||
| URL: | <BASE URI>/services/data/v1/OnBoarding/objects/ProductSelection/updateProductSelection | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters /FormCode Specifies the unique entity definition code. /Application_id Specifies the entity definition key. /NoOfProducts Specifies the number of products. /ProductIDs Specifies the unique IDs of the products that must be updated. /Products Specifies an array of products and their corresponding details in a JSON object. /Products/ProductGroupId Specifies the unique ID of the product group. /Products/ProductGroupRef Specifies the reference number of the product group. /Products/ProductCurrencyId Specifies the unique ID of the product currency. /Products/ProductGroupDisplayName Specifies the display name of the product group. /Products/ProductName Specifies the name of the product. /Products/ProductId Specifies the unique ID of the product. /Products/ProductRef Specifies the reference code for the product. /Products/AccountNumber Specifies the account number of the user. /Products/BranchReference Specifies the reference code of the branch. /SectionProgress Specifies the progress made by the user to the current section (InProgress/Done). /EntityId Specifies the record ID for the entity item data. {
"formCode":"onboarding",
"Application_id":"9CCFRS5",
"NoOfProducts":4,
"ProductIDs":"SAVINGS.PRIME.INFINITY,SAVINGS.SALARY.INFINITY,SAVINGS.STANDARD.INFINITY,Test123",
"Products":{
"Product":[
{
"ProductGroupId":"PG2030125BDK",
"ProductGroupRef":"SAVINGS.ACCOUNTS",
"ProductCurrencyId":"USD",
"ProductGroupDisplayName":"Savings Accounts",
"ProductName":"Prime Saving Account",
"ProductId":"PR20301ARET5",
"ProductRef":"SAVINGS.PRIME.INFINITY",
"AccountNumber":" ",
"BranchReference":"GB0010001"
},
{
"ProductGroupId":"PG2030125BDK",
"ProductGroupRef":"SAVINGS.ACCOUNTS",
"ProductCurrencyId":"USD",
"ProductGroupDisplayName":"Savings Accounts",
"ProductName":"Salary Saving Account",
"ProductId":"PR20301GFEJG",
"ProductRef":"SAVINGS.SALARY.INFINITY",
"AccountNumber":" ",
"BranchReference":"GB0010001"
},
{
"ProductGroupId":"PG2030125BDK",
"ProductGroupRef":"SAVINGS.ACCOUNTS",
"ProductCurrencyId":"USD",
"ProductGroupDisplayName":"Savings Accounts",
"ProductName":"Standard Saving Account",
"ProductId":"PR20301MM14V",
"ProductRef":"SAVINGS.STANDARD.INFINITY",
"AccountNumber":" ",
"BranchReference":"GB0010001"
},
{
"ProductGroupId":"PG20301HU087",
"ProductGroupRef":"INTERMEDIARY",
"ProductCurrencyId":"USD",
"ProductGroupDisplayName":"",
"ProductName":"Test123",
"ProductId":"PR20301N8SPN",
"ProductRef":"Test123",
"AccountNumber":" ",
"BranchReference":"GB0010001"
}
]
},
"SectionProgress":"InProgress",
"EntityId":"5fcf780a02eb1f66e4f8bda1"
}
|
||||||
| Response: | //Success Response
{
"opstatus":0,
"httpStatusCode":0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Products update failed"
}
|
||||||
| Error Code(s): |
Error Code: 73200 |
||||||
| Service Flow: |
|
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/MessagingObjectService/operations/OTP/requestMFAOtp | ||||
| Security Level: | Authorized 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. {
"serviceKey":"a23e6ec9-963a-470e-9793-e5a82d0d6d6c",
"serviceName":"PROSPECT_EXPIRY",
"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: |
|
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/MessagingObjectService/operations/OTP/verifyMFAOtp | ||||
| Security Level: | Authorized 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. {
"success":"VERIFY_SUCCESS",
"opstatus":0,
"httpStatusCode":0
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
executeIDV
| Description: | Executes the Identity verification module of an applicant by leveraging a third-party service called IDology. Based on the execution, the API might return a few security questions to complete the identity verification process. The identity verification is done based on the user's response to the questions. | ||||
| Method: | GET | ||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/IDV/executeIDV | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
X-Kony-Authorization |
||||
| Body Request: |
Parameters ApplicantType (Mandatory) Specifies the type of applicant (Applicant/Co-applicant). Application_id (Mandatory) Specifies the entity definition key. DateOfBirth (Mandatory) Specifies the date of birth of the applicant. //Applicant Case
{
"ApplicantType": "Applicant",
"Application_id": "MBLL7FF",
"DateOfBirth": "1975-02-02"
}
//Co-Applicant Case
{
"ApplicantType": "CoApplicant",
"Application_id": "MBLL7FF",
"DateOfBirth": "1975-02-02"
}
|
||||
| Response: |
View the Response Parameters
Parameters Specifies the email address of the applicant. /Application_id Specifies the entity definition key. /PersonalInfo_id Specifies the ID of the personal info of the applicant. /MobileCountryCode Specifies the mobile country code. /Questions [] Specifies an array that contains a list of questions with their answers. Questions /questions Specifies a question with its answer. Questions /questions/type Specifies the type of the question. Questions /questions/prompt Specifies the question prompt. Questions /questions/answers Specifies the list of answers to a question. Questions /questions/answers/answer Specifies a single answer from the list of answers. /idType Specifies the ID type of the applicant. /IssuedDate Specifies the date on which the ID was issued. /ApplicantType Specifies the type of the applicant. /Zipcode Specifies the zipcode of the applicant. /IssuedState Specifies the state in which the ID was issued. /DateOfBirth Specifies the date of birth of the applicant. /FirstName Specifies the first name of the applicant. /City Specifies the city of the applicant. /isVerificationRequired Specifies whether verification for the answers is required or not. /AddressLine2 Specifies the address of the applicant. /MobileNumber Specifies the mobile number of the applicant. /AddressLine1 Specifies the address of the applicant. /ExpirationDate Specifies the expiration date of the issued ID. /State Specifies the state of the applicant. /IssuedCountry Specifies the country in which the ID was issued. /TaxIdNum Specifies the Tax identification number. /IdNum Specifies the Identification number. /Country Specifies the country of the applicant. /LastName Specifies the last name of the applicant. View the Response Sample Code
{
"Email": "sjlel@dehei.com",
"Application_id": "7DSCP3L",
"PersonalInfo_id": "30318",
"MobileCountryCode": "+1",
"IDType": "Driver License",
"IssuedDate": "2019-09-09",
"ApplicantType": "Applicant",
"Zipcode": "30318",
"IssuedState": "Hawaii",
"DateOfBirth": "1975-02-02",
"FirstName": "john",
"City": "atlanta",
"isVerificationRequired": false,
"AddressLine2": "",
"MobileNumber": "2345678901",
"AddressLine1": "222333 peachtree place",
"ExpirationDate": "2029-09-09",
"State": "GA",
"IssuedCountry": "United States of America",
"TaxIdNum": "333333333333333333",
"IdNum": "24356879",
"opstatus": 0,
"Country": "United States of America",
"LastName": "smith",
"httpStatusCode": 0
}
//OR
{
"Email": "john.smith123@gmail.com",
"Application_id": "MBLL7FF",
"PersonalInfo_id": "30319",
"MobileCountryCode": "+1",
"questions": [
{
"question": {
"answers": [
{
"answer": "JANE BROWN"
},
{
"answer": "DAVID BROWN"
},
{
"answer": "AUSTIN SMITH"
},
{
"answer": "None of the above"
}
],
"type": "person.not.known",
"prompt": "Which person is not a relative or someone that you know?"
}
},
{
"question": {
"answers": [
{
"answer": "ATLANTA"
},
{
"answer": "MINOT"
},
{
"answer": "HILLSIDE"
},
{
"answer": "None of the above"
}
],
"type": "city.of.residence",
"prompt": "In which city is ANY STREET?"
}
},
{
"question": {
"answers": [
{
"answer": "08"
},
{
"answer": "98"
},
{
"answer": "69"
},
{
"answer": "None of the above"
}
],
"type": "ssn.digits.start",
"prompt": "What are the first two digits of your Social Security Number?"
}
},
{
"question": {
"answers": [
{
"answer": "3 CRESSING CT"
},
{
"answer": "4344 BACKTRAIL DR"
},
{
"answer": "1084 BPEACHTREE CT"
},
{
"answer": "None of the above"
}
],
"type": "previous.address",
"prompt": "At which of the following addresses have you lived?"
}
}
],
"IDType": "Driver License",
"IssuedDate": "2019-09-09",
"ApplicantType": "Applicant",
"Zipcode": "30319",
"IssuedState": "Hawaii",
"DateOfBirth": "1975-02-02",
"FirstName": "john",
"City": "atlanta",
"isVerificationRequired": true,
"AddressLine2": "",
"MobileNumber": "123465890",
"AddressLine1": "222333 peachtree place",
"ExpirationDate": "2029-09-09",
"State": "GA",
"IssuedCountry": "United States of America",
"TaxIdNum": "33333333333333333",
"IdNum": "234567890",
"opstatus": 0,
"Country": "United States of America",
"LastName": "smith",
"httpStatusCode": 0
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
verifyIDVResponses
| Description: | Verifies the response or answers that are provided by the user to the identity verification questions by leveraging the IDology service. | ||||
| Method: | GET | ||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/IDV/verifyIDVResponses | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
X-Kony-Authorization |
||||
| Body Request: |
Parameters ApplicantType (Mandatory) Specifies the type of applicant. Application_id (Mandatory) Specifies the entity definition key. DateOfBirth (Mandatory) Specifies the date of birth of the applicant. responses (Mandatory) Specifies an array of response that includes question and its answer. question (Mandatory) Specifies a question. answer (Mandatory) Specifies an answer. //Applicant Case
{
"ApplicantType": "Applicant",
"Application_id": "MBLL7FF",
"DateOfBirth": "1975-02-02",
"responses": [
{
"question": "person.not.known",
"answer": "DAVID BROWN"
},
{
"question": "city.of.residence",
"answer": "ATLANTA"
},
{
"question": "ssn.digits.start",
"answer": "69"
},
{
"question": "previous.address",
"answer": "4344 BACKTRAIL DR"
}
]
}
//Co-Applicant Case
{
"ApplicantType": "CoApplicant",
"Application_id": "GTA231",
"responses": [
{
"question": "current.county.b",
"answer": "ESMERALDA"
},
{
"question": "person.known.fic",
"answer": "LISA MCKITRICK"
},
{
"question": "purchased.property.from",
"answer": "CHRIS THOMAS"
},
{
"question": "ssn.digits.start",
"answer": "48"
}
]
}
|
||||
| Response: | {
"httpStatusCode": 200,
"opstatus": 0,
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
createApplication
| Description: | Creates an application in the Origination Data Microservice (ODMS) from the Onboarding application. This API is used in the Personal Information module of the Onboarding application | ||||||
| Method: | POST | ||||||
| URL: | <BASE URI>/services/data/v1/OnBoarding/objects/Application/createApplication | ||||||
| Security Level: | Anonymous App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters FormCode Specifies the unique entity definition code. ProductRef Specifies the reference code for the product. ProductGroupRef Specifies the reference code for the product group. StartDate Specifies the date on which the application was started. {
"FormCode":"onboarding",
"ProductRef": "SAVINGS.PRIME.INFINITY",
"ProductGroupRef": "SAVINGS.ACCOUNTS",
"StartDate": "2020-12-04"
}
|
||||||
| Response: |
Parameters /Endpoint Specifies the endpoint URL of the application. /AccessToken Specifies the access token of the application. /RequestUrl Specifies the request URL of the applciation. /StartTime Specifies the start time of the application. /id Specifies the application ID. /AddressHash Specifies the address hash. //Success Response
{
"Endpoint": "https://eventconsumer-dot-transact-insights.appspot.com/_ah/api",
"AccessToken": "eyJraWQiOiJLQTAxIiwidHlwIjoiSldUIiwiYWxnIjoiSFMyNTYifQ.eyJpbnNpZ2h0cy5hdm9rYS5jb21cL0Zvcm1SZXF1ZXN0Ijp7ImZvcm1JZCI6MSwic3BhY2VJZCI6MSwiam9iSWQiOi0xLCJqb2JBY3Rpb25JZCI6LTEsImZvcm1WZXJzaW9uSWQiOjEsInJlcXVlc3RLZXkiOm51bGwsImN1c3RvbWVySWQiOiJBdm9rYSIsInNlc3Npb25JZCI6Nzc2Nywiam9iU3RlcElkIjotMSwidG1JbnN0YW5jZUlkIjoiM2NmOTIxM2EtZDBlNS00MjI0LThhMjAtZmU4ZWMzYmQxNWVhIiwiZm9ybVRyYW5zYWN0aW9uSWQiOjEsIm9yZ0lkIjoxfSwiZXhwIjoxNjA1NjczOTA3LCJpYXQiOjE2MDU2NzIxMDd9.8SLfnva4vUy5W7WRlwj-hOnaNZGzhF98CnsSKhQodWY",
"RequestUrl": "https://dbxlendingqa.konycloud.com",
"StartTime": "1605672107277",
"opstatus": 0,
"id": "C9WLRD7",
"httpStatusCode": 0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Application create failed"
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
updateApplication
| Description: | Updates the application to the Origination Data Microservice (ODMS) after obtaining the application status. This API invokes the rules engine to fetch the individual decisions of the applicant and co-applicant, which contain information about the application status. After the API obtains the individual decisions, it submits the application to the Data microservice. | ||||||
| Method: | PUT | ||||||
| URL: | <BASE URI>/services/data/v1/OnBoarding/objects/Application/updateApplication | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters FormCode Specifies the unique entity definition code. Application_id Specifies the entity definition key. Status Specifies the status of the application. StartDate Specifies the date on which the application was started. ApplicationType Specifies the type of applicant such as general applicant or co-applicant. EligibilityCriteria Specifies the eligibility criteria for accessing the Infinity Origination application. IsExistingCustomer Specifies whether the user is an already existing customer in the Infinity Origination application. CoApplicantCount Specifies the number of co-applicants. EntityId Specifies the record ID for the entity item data. {
"FormCode":"onboarding",
"Application_id":"HQ4X2MY",
"Status":"InProgress",
"StartDate":"2020-12-04",
"ApplicationType":"",
"EligibilityCriteria":"",
"IsExistingCustomer":"",
"CoApplicantCount":"",
"EntityId":"5fceec7402eb1f66e4f8bc79"
}
|
||||||
| Response: |
Parameters /totalRecords Specifies the total number of updated records. /Application_id Specifies the entity definition key. //Success Response
{
"totalRecords":1,
"Application_id":"HQ4X2MY",
"opstatus":0,
"httpStatusCode":0
}
//Error Response
{
"httpStatusCode":200,
"opstatus":0,
"dbpErrCode":73200,
"dbpErrMsg":"Application update failed"
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
submitOnBoardingApplication
| Description: | Updates the application status based on the applicant's status and also notifies the applicant or co-applicant if the application is under review | ||||||||
| Method: | POST | ||||||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/Application/submitOnBoardingApplication | ||||||||
| Security Level: | Authenticated App User | ||||||||
| Header Request: |
|
||||||||
| Body Request: |
Parameters /Application_id Specifies the entity definition key. /Payload Specifies the JSON payload. /Payload/DateOfBirth Specifies the date of birth of the applicant. /MetaData Specifies the meta data JSON. /MetaData/LastEditedSection Specifies the last edited section information that includes the form name. {
"Application_id":"R7GQM8H",
"Payload":{
"DateOfBirth":"2000-01-10"
},
"MetaData":{
"LastEditedSection":"SubmitModule|frmMembershipStatus"
}
}
|
||||||||
| Response: | //Success Response
{
"opstatus":0,
"httpStatusCode":0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Application submission failed"
}
|
||||||||
| 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/MessagingObjectService/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): |
Error Code: 74107 |
||||
| Service Flow: |
|
decryptresumeLink
| Description: | Retrieves and de-crypts the URL link that is required to resume the process of application creation. | |||||||
| Method: | POST | |||||||
| URL: | {base_url}/services/data/v1/MessagingObjectService/operations/Email/decryptResumeLink | |||||||
| Security Level: | Anonymous App User | |||||||
| Header Request: |
|
|||||||
| Body Request: |
Parameters url(Mandatory) Specifies the URL that must be decrypted. {
"url" :"ipsEi9CH3EClBHe6B51OvQ"
},
|
|||||||
| Response: |
Parameters /decryptedUrl Specifies the decrypted URL. /userType Specifies whether the applicant is an existing user. /applicationId Specifies the entity definition key. {
"decryptedUrl":"X6W6JTS110",
"userType":"NEW_USER",
"applicationId":"X6W6JTS"
}
|
|||||||
| Error Code(s): | None | |||||||
| Service Flow: |
|
fetchConfigurations
| Description: | Retrieves the key-value pairs that are present in the Configuration Bundle of the System Configurations in the Spotlight app. | ||||
| Method: | POST | ||||
| URL: | {BASE URI}/services/data/v1/ConfigurationObjService/operations/Configuration/getConfigurationsPreLogin | ||||
| Security Level: | Private( Internal server only) | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters bundle_name Specifies the bundle name that is associated with the Spotlight application. config_key Specifies the configuration key. {
"bundle_name": "InfinityWorkspace",
"config_key": ""
}
|
||||
| Response: |
View the Response Parameters
Configurations [] Specifies an array of parameters that are required to fetch the configurations. Configurations /isPreLoginConfiguration Specifies a boolean value based on the authentication type. Configurations /bundle_id Specifies the random bundle ID that is generated during runtime. Configurations /description Specifies the description about how the configuration is created. Configurations /bundle_name Specifies the name of the bundle. Configurations /type Specifies the type of configuration. (Infinity only supports Preference type as the value for type) Configurations /app_id Specifies the random application id that is generated during runtime. Configurations /value Specifies the runtime parameter value. Configurations /configuration_id Specifies the random configuration ID that is generated during runtime. Configurations /key Specifies the key that is used to identify the configuration. Configurations /target Specifies the target. The target can either be Client or Servers. View the Response Sample code
{
"Configuration":
{
}
,"opstatus":0,"Configurations":[
{
"isPreLoginConfiguration":"true",
"bundle_id":"INFINITY_WORKSPACE_CONFIG_BUNDLE",
"description":"Spotlight url",
"bundle_name":"InfinityWorkspace",
"type":"PREFERENCE",
"app_id":"InfinityWorkspace",
"value":"https://dbxdev.konycloud.com/apps/Spotlight/#_frmDashboard",
"configuration_id":"b3cfe0b4-e9ff-46bf-a061-89d54dd2d0c3",
"key":"AC_SPOTLIGHT_URL",
"target":"CLIENT"
}
,
{
"isPreLoginConfiguration":"true",
"bundle_id":"INFINITY_WORKSPACE_CONFIG_BUNDLE",
"description":"Direction of the app content",
"bundle_name":"InfinityWorkspace",
"type":"PREFERENCE",
"app_id":"InfinityWorkspace",
"value":"LTR",
"configuration_id":"fdcaba3d-7a06-4333-a75e-c689f0c104ff",
"key":"CONTENT_DIRECTION",
"target":"CLIENT"
}
,
{
"isPreLoginConfiguration":"true",
"bundle_id":"INFINITY_WORKSPACE_CONFIG_BUNDLE",
"description":"
{
"USD"-US Dollar,"EUR"-Euro,"CRC"-Costa Rican Colon,"GBP"-British Pound Sterling,"ILS"-Israeli New Sheqel,"INR"-Indian Rupee,"JPY"-Japanese Yen,"KRW"-South Korean Won,"NGN"-Nigerian Naira,"PHP"-Philippine Peso,"PLN"-Polish Zloty,"PYG"-Paraguayan Guarani,"THB"-Thai Baht,"UAH"-Ukrainian Hryvnia,"VND"-Vietnamese Dong
}
",
"bundle_name":"InfinityWorkspace",
"type":"PREFERENCE",
"app_id":"InfinityWorkspace",
"value":"USD",
"configuration_id":"1d90f2cc-2475-4804-83fc-0e091e7d27ce",
"key":"CURRENCY_CODE",
"target":"CLIENT"
}
,
{
"isPreLoginConfiguration":"true",
"bundle_id":"INFINITY_WORKSPACE_CONFIG_BUNDLE",
"description":""Submitted",
"Unsubmitted",
"Completed"",
"bundle_name":"InfinityWorkspace",
"type":"PREFERENCE",
"app_id":"InfinityWorkspace",
"value":"Submitted",
"configuration_id":"8471a931-4cd0-4b8e-a5fa-68dbc1209fd3",
"key":"DEFAULT_APPLICATION_VIEW",
"target":"CLIENT"
}
,
{
"isPreLoginConfiguration":"true",
"bundle_id":"INFINITY_WORKSPACE_CONFIG_BUNDLE",
"description":""Application Management" OR "Task Management"",
"bundle_name":"InfinityWorkspace",
"type":"PREFERENCE",
"app_id":"InfinityWorkspace",
"value":"Application Management",
"configuration_id":"5475c2ff-8401-4fe4-bb94-972da48e22b2",
"key":"DEFAULT_MODULE",
"target":"CLIENT"
}
,
{
"isPreLoginConfiguration":"true",
"bundle_id":"INFINITY_WORKSPACE_CONFIG_BUNDLE",
"description":"Timeout of the app",
"bundle_name":"InfinityWorkspace",
"type":"PREFERENCE",
"app_id":"InfinityWorkspace",
"value":"5",
"configuration_id":"fdcaba3d-7a06-4333-a75e-c689f0c104ef",
"key":"IDLE_TIMEOUT",
"target":"CLIENT"
}
],"httpStatusCode":200
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
getMembershipEligibilityCriteriaList
| Description: | Retrieves the eligibility criteria list from the Business Configurations module in the Spotlight app by using the getEligibilityCriteria service. In the Infinity Origination application, this API is used in the EligibilityCheck module. | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/MembershipEligibilityCriteria/getMembershipEligibilityCriteriaList | ||||
| Security Level: | Anonymous App User | ||||
| Header Request: |
|
||||
| Body Request: | Not Required | ||||
| Response: |
Parameters MembershipEligibilityCriteria Contains a JSON object with the value as an array of other JSON objects. /Status_id Specifies the Business Configuration ID of the Spotlight app. By using this ID a user can deactivate/activate the Business Configuration /description Specifies the description of the Business configuration that contains the value and key. /id Specifies the ID that belongs to the Spotlight DB. {
"MembershipEligibilityCriteria": [
{
"Status_id": "SID_ACTIVE",
"description": "{\"value\":\"I am related to a current Infinity DBX bank customer (Note: Eligible relationships include spouse, domestic partner, parent, grandparent, child, sibling, grandchild, step sibling, or adopted children).\",\"key\":\"44444\"}",
"id": "KONY_DBX_BANK_AREA_RESIDENT"
},
{
"Status_id": "SID_ACTIVE",
"description": "{\"value\":\"I am an employee or retiree of a company that Infinity DBX bank serves.\",\"key\":\"22222\"}",
"id": "KONY_DBX_BANK_CLIENT_ACQ"
},
{
"Status_id": "SID_ACTIVE",
"description": "{\"value\":\"I am a member of a membership organization Infinity DBX bank serves.\",\"key\":\"33333\"}",
"id": "KONY_DBX_BANK_MEMBER"
},
{
"Status_id": "SID_ACTIVE",
"description": "{\"value\":\"I live, work, worship, or attend school in a community that Infinity DBX bank serves.\",\"key\":\"11111\"}",
"id": "KONY_DBX_BANK_MEMBER_ACQ"
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
||||
| Error Code(s): | None | ||||
| Service Flow: |
|
getTermsAndConditionsConfigs
| Description: | Retrieves the URL for Terms and Conditions from the Spotlight application. | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/TermsAndConditions/getTermsAndConditionsConfigs | ||||
| Security Level: | Anonymous App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters languageCode(Mandatory) Specifies the language of the config. termsAndConditionsCode(Mandatory) Specifies the unique code for the Infinity Origination application. This code is used to retrieve the terms and conditions config that is associated with an application. {
"languageCode": "en-US",
"termsAndConditionsCode": "Onboarding_TnC"
}
|
||||
| Response: |
Parameters /versionId Specifies the ID of the version. /termsAndConditionsContent Specifies the content of the terms and conditions. /contentTypeId Specifies the type of content (HTML/Normal Text/URL). {
"versionId": "1.0",
"termsAndConditionsContent": "https://www.termsfeed.com/public/uploads/2019/04/terms-and-conditions-template.pdf",
"contentTypeId": "URL",
"opstatus": 0,
"status": "Success",
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
|
||||
| Associated APIs: | https://<HostName>/services/data/v1/RBObjects/operations/TermsAndConditions/getCustomerTermsAndConditionsPreLogin | ||||
| Service Flow: |
|
getCountries
| Description: | Retrieves the list of countries from the Spotlight app. | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/OnboardingC360ObjServices/operations/Location/getCountries | ||||
| Security Level: | Anonymous App User | ||||
| Header Request: |
|
||||
| Body Request: | Not required | ||||
| Response: |
View the Response Parameters
records [] Specifies the rows that are fetched from the table called country. NOTE: Note: The Spotlight app makes the call to the database. records /lastmodifiedts Specifies the time stamp at which the table was last modified. records /createdby Specifes the name of the user who created the table. records /modifiedby Specifies the name of the user who modified the table. records /id Specifies the primary key of the table called country. records /synctimestamp Specifies the time stamp at which it was last synced. records /createdts Specifies the time stamp at which the row gets created. records /Code Specifies the country code records /softdeleteflag Specifies whether the column is deleted or not. records /Name Specifies the name of the country. View the Response Sample Code
{
"records": [
{
"lastmodifiedts": "2020-04-03 14:55:29.0",
"createdby": "Kony User",
"modifiedby": "Kony Dev",
"id": "Con1",
"synctimestamp": "2020-04-03 14:55:29.0",
"createdts": "2020-04-03 14:55:29.0",
"Code": "IND",
"softdeleteflag": "false",
"Name": "India"
},
{
"lastmodifiedts": "2020-04-03 14:55:29.0",
"createdby": "Kony User",
"modifiedby": "Kony Dev",
"id": "Con2",
"synctimestamp": "2020-04-03 14:55:29.0",
"createdts": "2020-04-03 14:55:29.0",
"Code": "USA",
"softdeleteflag": "false",
"Name": "United States of America"
},
{
"lastmodifiedts": "2020-04-03 14:55:38.0",
"createdby": "Kony User",
"modifiedby": "Kony Dev",
"id": "COUNTRY_ID3",
"synctimestamp": "2020-04-03 14:55:38.0",
"createdts": "2020-04-03 14:55:38.0",
"Code": "GER",
"softdeleteflag": "false",
"Name": "Germany"
},
{
"lastmodifiedts": "2020-04-03 14:55:38.0",
"createdby": "Kony User",
"modifiedby": "Kony Dev",
"id": "COUNTRY_ID4",
"synctimestamp": "2020-04-03 14:55:38.0",
"createdts": "2020-04-03 14:55:38.0",
"Code": "CHE",
"softdeleteflag": "false",
"Name": "Switzerland"
},
{
"lastmodifiedts": "2020-04-03 14:55:53.0",
"createdby": "Kony User",
"modifiedby": "Kony Dev",
"id": "COUNTRY_ID5",
"synctimestamp": "2020-04-03 14:55:53.0",
"createdts": "2020-04-03 14:55:53.0",
"Code": "EUR",
"softdeleteflag": "false",
"Name": "Europe"
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
||||
| Error Code(s): | None | ||||
| Service Flow: |
|
getRegions
| Description: | Retrieves the list of regions from the Spotlight app. | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/OnboardingC360ObjServices/operations/Location/getRegions | ||||
| Security Level: | Anonymous App User | ||||
| Header Request: |
|
||||
| Body Request: | Not required | ||||
| Response: |
View the Response Parameters
records [] Specifies the rows that are fetched from the table called country. records /lastmodifiedts Specifies the last modified time stamp. records /createdby Specifes the name of the user who created the table. records /Country_id Specifies the foreign key that is fetched from the country table records /modifiedby Specifies the name of the user who modified the table. records /id Specifies the primary key of the table called country. records /synctimestamp Specifies the time stamp at which it was last synced. records /createdts Specifies the time stamp at which the row gets created. records /Code Specifies the country code records /softdeleteflag Specifies whether the column is deleted or not. records /Name Specifies the name of the country. View the Response Sample Code
{
"records": [
{
"lastmodifiedts": "2020-04-03 14:55:33.0",
"createdby": "Kony User",
"Country_id": "Con1",
"modifiedby": "Kony Dev",
"id": "R1",
"synctimestamp": "2020-04-03 14:55:33.0",
"createdts": "2020-04-03 14:55:33.0",
"Code": "TS",
"softdeleteflag": "false",
"Name": "Telangana"
},
{
"lastmodifiedts": "2020-04-03 14:55:33.0",
"createdby": "Kony User",
"Country_id": "Con2",
"modifiedby": "Kony Dev",
"id": "R57",
"synctimestamp": "2020-04-03 14:55:33.0",
"createdts": "2020-04-03 14:55:33.0",
"Code": "NY",
"softdeleteflag": "false",
"Name": "New York"
},
{
"lastmodifiedts": "2020-04-03 14:55:33.0",
"createdby": "Kony User",
"Country_id": "Con2",
"modifiedby": "Kony Dev",
"id": "R62",
"synctimestamp": "2020-04-03 14:55:33.0",
"createdts": "2020-04-03 14:55:33.0",
"Code": "OR",
"softdeleteflag": "false",
"Name": "Oregon"
},
{
"lastmodifiedts": "2020-04-03 14:55:33.0",
"createdby": "Kony User",
"Country_id": "Con2",
"modifiedby": "Kony Dev",
"id": "R63",
"synctimestamp": "2020-04-03 14:55:33.0",
"createdts": "2020-04-03 14:55:33.0",
"Code": "MD",
"softdeleteflag": "false",
"Name": "Maryland"
},
{
"lastmodifiedts": "2020-04-03 14:55:33.0",
"createdby": "Kony User",
"Country_id": "Con2",
"modifiedby": "Kony Dev",
"id": "R64",
"synctimestamp": "2020-04-03 14:55:33.0",
"createdts": "2020-04-03 14:55:33.0",
"Code": "MA",
"softdeleteflag": "false",
"Name": "Massachusetts"
},
{
"lastmodifiedts": "2020-04-03 14:55:33.0",
"createdby": "Kony User",
"Country_id": "Con2",
"modifiedby": "Kony Dev",
"id": "R65",
"synctimestamp": "2020-04-03 14:55:33.0",
"createdts": "2020-04-03 14:55:33.0",
"Code": "MI",
"softdeleteflag": "false",
"Name": "Michigan"
},
{
"lastmodifiedts": "2020-04-03 14:55:53.0",
"createdby": "Kony User",
"Country_id": "COUNTRY_ID5",
"modifiedby": "Kony Dev",
"id": "REGION_ID87",
"synctimestamp": "2020-04-03 14:55:53.0",
"createdts": "2020-04-03 14:55:53.0",
"Code": "OL",
"softdeleteflag": "false",
"Name": "Oslo"
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
||||
| Error Code(s): | None | ||||
| Service Flow: |
|
isSharedTokenValid
| Description: | Verifies whether the CSR request is authorized a for new customer. | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/OnboardingdbpObjServices/operations/IsSharedTokenValid/IsSharedTokenValid | ||||
| Security Level: | Anonymous App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters session_token (Mandatory) Specifies the entity definition key. Authorization of the user is based on this session_token.
{
"session_token": "101bcbaf-82c8-4732-a1d7-20b9536a6534"
}
|
||||
| Response: |
Parameters /Result Specifies whether the shared token is valid or not. //Sucess Response
{
"opstatus": 0,
"Result":"true"
"httpStatusCode": 200
}
//Error Response
{
"opstatus": 0,
"Result": "false",
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
VerifyDocuments
| Description: | Retrieves the details of the scanned document. The supported documents are Passport and Driving Licence. This API leverages a third-party vendor called AuthenticID. | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/ScanDocumentObjectServices/operations/Documents/verifyDocuments | ||||
| Security Level: | Anonymous App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters accountCode (Mandatory) Specifies the unique code associated with the account. documentType (Mandatory) Specifies the type of document (Passport/ License). frontImage64 (Mandatory) Specifies the front image of the document. The image must be recorded in Base 64 format. backImage64 (Mandatory) Specifies the back image of the document. The image must be recorded in Base 64 format. {
"accountCode":"9999",
"documentType":"License/Passport",
"frontImage64":"xxxx",
"backImage64":"xxxx"
}
NOTE: The parameters change based on the type of document. If the document type is Passport, then the documentType and frontImage64 parameter are required. If the mandatory parameter is License, then all the three parameters are mandatory. |
||||
| Response: |
View the Response Parameters
/verifyStatus Specifies the status of the verification process. /prefillData Specifies the pre-filled data generated based on the document submitted. /executionStatus Specifies the status of the execution process. /LocationCode Specifies the unique location code. /ActionCode Specifies the unique action code for the verification. /ActionMessage Specifies the message associated with the action. /transactionId Specifies the unique ID of the transaction. View the Response Sample Code
{
"verifyStatus":"WAITING_SELFIE",
"prefillData":{
"DQL_Final_IssuerCode_Result":"IND",
"DQL_Final_AddressLine1_Result":"",
"DQL_Final_IssuerCountryCode2Digit_Result":"IN",
"DQL_Final_IssuerCountryCode_Result":"IND",
"DQL_Final_ClassName_Result":"Passport",
"DQL_Final_BirthDate_Result":"12/Apr/1995",
"DQL_Final_AddressPostalCode_Result":"",
"DQL_Final_IssueDate_Result":"",
"DQL_Final_FirstName_Result":"SHUBHAM",
"DQL_Final_AddressState_Result":"",
"DQL_Final_DocumentNumber_Result":"",
"DQL_Final_Surname_Result":"AHUJA",
"DQL_Final_ExpirationDate_Result":"",
"DQL_Final_AddressCity_Result":""
},
"executionStatus":"SUCCESS",
"LocationCode":"9999",
"ActionCode":"99",
"ActionMessage":"Please click to Continue.",
"opstatus":0,
"transactionId":"HDABsmeHAGFUQuFN",
"httpStatusCode":0
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
getProductGroupsWithPurpose
| Description: | Retrieves the list of product groups based on the purpose. The product groups are displayed as cards on the landing page and the hamburger menu. | ||||
| Method: | POST | ||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/ProductDashboard/getProductGroupsWithPurpose | ||||
| Security Level: | Authenticated App Users | ||||
| Header Request: |
|
||||
| Body Request: | None | ||||
| Response: |
View the Response Parameters
/ProductDashboard Specifies the product dashboard details. /ProductDashboard/ProductGroups Specifies the product groups that are present on the dashboard. /ProductDashboard/ProductGroups/productGroupId Specifies the ID that is associated with the Product group. /ProductDashboard/ProductGroups/productGroupDisplayName Specifies the display name of the product group. /ProductDashboard/ProductGroups/description Specifies a brief description about the product group. /ProductDashboard/ProductGroups/externalIndicator Specifies the external indicator of the product group. /ProductDashboard/ProductGroups/detailDescription Specifies a detailed description about the product group. /ProductDashboard/ProductGroups/disclosure Specifies the disclosure details of the product group. /ProductDashboard/ProductGroups/imageDetails Specifies the various details of the images in the product group, such as image type, height, and extension data. /ProductDashboard/ProductGroups/imageDetails/imageType Specifies the type of the image. /ProductDashboard/ProductGroups/imageDetails/height Specifies the height of the image /ProductDashboard/ProductGroups/imageDetails/extensionData Specifies the extension data that is associated with the image. /ProductDashboard/products Specifies various product details such as ID, currency ID, and so on. /ProductDashboard/products/productId Specifies the ID of the product. /ProductDashboard/products/currencyId Specifies the ID of the currency. /ProductDashboard/products/minimumAmount Specifies the minimum amount of the product. /ProductDashboard/products/status Specifies the status of the availability of the products. /ProductDashboard/products/externalIndicator Specifies the external indicator of the product. /ProductDashboard/products/productDescription Specifies the description of the product. /ProductDashboard/products/prodDescription Specifes the details of the product description. /ProductDashboard/products/prodDescription/description Specifies the brief description about the product. /ProductDashboard/products/prodDescription/detailedDescription Specifies a detailed description about the product. /ProductDashboard/products/prodDescription/notes Specifies certain notes about the product. /ProductDashboard/products/prodDescription/termsConditions Specifies certain terms and conditions that are associated with thh product. /ProductDashboard/products/prodDescription/disclosure Specifies the disclosure details about the product. /ProductDashboard/products/prodDescription/extensionData Specifies the extension data that is associated with the product. /ProductDashboard/products/productFeatures Specifies the feature details of the product. /ProductDashboard/products/productFeatures/type Specifies the type of product feature. /ProductDashboard/products/productFeatures/description Specifies the description about the product feature. /ProductDashboard/products/productFeatures/featureName Specifies the name of the feature. /ProductDashboard/products/productFeatures/featureGroup Specifies the name of the group to which the feature belongs. /ProductDashboard/products/productFeatures/sequenceNo Specifies the sequence number of the product feature. /ProductDashboard/products/productFeatures/option Specifies the options that are provided by the feature. /ProductDashboard/products/productFeatures/optionDispType Specifies the display type of the option. /ProductDashboard/products/productFeatures/optionValues Specifies the various values that are associated with the option. /ProductDashboard/products/productFeatures/extensionData Specifies the extension data that is associated with the product. /ProductDashboard/products/ProductGroups/imageDetails Specifies the image details of the products that are present in a product group. /ProductDashboard/products/imageDetails/imageType Specifies the type of the image. /ProductDashboard/products/imageDetails/height Specifies the height of the image. /ProductDashboard/products/imageDetails/extensionData Specifies the extension data that is associated with the image. /ProductDashboard/products/extensionData Specifies the extension data that is associated with the products. View the Response Sample Code
{
"ProductDashboard":[
{
"ProductGroups":"[
{
"productGroupId":"SAVINGS.ACCOUNTS",
"productGroupDisplayName":"Savings Accounts",
"description":"",
"externalIndicator":"N",
"detailDescription":"",
"disclosure":"testing",
"imageDetails":[
{
"imageType":"BannerImage",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/savings_account.png",
"extensionData":
{
}
}
],"products":[
{
"productId":"INCOME.ACCOUNT",
"currencyId":"USD",
"minimumAmount":2000,"purposes":["Onboarding"],"productName":"Standard Saving Account",
"status":"Active",
"externalIndicator":"",
"productDescription":"",
"prodDescription":
{
"description":"Empowering with financial independence and simplified banking",
"detailedDescription":"The Standard Savings Account simplifies banking for the independent women of today. Benefits of the Women\\u2019s Savings Account include low opening deposit and attractive interest rate",
"notes":"",
"termsConditions":"test",
"disclosure":"testing",
"extensionData":
{
}
}
,"productFeatures":[
{
"type":"Cheque Book",
"description":"You can use a cheque to withdraw cash, pay for service, or transfer money to another account. You can write a cheque to yourself or a bearer for cash transactions or to a company or person, who can deposit it in their bank and receive the money in their account",
"featureName":"Yes, I like to order a cheque book",
"featureGroup":"",
"sequenceNo":3,"isMandatory":false,"defaultValue":"No",
"option":"",
"optionDispType":"CheckBox",
"optionValues":[],"extensionData":
{
}
}
],"imageDetails":[
{
"imageType":"Banner",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
"extensionData":
{
}
}
],"extensionData":
{
}
}
,
{
"productId":"STAFF.ACCOUNT",
"currencyId":"USD",
"minimumAmount":2500,"purposes":["Onboarding"],"productName":"Prime Saving Account",
"status":"Active",
"externalIndicator":"",
"productDescription":"",
"prodDescription":
{
"description":"Get the advantage of enhanced access and higher transaction limits",
"detailedDescription":"Prime Savings Account gives you an edge in the way you bank. Benefits of the Prime Savings Account include enhanced transaction limits and free checkbooks",
"notes":"",
"termsConditions":"test",
"disclosure":"testing",
"extensionData":
{
}
}
,"productFeatures":[
{
"type":"Debit Card",
"description":"Carry your bank account safely wherever you go with the Debit card. And Do a lot more with your Debit Card!!",
"featureName":"Yes, I like to avail to Debit Card",
"featureGroup":"",
"sequenceNo":1,"isMandatory":false,"defaultValue":"No",
"option":"",
"optionDispType":"CheckBox",
"optionValues":[],"extensionData":
{
}
}
],"imageDetails":[
{
"imageType":"Banner",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
"extensionData":
{
}
}
],"extensionData":
{
}
}
,
{
"productId":"SAVINGS.DEFAULT",
"currencyId":"USD",
"minimumAmount":150,"purposes":["Onboarding"],"productName":"Salary Saving Account",
"status":"Active",
"externalIndicator":"",
"productDescription":"",
"prodDescription":
{
"description":"Basic savings ideal for low balances and first-time savers",
"detailedDescription":"Savings Account is uniquely design for you to achieve your financial goals. We provide the optimum solution for you to manage your money efficiently",
"notes":"",
"termsConditions":"test",
"disclosure":"testing",
"extensionData":
{
}
}
,"productFeatures":[
{
"type":"eStatement",
"description":"When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName":"eStatement",
"featureGroup":"",
"sequenceNo":2,"isMandatory":false,"defaultValue":"No",
"option":"",
"optionDispType":"CheckBox",
"optionValues":[],"extensionData":
{
}
}
,
{
"type":"Debit Card",
"description":"Using Debit card is fast and easy. Access your funds 24\\/7 and make purchases at millions of locations worldwide",
"featureName":"Yes, I like to avail to Debit Card",
"featureGroup":"",
"sequenceNo":1,"isMandatory":false,"defaultValue":"No",
"option":"",
"optionDispType":"CheckBox",
"optionValues":[],"extensionData":
{
}
}
],"imageDetails":[
{
"imageType":"Banner",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
"extensionData":
{
}
}
],"extensionData":
{
}
}
],"extensionData":
{
}
}
,
{
"productGroupId":"CURRENT.ACCOUNTS",
"productGroupDisplayName":"Current Accounts",
"description":"",
"externalIndicator":"N",
"detailDescription":"",
"disclosure":"testing",
"imageDetails":[
{
"imageType":"BannerImage",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/current_account.png",
"extensionData":
{
}
}
],"products":[
{
"productId":"PREMIUM.ACCOUNT",
"currencyId":"USD",
"minimumAmount":25,"purposes":["Onboarding"],"productName":"Preferred Checking Account",
"status":"Active",
"externalIndicator":"N",
"productDescription":"",
"prodDescription":
{
"description":"Everyday Checking, Banking made easy",
"detailedDescription":"Best for the customers who want to earn interest, Higher account balances and customers who have a Mortgage",
"notes":"",
"termsConditions":"test",
"disclosure":"testing",
"extensionData":
{
}
}
,"productFeatures":[
{
"type":"Debit Card",
"description":"Using a Debit card is fast and easy. Access your funds 24\\/7 and make purchases at millions of locations worldwide",
"featureName":"Yes, I like to avail to Debit Card",
"featureGroup":"",
"sequenceNo":1,"isMandatory":false,"defaultValue":"No",
"option":"",
"optionDispType":"CheckBox",
"optionValues":[],"extensionData":
{
}
}
],"imageDetails":[
{
"imageType":"Banner",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
"extensionData":
{
}
}
],"extensionData":
{
}
}
,
{
"productId":"PREFER.ACCOUNT",
"currencyId":"USD",
"minimumAmount":25,"purposes":["Onboarding"],"productName":"Advanced Checking Account",
"status":"Active",
"externalIndicator":"N",
"productDescription":"",
"prodDescription":
{
"description":"Your checking account, Your way",
"detailedDescription":"Easily manage your everyday spending, whatever your needs, with one of our checking accounts. You\\u2019ll also be able to take advantage of all the rewards and benefits you get as our customer",
"notes":"",
"termsConditions":"",
"disclosure":"testing",
"extensionData":
{
}
}
,"productFeatures":[],"imageDetails":[
{
"imageType":"Banner",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
"extensionData":
{
}
}
],"extensionData":
{
}
}
,
{
"productId":"STUDENT.ACCOUNT",
"currencyId":"USD",
"minimumAmount":0,"purposes":["Onboarding"],"productName":"Basic Checking Account",
"status":"Active",
"externalIndicator":"N",
"productDescription":"",
"prodDescription":
{
"description":"A basic checking account with great standard features",
"detailedDescription":"The basic checking account that comes with standard benefits like a debit card that doubles as an ATM card. It also gives you full access to Online Banking, a suite of tools and apps that make it easy to track all your transaction and more",
"notes":"",
"termsConditions":"test",
"disclosure":"testing",
"extensionData":
{
}
}
,"productFeatures":[
{
"type":"Overdraft protection",
"description":"To avoid the inconvenience of declined transactions on your checking account by Overdraft Protection",
"featureName":"Overdraft protection",
"featureGroup":"",
"sequenceNo":4,"isMandatory":true,"defaultValue":"No",
"option":"",
"optionDispType":"SingleSelection",
"optionValues":[
{
"value":"OPT-IN",
"description":"I want the Bank to authorize and pay overdrafts on my transactions",
"extensionData":
{
}
}
,
{
"value":"OPT-OUT",
"description":"I DO NOT want the Bank to authorize and pay overdrafts on my transactions",
"extensionData":
{
}
}
],"extensionData":
{
}
}
],"imageDetails":[
{
"imageType":"Banner",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
"extensionData":
{
}
}
],"extensionData":
{
}
}
],"extensionData":
{
}
}
]"
}
],"opstatus":0,"httpStatusCode":200
}
|
||||
| Error Code(s): |
None |
||||
| Service Flow: |
|
getProductsFromProductGroup
| Description: | Retrieves the list of products that are part of a product group. The list is displayed on the frmProductGroup page. | ||||
| Method: | POST | ||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/ProductDashboard/getProductsFromProductGroup | ||||
| Security Level: | Authenticated App Users | ||||
| Header Request: |
X-Kony-Authorization |
||||
| Body Request: |
Parameters Purpose (Mandatory) Specifies the purpose that is fetched from the Spotlight app. ProductGroupID (Mandatory) Specifies the ID of the product group that must be fetched. {
"Purpose": "",
"ProductGroupID": "SAVINGS.ACCOUNTS"
}
|
||||
| Response: |
Parameters View the Response Parameters
/ProductDashboard Specifies the product dashboard details. /ProductDashboard/ProductGroups Specifies the product groups that are present in the dashboard. /ProductDashboard/ProductGroups/productGroupId Specifies the ID that is associated with the Product group. /ProductDashboard/ProductGroups/productGroupDisplayName Specifies the display name of the product group. /ProductDashboard/ProductGroups/description Specifies a brief description about the product group. /ProductDashboard/ProductGroups/externalIndicator Specifies the external indicator of the product group. /ProductDashboard/ProductGroups/detailDescription Specifies a detailed description about the product group. /ProductDashboard/ProductGroups/disclosure Specifies the disclosure details of the product group. /ProductDashboard/ProductGroups/imageDetails Specifies the various details of the images in the product group, such as image type, height, and extension data. /ProductDashboard/ProductGroups/imageDetails/imageType Specifies the type of the image. /ProductDashboard/ProductGroups/imageDetails/height Specifies the height of the image /ProductDashboard/ProductGroups/imageDetails/extensionData <Specifies the extension data that is associated with the image. /ProductDashboard/products Specifies various product details such as ID, currency ID, and so on. /ProductDashboard/products/productId Specifies the ID of the product. /ProductDashboard/products/currencyId Specifies the ID of the currency. /ProductDashboard/products/minimumAmount Specifies the minimum amount of the product. /ProductDashboard/products/status Specifies the status of the availability of the products. /ProductDashboard/products/externalIndicator Specifies the external indicator of the product. /ProductDashboard/products/productDescription Specifies the description of the product. /ProductDashboard/products/prodDescription Specifes the details of the product description. /ProductDashboard/products/prodDescription/description Specifies the brief description about the product. /ProductDashboard/products/prodDescription/detailedDescription Specifies a detailed description about the product. /ProductDashboard/products/prodDescription/notes Specifies certain notes about the product. /ProductDashboard/products/prodDescription/termsConditions Specifies certain terms and conditions that are associated with thh product. /ProductDashboard/products/prodDescription/disclosure Specifies the disclosure details about the product. /ProductDashboard/products/prodDescription/extensionData Specifies the extension data that is associated with the product. /ProductDashboard/products/productFeatures Specifies the feature details of the product. /ProductDashboard/products/productFeatures/type Specifies the type of product feature. /ProductDashboard/products/productFeatures/description Specifies the description about the product feature. /ProductDashboard/products/productFeatures/featureName Specifies the name of the feature. /ProductDashboard/products/productFeatures/featureGroup Specifies the name of the group to which the feature belongs. /ProductDashboard/products/productFeatures/sequenceNo Specifies the sequence number of the product feature. /ProductDashboard/products/productFeatures/option Specifies the options that are provided by the feature. /ProductDashboard/products/productFeatures/optionDispType Specifies the display type of the option. /ProductDashboard/products/productFeatures/optionValues Specifies the various values that are associated with the option. /ProductDashboard/products/productFeatures/extensionData Specifies the extension data that is associated with the product. /ProductDashboard/products/ProductGroups/imageDetails Specifies the image details of the products that are present in a product group. /ProductDashboard/products/imageDetails/imageType Specifies the type of the image. /ProductDashboard/products/imageDetails/height Specifies the height of the image. /ProductDashboard/products/imageDetails/extensionData Specifies the extension data that is associated with the image. /ProductDashboard/products/extensionData Specifies the extension data that is associated with the product. View the Response Sample Code
{
"ProductDashboard":[
{
"ProductGroups":"[
{
"productGroupId":"SAVINGS.ACCOUNTS",
"productGroupDisplayName":"Savings Accounts",
"description":"",
"externalIndicator":"N",
"detailDescription":"",
"disclosure":"testing",
"imageDetails":[
{
"imageType":"BannerImage",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/savings_account.png",
"extensionData":
{
}
}
],"products":[
{
"productId":"INCOME.ACCOUNT",
"currencyId":"USD",
"minimumAmount":2000,"purposes":["Onboarding"],"productName":"Standard Saving Account",
"status":"Active",
"externalIndicator":"",
"productDescription":"",
"prodDescription":
{
"description":"Empowering with financial independence and simplified banking",
"detailedDescription":"The Standard Savings Account simplifies banking for the independent women of today. Benefits of the Women\\u2019s Savings Account include low opening deposit and attractive interest rate",
"notes":"",
"termsConditions":"test",
"disclosure":"testing",
"extensionData":
{
}
}
,"productFeatures":[
{
"type":"Cheque Book",
"description":"You can use a cheque to withdraw cash, pay for service, or transfer money to another account. You can write a cheque to yourself or a bearer for cash transactions or to a company or person, who can deposit it in their bank and receive the money in their account",
"featureName":"Yes, I like to order a cheque book",
"featureGroup":"",
"sequenceNo":3,"isMandatory":false,"defaultValue":"No",
"option":"",
"optionDispType":"CheckBox",
"optionValues":[],"extensionData":
{
}
}
],"imageDetails":[
{
"imageType":"Banner",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
"extensionData":
{
}
}
],"extensionData":
{
}
}
,
{
"productId":"STAFF.ACCOUNT",
"currencyId":"USD",
"minimumAmount":2500,"purposes":["Onboarding"],"productName":"Prime Saving Account",
"status":"Active",
"externalIndicator":"",
"productDescription":"",
"prodDescription":
{
"description":"Get the advantage of enhanced access and higher transaction limits",
"detailedDescription":"Prime Savings Account gives you an edge in the way you bank. Benefits of the Prime Savings Account include enhanced transaction limits and free checkbooks",
"notes":"",
"termsConditions":"test",
"disclosure":"testing",
"extensionData":
{
}
}
,"productFeatures":[
{
"type":"Debit Card",
"description":"Carry your bank account safely wherever you go with the Debit card. And Do a lot more with your Debit Card!!",
"featureName":"Yes, I like to avail to Debit Card",
"featureGroup":"",
"sequenceNo":1,"isMandatory":false,"defaultValue":"No",
"option":"",
"optionDispType":"CheckBox",
"optionValues":[],"extensionData":
{
}
}
],"imageDetails":[
{
"imageType":"Banner",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
"extensionData":
{
}
}
],"extensionData":
{
}
}
,
{
"productId":"SAVINGS.DEFAULT",
"currencyId":"USD",
"minimumAmount":150,"purposes":["Onboarding"],"productName":"Salary Saving Account",
"status":"Active",
"externalIndicator":"",
"productDescription":"",
"prodDescription":
{
"description":"Basic savings ideal for low balances and first-time savers",
"detailedDescription":"Savings Account is uniquely design for you to achieve your financial goals. We provide the optimum solution for you to manage your money efficiently",
"notes":"",
"termsConditions":"test",
"disclosure":"testing",
"extensionData":
{
}
}
,"productFeatures":[
{
"type":"eStatement",
"description":"When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName":"eStatement",
"featureGroup":"",
"sequenceNo":2,"isMandatory":false,"defaultValue":"No",
"option":"",
"optionDispType":"CheckBox",
"optionValues":[],"extensionData":
{
}
}
,
{
"type":"Debit Card",
"description":"Using Debit card is fast and easy. Access your funds 24\\/7 and make purchases at millions of locations worldwide",
"featureName":"Yes, I like to avail to Debit Card",
"featureGroup":"",
"sequenceNo":1,"isMandatory":false,"defaultValue":"No",
"option":"",
"optionDispType":"CheckBox",
"optionValues":[],"extensionData":
{
}
}
],"imageDetails":[
{
"imageType":"Banner",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
"extensionData":
{
}
}
],"extensionData":
{
}
}
],"extensionData":
{
}
}
]",
"Products":"
{
productId=INCOME.ACCOUNT, currencyId=USD, minimumAmount=2000, purposes=["Onboarding"], productName=Standard Saving Account, status=Active, externalIndicator=, productDescription=, prodDescription=
{
description=Empowering with financial independence and simplified banking, detailedDescription=The Standard Savings Account simplifies banking for the independent women of today. Benefits of the Women’s Savings Account include low opening deposit and attractive interest rate, notes=, termsConditions=test, disclosure=testing, extensionData=
{
}
}
, productFeatures=[
{
"type":"Cheque Book",
"description":"You can use a cheque to withdraw cash, pay for service, or transfer money to another account. You can write a cheque to yourself or a bearer for cash transactions or to a company or person, who can deposit it in their bank and receive the money in their account",
"featureName":"Yes, I like to order a cheque book",
"featureGroup":"",
"sequenceNo":3,"isMandatory":false,"defaultValue":"No",
"option":"",
"optionDispType":"CheckBox",
"optionValues":[],"extensionData":
{
}
}
], imageDetails=[
{
"imageType":"Banner",
"height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
"extensionData":
{
}
}
], extensionData=
{
}
}
"
}
],"opstatus":0,"httpStatusCode":200
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
getProductDetails
| Description: | Retrieves the details of the product that is selected, when the Learn More (product group page) onClick action is triggered. The API populates the response on the frmProductDetails page. | ||||
| Method: | POST | ||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/ProductDashboard/getProductDetails | ||||
| Security Level: | Anonymous App Users | ||||
| Header Request: |
X-Kony-Authorization |
||||
| Body Request: |
Parameters ProductID (Mandatory) Specifies the ID of the product. Currency Specifies the currency. {
"ProductID": "INCOME.ACCOUNT",
"Currency": "USD"
}
|
||||
| Response: |
Parameters View the Response Parameters
/ProductDashboard Specifies the product dashboard details. /ProductDashboard/ProductID Specifies the ID of the product. /ProductDashboard/Currency Specifies the currency. /ProductDashboard/ProductName Specifies the name of the product. /ProductDashboard/ProductDescription Specifies a brief description about the product. /ProductDashboard/ImageDetails Specifies the details of the image. /ProductDashboard/ProductDetailedDescription Specifies a detailed description about the product. /ProductDashboard/ProductNotes Specifies certain notes about the product. /ProductDashboard/ProductTermsAndConditions Specifies the various terms and conditions about the product.
View the Response Sample Code
{
"ProductDashboard": [
{
"ProductID": "INCOME.ACCOUNT",
"Currency": "USD",
"ProductName": "Standard Saving Account",
"ProductDescription": "Empowering with financial independence and simplified banking",
"ImageDetails": "https://marketingcatalog.microservice.temenos.com/resources/images/deposit_threeyear_fd.png",
"ProductDetailedDescription": "The Standard Savings Account simplifies banking for the independent women of today. Benefits of the Women’s Savings Account include low opening deposit and attractive interest rate",
"ProductNotes": "",
"ProductTermsAndConditions": "test"
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
createFunding
| Description: | Creates a funding application (a separate JS module) in the Origination Data Microservice (ODMS). The data that is passed to the ODMS includes the parent application ID. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/Funding/createFunding | ||||||
| Security Level: | Authenticated App Users | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters Application_id (Mandatory) Specifies the entity definition key. StartDate (Mandatory) Specifies the date on which the funding starts. Party_id (Mandatory) Specifies the unique applicant ID that is associated with the Party Micro Service. CoAppParty_id (Mandatory) Specifies the unique co- applicant ID that is associated with the Party Micro Service. {
"Application_id": "ZBL55R5",
"StartDate": "2020-06-04",
"Party_id": "2015531146",
"CoAppParty_id": "2015531146"
}
|
||||||
| Response: |
Parameters View the Response Parameters
/Insights Specifies attributes of the application. /Insights/Endpoint Specifies the endpoint URL of the application. /Insights/AccessToken Specifies the access token of the application. /Insights/RequestUrl Specifies the request URL of the application. /Insights/StartTime Specifies the start time of the application. /Insights/Enabled Specifies whether the analytics is enabled or not. /Insights/AddressHash Specifies the hash address. /trackingCode Specifies the application ID for the Funding application.
View the Response Sample Code
{
"Insights": {
"Endpoint": "https://eventconsumer-dot-transact-ti-test.appspot.com/_ah/api",
"AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpbnNpZ2h0cy5hdm9rYS5jb20vRm9ybVJlcXVlc3QiOnsicmVxdWVzdEtleSI6bnVsbCwiY3VzdG9tZXJJZCI6IkF2b2thIiwidG1JbnN0YW5jZUlkIjoiNzhlZmRlZjhjYjFiYzI2MmZiYTE4ZTU2OTljNGJiYTIiLCJvcmdJZCI6NCwic3BhY2VJZCI6NywiZm9ybUlkIjozMCwiZm9ybVZlcnNpb25JZCI6NDMsImZvcm1UcmFuc2FjdGlvbklkIjoxNjg3OCwic2Vzc2lvbklkIjo1OTE5OSwiam9iSWQiOi0xLCJqb2JTdGVwSWQiOi0xLCJqb2JBY3Rpb25JZCI6LTF9LCJleHAiOjE1OTE0MzQ1MTMsImlhdCI6MTU5MTI2MTcxM30.4Uf5CY-tUCPFaIEDjRtXiOz6EtUvS7y-cDJatEgi95o",
"RequestUrl": "https%3A%2F%2Femea-infinity-dev.imf.avoka-transact.com%2Finfinity%2Fapp%2F%3Fnull",
"StartTime": "1591261713875",
"Enabled": "true",
"AddressHash": "e230258882005aba8a0f4b97e444b60b1d44e9d97fc1146febe1c6db45426081"
},
"opstatus": 0,
"trackingCode": "W4R9B2W",
"httpStatusCode": 200
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getProductsSelected
| Description: | Retrieves the product that is selected by the user based on the application ID. The product is retrieved from the customer application and the Party back-end system. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/Funding/getProductsSelected | ||||||
| Security Level: | Authenticated App Users | ||||||
| Header Request: |
X-Kony-Authorization |
||||||
| Body Request: |
Parameters Application_id (Mandatory) Specifies the entity definition key. {
"Application_id": "ZBL55R5"
}
|
||||||
| Response: |
Parameters View the Response Parameters
/productCatalogue Specifies the product catalog details. /productCatalogue/productFeatures Specifies the various features that are associated with a product present in the catalog. /productCatalogue/fees Specifies the fee details that are associated with the product catalog. /productCatalogue/fees/feeAmount Specifies the fee amount. /productCatalogue/productId Specifies the ID of the product. /productCatalogue/creditInterest Specifies the credit interest details such as interest rate and interest type. /productCatalogue/creditInterest/interestRate Specifies the interest rate. /productCatalogue/creditInterest/interestType Specifies the type of interest. /productCatalogue/imageDetails Specifie the image details that are associated with the product catalog. /productCatalogue/maximumAmount Specifies the maximum amount of the product. /productCatalogue/overdraftAmount Specifies the overdraft amount associated with the product. /productCatalogue/productName Specifies the name of the product. /productCatalogue/extensionData Specifies the extension data that is associated with the product. /productCatalogue/noticePeriod Specifies the notice period details for the product catalog. /productCatalogue/noticePeriod/weeks Specifies the number of weeks in the notice period. /productCatalogue/noticePeriod/months Specifies the number of months in the notice period. /productCatalogue/noticePeriod/days Specifies the number of days in the notice period. /productCatalogue/noticePeriod/years Specifies the number of years in the notice period. /productCatalogue/purposes Specifiees the purpose of the product that is present in the product catalog. /productCatalogue/minimumAmount Specifies the minimum amount. /productCatalogue/debitInterest Specifies the debit interest details such as interest rate and interest type. /productCatalogue/debitInterest/interestRate Specifies the interest rate. /productCatalogue/debitInterest/interestType Specifies the interest type. /productCatalogue/currencyId Specifies the ID of currency. /productCatalogue/productDescription Specifies a description about the product. /productCatalogue/status Specifies the status of the product catalog. View the Response Sample Code
{
"productCatalogue": [
{
"productFeatures": [],
"fees": {
"feeAmount": 5
},
"productId": "SAVINGS.DEFAULT",
"creditInterest": {
"interestRate": 0
},
"imageDetails": [],
"maximumAmount": 500,
"overdraftAmount": 50,
"productName": "Default (for failed eligibility)",
"extensionData": {},
"noticePeriod": {
"weeks": 2,
"months": 5,
"days": 10,
"years": 10
},
"purposes": [
"Onboarding"
],
"minimumAmount": 5,
"currencyId": "CAD",
"productDescription": "A variable interest rate account that earns competitive interest and has no minimum balance or monthly service charge after you open it.",
"status": "Active"
},
{
"productFeatures": [],
"fees": {
"feeAmount": 35
},
"productId": "PREMIUM.ACCOUNT",
"creditInterest": {
"interestRate": 0,
"interestType": "SINGLE"
},
"imageDetails": [],
"maximumAmount": 500,
"overdraftAmount": 50,
"productName": "Current Account (Premium)",
"extensionData": {},
"noticePeriod": {
"weeks": 2,
"months": 5,
"days": 10,
"years": 10
},
"purposes": [
"Onboarding"
],
"minimumAmount": 5,
"debitInterest": {
"interestRate": 0,
"interestType": "SINGLE"
},
"currencyId": "USD",
"productDescription": "Looking to earn more? Simply maintain a balance of $999 or more to earn a higher variable interest rate. You will still earn a competitive rate even if your balance falls below $999.",
"status": "Active"
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getFundingType
| Description: | Retrieves the funding type that is set by the user. Inter-Bank Funding and Intra-Bank Funding are the two types of funding that are used in the Funding module (Intra/Inter). | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/Funding/getFundingType | ||||||
| Security Level: | Authenticated App Users | ||||||
| Header Request: |
X-Kony-Authorization |
||||||
| Body Request: |
Parameters Application_id (Mandatory) Specifies the entity definition key. {
"Application_id": "W2HHB2T"
}
|
||||||
| Response: |
Parameters /FundingType Specifies the type of funding. //Success Response
{
"FundingType": "Inter",
"opstatus":0,
"httpStatusCode":0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Get funding type failed"
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getFundingProducts
| Description: | Retrieves the products that are selected by the user for funding. This API is used to re-populate the data while the user navigates back to the client app. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/Funding/getFundingProducts | ||||||
| Security Level: | Authenticated App Users | ||||||
| Header Request: |
X-Kony-Authorization |
||||||
| Body Request: |
Parameters Application_id (Mandatory) Specifies the entity definition key. {
"Application_id": "W2HHB2T"
}
|
||||||
| Response: |
Parameters /FundingProducts Specifies an array of details of the funding product in a JSON object. /FundingProduct/FundingProductId Specifies the ID of the funding product. /FundingProduct/FundingCurrency Specifies the currency used in funding. /FundingProduct/FundingAmount Specifies the amount of the funding. /FundingProduct/DebitIBAN Specifies the International Bank Account Number of the debtor. /FundingProduct/DebitAccount Specifies the debit account number. /FundingProduct/DebitRoutingNumber Specifies the routing number for the debit account. /FundingProduct/DebitCurrency Specifies the currency of the debit account. /FundingProduct/DebitAccountType Specifies the type of the debit account. /FundingProduct/BankName Specifies the name of the bank. /FundingProduct/PaymentReference Specifies the reference code generated for the payment. //Success Response
{
"FundingProducts": [
{
"FundingProductId": "",
"FundingCDPlanId": "",
"FundingCurrency": "",
"FundingAmount": "",
"DebitAccount": "",
"DebitCurrency": "",
"DebitIBAN": "",
"DebitRoutingNumber": "",
"DebitAccountType": "",
"BankName": "",
"PaymentReference": ""
}
],
"opstatus": 0,
"httpStatusCode": 0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Funding update failed"
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
GetProductsForPurpose
| Description: | Retrieves the list of products from the Marketing Catalog microservice based on the specified purpose. For example, the Deposit product group contains various products such as Long Term Deposits, 3 year Deposits, and so on. If the user sets the purpose as Onboarding then all the products that are associated with Infinity Origination are fetched. | ||||
| Method: | POST | ||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/ProductSelection/getProductsForPurpose | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: | None | ||||
| Body Request: |
Parameters Purpose (Mandatory) Specifies the purpose for which the list of products is fetched. {
"Purpose":"Onboarding"
}
|
||||
| Response: |
View the Response Parameters
productCatalogue Specifies the details of the product catalog. productCatalogue/externalIndicator Specifies the indicator for the product catalog. productCatalogue/productLineDisplayName Specifies the name of the product line. productCatalogue/productGroups Specifies the various product groups and their details. productCatalogue/productGroups/externalIndicator Specifies the indicator for the product groups. productCatalogue/productGroups/detailDescription Specifies the descriptions for the product details. productCatalogue/productGroups/disclosure Specifies the disclosure details of the product group. productCatalogue/productGroups/imageDetails Specifies the image details of the products. productCatalogue/productGroups/imageDetails/imageUrl Specifies the URL that is associated with the image. productCatalogue/productGroups/imageDetails/width Specifies the width of the image. productCatalogue/productGroups/imageDetails/imageType Specifies the type of the image. productCatalogue/productGroups/imageDetails/extensionData Specifies the extension data that is associated with the image. productCatalogue/productGroups/imageDetails/height Specifies the height of the image. productCatalogue/productGroups/productGroupId Specifies the ID of the product group to which the products belong. productCatalogue/productGroups/description Specifies the description of the product group. productCatalogue/productGroups/productGroupDisplayName Specifies the name of the product group. productCatalogue/productGroups/extensionData Specifies the extension data that is associated with the product group. productCatalogue/productGroups/products Specifies the list of products, with their details, that is present in a product group. productCatalogue/productGroups/products/externalIndicator Specifies the indicator for the product. productCatalogue/productGroups/products/prodDescription Specifies the product description details such as disclosure, notes, terms and conditions and so on. productCatalogue/productGroups/products/prodDescription/disclosure Specifies the disclosure details of the product. productCatalogue/productGroups/products/prodDescription/detailedDescription Specifies the detailed description of the product. productCatalogue/productGroups/products/prodDescription/notes Specifies the notes about the product. productCatalogue/productGroups/products/prodDescription/termsConditions Specifies the terms and conditions for the product. productCatalogue/productGroups/products/prodDescription/description Specifies a brief description about the product. productCatalogue/productGroups/products/prodDescription/extensionData Specifies the extension data that is associated with the product description. productCatalogue/productGroups/products/productFeatures Specifies the various features of the products. productCatalogue/productGroups/products/productFeatures/sequenceNo Specifies the sequence number for the preduct feature. productCatalogue/productGroups/products/productFeatures/featureName Specifies the name of the feature. productCatalogue/productGroups/products/productFeatures/featureGroup Specifies the group to which the feature belongs. productCatalogue/productGroups/products/productFeatures/defaultValue Specifies the default value for the feature. productCatalogue/productGroups/products/productFeatures/optionDispType Specifies the display type for the option. productCatalogue/productGroups/products/productFeatures/description Specifies the description to the feature. productCatalogue/productGroups/products/productFeatures/type Specifies the type of the feature. productCatalogue/productGroups/products/productFeatures/isMandatory Specifies whether the feature is mandatory. productCatalogue/productGroups/products/productFeatures/extensionData Specifies the extension data that is associated with the feature. productCatalogue/productGroups/products/productFeatures/option Specifies the option that is provided by the feature. productCatalogue/productGroups/products/productFeatures/optionValues Specifies the option value details. productCatalogue/productGroups/products/productId Specifies the ID of the product. productCatalogue/productGroups/products/purposes Specifies the purpose for which the product must be fetched. productCatalogue/productGroups/products/imageDetails Specifies the image details of the products. productCatalogue/productGroups/products/maximumAmount Specifies the maximum amount for the product. productCatalogue/productGroups/products/productName Specifies the name of the product. productCatalogue/productGroups/products/extensionData Specifies the extension data for the product. productCatalogue/productGroups/products/minimumAmount Specifies the minimum amount for the product. productCatalogue/productGroups/products/currencyId Specifies the ID that is associated with a currency. productCatalogue/productGroups/products/productDescription Specifies the description of the products. productCatalogue/productGroups/products/status Specifies the status for the products. productCatalogue/extensionData Specifies the extension data that is associated with the product catalog. productCatalogue/productLineId Specifies the ID that is associated with the product line. View the Response Sample Code
{
"productCatalogue": [
{
"externalIndicator": "N",
"productLineDisplayName": "Accounts",
"productGroups": [
{
"externalIndicator": "N",
"detailDescription": "",
"disclosure": "testing",
"imageDetails": [
{
"imageUrl": "product_image.png",
"width": 120,
"imageType": "Content",
"extensionData": {},
"height": 720
},
{
"imageUrl": "landingpg2.png",
"width": 120,
"imageType": "Banner",
"extensionData": {},
"height": 720
},
{
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/savings_account.png",
"width": 120,
"imageType": "BannerImage",
"extensionData": {},
"height": 720
},
{
"imageUrl": "savings_accounts.png",
"width": 120,
"imageType": "Icon",
"extensionData": {},
"height": 720
}
],
"productGroupId": "SAVINGS.ACCOUNTS",
"description": "",
"productGroupDisplayName": "Savings Accounts",
"extensionData": {},
"products": [
{
"externalIndicator": "",
"prodDescription": {
"disclosure": "For more account information and terms and conditions governing our deposit accounts, see applicable Business Product Guide, Business Accounts & Services Disclosure and Agreement and applicable Business Deposit Fee Schedule.",
"detailedDescription": "Savings Account is uniquely design for you to achieve your financial goals. We provide the optimum solution for you to manage your money efficiently",
"notes": "Monthly maintenance Fee is $10,Minimum opening deposit is $150,No Fee for ATM withdraw,Easy access to online and mobile banking,eStatements",
"termsConditions": "1 To qualify for an INFINITY Premier relationship, you need to open an INFINITY Premier checking account and maintain balances of $75,000 in combined U.S. Dollar personal deposit accounts and investment* balances OR recurring direct deposits totaling at least $5,000 from a third party to an INFINITY Premier checking account(s) per calendar month OR an INFINITY U.S. residential mortgage loan with an original loan amount of at least $500,000. Business owners may use their qualifying INFINITY U.S. Dollar commercial balances to qualify for a personal Premier relationship. A monthly maintenance fee of $50 will be incurred if one of these requirements is not maintained.<br>2 Qualifying direct deposits are electronic deposits of regular periodic payments (such as salary, pension, Government Benefits or other monthly income) made into your INFINITY checking account from third parties at least once per calendar month.<br>3 To qualify for an INFINITY Advance relationship, you need to open an INFINITY Advance checking account and maintain balances of $5,000 in combined U.S. consumer and qualifying commercial U.S. Dollar deposit and investment* accounts OR a monthly recurring direct deposit from a third party to an INFINITY Advance checking account OR an INFINITY U.S. residential mortgage loan. Home Equity products are not included. A monthly maintenance fee of $25 will be incurred if one of these requirements is not maintained.<br>4 To qualify for an INFINITY Choice Checking relationship, you need to open an INFINITYChoice Checking account and maintain combined balances in U.S. Dollar personal deposit accounts and investment* balances of at least $1,500 OR maintain a recurring direct deposit from a third party to an INFINITY Choice Checking account at least once per calendar month. A monthly maintenance fee of $15 will be incurred if minimum balance or recurring direct deposit requirement is not met.<br>5 Basic Banking has no minimum balance requirement and the monthly maintenance fee is $1. There is no charge for the first eight checks/withdrawal slips you write, then you will be charged $ .35 per check or withdrawal.<br>6 Available only on U.S. non-INFINITY ATM transactions initiated from INFINITYPremier checking, Premier Asset Management, INFINITY Premier Savings, and INFINITY Promotional Premier Savings account. INFINITY will rebate qualifying non-INFINITY ATM third-party surcharge fees incurred with a credit to your account on the first business day of the following calendar month",
"description": "Basic savings ideal for low balances and first-time savers",
"extensionData": {}
},
"productFeatures": [
{
"sequenceNo": 2,
"featureName": "eStatement",
"featureGroup": "",
"defaultValue": "No",
"optionDispType": "CheckBox",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"type": "eStatement",
"isMandatory": false,
"extensionData": {},
"option": "",
"optionValues": []
},
{
"sequenceNo": 1,
"featureName": "Yes, I like to avail to Debit Card",
"featureGroup": "",
"defaultValue": "No",
"optionDispType": "CheckBox",
"description": "Using Debit card is fast and easy. Access your funds 24/7 and make purchases at millions of locations worldwide",
"type": "Debit Card",
"isMandatory": false,
"extensionData": {},
"option": "",
"optionValues": []
}
],
"productId": "SAVINGS.DEFAULT",
"purposes": [
"Onboarding"
],
"imageDetails": [
{
"imageUrl": "banner.png",
"width": 120,
"imageType": "Banner",
"extensionData": {},
"height": 720
},
{
"imageUrl": "landingpage_3_img2.png",
"width": 120,
"imageType": "Content",
"extensionData": {},
"height": 720
},
{
"imageUrl": "menu_pay_a_person.png",
"width": 120,
"imageType": "Icon",
"extensionData": {},
"height": 720
}
],
"minimumAmount": 150,
"currencyId": "USD",
"productName": "Salary Saving Account",
"productDescription": "",
"extensionData": {},
"status": "Active"
}
]
}
],
"extensionData": {},
"productLineId": "ACCOUNTS"
}
],
"opstatus": 0,
"httpStatusCode": 200
} "httpStatusCode": 200
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
getFeaturesForProduct
| Description: | Retrieves the features that are specific to a product based on the product reference. For example, features such as CARD.ISSUE and E-Statement are fetched for Prime Saving Account product based on the SAVINGS.PRIME.INFINITY reference that is provided by the user | ||||
| Method: | POST | ||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/ProductSelection/getFeaturesForProducts | ||||
| Security Level: | Anonymous App User | ||||
| Header Request: | None | ||||
| Body Request: |
Parameters Purpose (Mandatory) Specifies the product IDs for which the list of features must be fetched. {
"ProductIDs":"STUDENT.ACCOUNT"
}
|
||||
| Response: |
View the Response Parameters
features Specifies the details of various features. features/sequenceNo Specifies sequence number for the feature. features/productId Specifies the ID of the product that is part of the feature. features/featureName Specifies the name of the feature. features/featureGroup Specifies the group to which the feature belongs. features/defaultValue Specifies the default value for the feature. features/optionDispType Specifies display type for the options that the feature provides. features/description Specifies the description of the feature features/type Specifies the type of the feature. features/isMandatory Specifies whether the feature is mandatory or not. features/extensionData Specifies the extension data for the feature. features/option Specifies the option that is provided by the feature. features/featureGroup Specifies the name of the group to which the feature belongs. features/optionValues Specifies the values for the options that are provided by the feature. features/optionValues/description Specifies the description for the option value. features/optionValues/value Specifies the value. features/optionValues/extensionData Specifies the indicator for the product catalog. View the Response Sample Code
{
"features": [
{
"sequenceNo": 4,
"productId": "STUDENT.ACCOUNT",
"featureName": "Overdraft protection",
"featureGroup": "",
"defaultValue": "No",
"optionDispType": "SingleSelection",
"description": "To avoid the inconvenience of declined transactions on your checking account by Overdraft Protection",
"type": "Overdraft protection",
"isMandatory": true,
"extensionData": {},
"option": "",
"optionValues": [
{
"description": "I DO NOT want the Bank to authorize and pay overdrafts on my transactions",
"value": "OPT-OUT",
"extensionData": {}
},
{
"description": "I want the Bank to authorize and pay overdrafts on my transactions",
"value": "OPT-IN",
"extensionData": {}
}
]
}
],
"code": "",
"opstatus": 0,
"message": "",
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
createProspectProfile
| Description: | Whenever the user submits the details during the process of application creation, the createProspectProfile API creates a prospect in the DBX DB (Backend database) with the details. The API is also connected to the Origination Data Microservice (ODMS) Business Delegates that update the XML applicant data in the ODMS. | |||||||||
| Method: | POST | |||||||||
| URL: | <BASE URI>/services/data/v1/OnBoarding/objects/PersonalInfo/createProspectProfile | |||||||||
| Security Level: | Authenticated App User | |||||||||
| Header Request: |
|
|||||||||
| Body Request: |
Parameters FormCode Specifies the code of the form (screen) Application_id Specifies the entity definition key. FirstName Specifies the first name of the user. LastName Specifies the last name of the user. DateOfBirth Specifies the date of birth of the user. Specifies the email ID of the user. MobileCountryCode Specifies the mobile country code based on the user's country. MobileNumber Specifies the mobile number of the user. BranchReference Specifies the reference number for the branch. ApplicantType Specifies the type of applicant such as general applicant or co-applicant. SectionProgress Specifies the progress for the process
{
"FormCode":"onboarding",
"Application_id": "4KPRBBH",
"FirstName": "DeekshithReddy",
"LastName": "Sama",
"DateOfBirth": "2000-01-10",
"Email": "deekshithreddy@temenos.com",
"MobileCountryCode": "+91",
"MobileNumber": "8754682294",
"BranchReference": "GB0010001",
"ApplicantType": "Applicant",
"SectionProgress": "Done"
}
|
|||||||||
| Response: |
Parameters /Party_Id Specifies the unique ID of the Party Microservice that is generated for the applicant. //Success Response
{
"Party_id": "2032314570",
"opstatus":0,
"httpStatusCode":0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Personal Info update failed"
}
|
|||||||||
| Error Code(s): |
|
|||||||||
| Service Flow: |
|
updateProspectProfile
| Description: | Whenever the user submits the details during the process of application creation, the udpateProspectProfile API updates the DBX DB (Backend database) with these details. The API is also connected to Origination Data Microservice (ODMS) Business Delegates that updates the XML applicant data in the ODMS. | |||||||||
| Method: | POST | |||||||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/PersonalInfo/updateProspectProfile | |||||||||
| Security Level: | Authenticated App User | |||||||||
| Header Request: |
|
|||||||||
| Body Request: |
Parameters FirstName Specifies the first name of the applicant. LastName Specifies the last name of the applicant. DateOfBirth Specifies the date of birth of the applicant. Specifies the email ID of the applicant. MobileCountryCode Specifies the mobile country code of the applicant. MobileNumber Specifies the mobile number of the applicant. CIF Specifies the Customer Information File of the applicant. ApplicantType Specifies the type of applicant, such as general applicant or co-applicant. Application_id (Mandatory) Specifies the entity definition key. IsExistentMember Specifies whether the applicant is an existing member. currentSectionProgressStatus Specifies the progress status of the application. Party_id (Mandatory) Specifies the unique ID of the Party Microservice that is generated for the applicant. {
"FirstName": "John",
"LastName": "Bailey",
"DateOfBirth": "1985-05-05",
"Email": "dbxuser@infinity.com",
"MobileCountryCode": "+91",
"MobileNumber": "1234567890",
"CIF": "190556",
"ApplicantType": "Applicant",
"Application_id": "6HLJNHT",
"IsExistentMember": true,
"currentSectionProgressStatus": "Done",
"Party_id": "2018143992"
}
|
|||||||||
| Response: | {
"opstatus":0,
"httpStatusCode":0
}
|
|||||||||
| Error Code(s): |
|
|||||||||
| Service Flow: |
|
updateLastEditedSection
| Description: | Updates the last edited section in the Data microservice. The API updates the section every time the screen loads. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/Application/updateLastEditedSection | ||||||
| Security Level: | Anonymous App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters LastUpdatedSection (Mandatory) Specifies the section where the update must be made. ApplicationId (Mandatory) Specifies the entity definition key. {
"LastUpdatedSection":"IdentityModule|frmIdentityDetails",
"Application_id":"LPS9FW9"
}
|
||||||
| Response: | {
"opstatus":0,
"httpStatusCode":0
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
updateApplicationStatus
| Description: | Updates the decision of the application on whether to approve or deny the application from the workspace. | |||||
| Method: | POST | |||||
| URL: | {BASE URI}/services/data/v1/TaskManagementServices/operations/Application/updateApplicationStatus | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters Application_id Specifies the entity definition key. Status Specifies the status of the application. {
"Application_id": "ABC1234",
"Status": "Approved"
}
|
|||||
| Response: | {
"status": "Success",
"message": "Updated application status successfully."
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
getAllCDPlansForProduct
| Description: | Retrieves all the Certificate of Deposit plans that are associated with a product. The Certificate of Deposit plans are generated based on the amount range and time period. | |||||
| Method: | POST | |||||
| URL: | {baseUrl}/services/data/v1/OnBoarding/operations/ProductSelection/getAllCDPlansForProduct/ | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters IndexKey Specifies the Index key. Currency Specifies the currency code used in the application. EffectiveDate Specifies the effective date. ProductId Specifies the unique ID of the product. BranchRef Specifies the branch reference number. {
"IndexKey": "05",
"Currency": "USD",
"EffectiveDate": "2020-08-26",
"ProductId": "HOME.EQUITY.LOAN",
"BranchRef": "GB0010001"
}
|
|||||
| Response: |
Parameters /periodicInterests Specifies an array of periodic interests of the product in a JSON object. /periodicInterests/periodicIntId Specifies the unique ID for the periodic interest. /periodicInterests/period Specifies the duration of period. /periodicInterests/indexKey Specifies the Index key. /periodicInterests/currency Specifies the currency code used in the application. /periodicInterests/effectiveDate Specifies the effective date. /periodicInterests/branchRef Specifies the branch reference number. /periodicInterests/periodicRates Specifies the periodic rate. /periodicInterests/periodicRates/minAmount Specifies the minimum amount for the periodic rate. /periodicInterests/periodicRates/maxAmount Specifies the maximum amount for the periodic rate. /periodicInterests/periodicRates/bidRate Specifies the bid rate. /periodicInterests/periodicRates/offerRate Specifies the offer rate. /periodicInterests/periodicRates/apr Specifies the Annual Percentage Rate. /periodicInterests/extensionData Specifies the extension data. {
"periodicInterests": [
{
"periodicIntId": "PI20238SQHMC",
"period": "6M",
"indexKey": "05",
"currency": "USD",
"effectiveDate": "2019-02-09",
"branchRef": "GB0010001",
"periodicRates": [
{
"minAmount": 10000,
"maxAmount": "90000",
"bidRate": 0.052,
"offerRate": 0.072,
"apr": 0.53
},
{
"minAmount": 90001,
"maxAmount": "100000",
"bidRate": 0.052,
"offerRate": 0.072,
"apr": 0.53
},
{
"minAmount": 100001,
"maxAmount": "110000",
"bidRate": 0.052,
"offerRate": 0.072,
"apr": 0.53
}
],
"extensionData": {}
}
]
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
verifyStaticSelfie
| Description: | Verifies the static selfie (Near selfie) with the photo of the client in the document. This API leverages a third party vendor called AuthenticID. | |||||
| Method: | POST | |||||
| URL: | {baseURL}/services/data/v1/ScanDocumentObjectServices/operations/StaticSelfie/verifyStaticSelfie | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters /accountCode (Mandatory) Specifies the unique code associated with the account. /nearSelfieImage64 (Mandatory) Specifies the base 64 image code of the static selfie. /transactionId (Mandatory) Specifies the unique ID of the transaction. {
"accountCode":"9999",
"nearSelfieImage64":"xxxx",
"transactionId":"xxxx"
}
|
|||||
| Response: |
Parameters /verifyStatus Specifies the status of the verification process. /executionStatus Specifies the status of the execution process. /ActionCode Specifies the unique action code for the verification. /ActionMessage Specifies the message associated with the action. /transactionId Specifies the unique ID of the transaction. /staticSelfieData Specifies the data associated with the static selfie. /staticSelfieData/VerificationScore Specifies the verification score for the static selfie. /staticSelfieData/DQL_Selfie1_Score_Result Specifies the selfie score result. {
"verifyStatus":"Verified",
"executionStatus":"xxxx",
"ActionCode":"99",
"ActionMessage":"Success",
"transactionId":"xxxx",
"staticSelfieData":{
"VerificationScore":"xxxx",
"DQL_Selfie1_Score_Result":"Passed"
},
"errorCode":"",
"errorMessage":""
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
LivelinessSelfie
| Description: | Verifies the liveliness selfie (Far selfie) with the photo of the client in the document. This API leverages a third party vendor called AuthenticID. | |||||
| Method: | POST | |||||
| URL: | {baseURL}/services/data/v1/ScanDocumentObjectServices/operations/LivelinessSelfie/verifyLivelinessSelfie | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters /accountCode (Mandatory) Specifies the unique code associated with the account. /farSelfieImage64 (Mandatory) Specifies the base 64 image code of the static selfie. /transactionId (Mandatory) Specifies the unique ID of the transaction. {
"accountCode":"9999",
"farSelfieImage64":"xxxx",
"transactionId":"xxxx"
}
|
|||||
| Response: |
Parameters /verifyStatus Specifies the status of the verification process. /executionStatus Specifies the status of the execution process. /ActionCode Specifies the unique action code for the verification. /ActionMessage Specifies the message associated with the action. /transactionId Specifies the unique ID of the transaction. /livelinessSelfieData Specifies the data associated with the static selfie. /livelinessSelfieData/VerificationScore Specifies the verification score for the static selfie. /livelinessSelfieData/DQL_Selfie1Liveness_Result Specifies the selfie liveliness result. /livelinessSelfieData/DQL_FarSelfie_Liveness_Result Specifies the far selfie liveliness result. {
"verifyStatus":"Verified",
"executionStatus":"xxxx",
"ActionCode":"99",
"ActionMessage":"Success",
"transactionId":"xxxx",
"livelinessSelfieData":{
"VerificationScore":"xxxx",
"DQL_Selfie1Liveness_Result":"Passed",
"DQL_FarSelfie_Liveness_Result":"Passed"
},
"errorCode":"",
"errorMessage":""
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
updateSelfieScoreAndResult
| Description: | Updates the selfie score and result fetched from the Authentic ID to the Origination Data Microservice (ODMS). | |||||
| Method: | POST | |||||
| URL: | {baseURL}/services/data/v1/ScanDocumentObjectServices/operations/LivelinessSelfie/updateSelfieScoreAndResult | |||||
| Security Level: | Anonymous App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters /SelfieScore Specifies the score of the selfie. /SelfieResult Specifies the result of the selfie (passed/failed) /LivenessSelfieScore Specifies the liveliness score of the selfie. /LivenessSelfieResult Specifies the result of the liveliness selfie. /FarSelfieResult Specifies the result of the far selfie. /SectionProgress Specifies the progress of the process. /ApplicantType Specifies the type of applicant (Applicant/Co-Applicant) {
"SelfieScore":"99.357",
"SelfieResult":"Passed",
"LivenessSelfieScore":"99.768",
"LivenessSelfieResult":"Passed",
"FarSelfieResult":"Passed",
"SectionProgress":"Done",
"ApplicantType":"Applicant"
}
|
|||||
| Response: | {
"opStatus":0,
"httpStatusCode":200
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
updateFundingData
| Description: | Updates the funding data to the Origination Data Microservice (ODMS). | ||||||
| Method: | PUT | ||||||
| URL: | <BASE URI>/services/data/v1/OnBoarding/operations/Funding/updateFundingData | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters /Application_id Specifies the entity definition key. /Payload Specifies the payload JSON object. /Payload/FundingType Specifies the type of funding (Inter/Intra) /Payload/FundingStatus Specifies the status of funding. /Payload/FundingProduct Specifies an array of funding products and their corresponding details. /Payload/FundingProduct/FundingProductId Specifies the unique ID of the funding product. /Payload/FundingProduct/FundingCurrency Specifies the currency of the funding. /Payload/FundingProduct/FundingAmount Specifies the amount involved in the funding {
"Application_id": "W2HHB2T",
"Payload": {
"FundingType": "Inter",
"FundingStatus": "OptedOut",
"FundingProduct": [
{
"FundingProductId": "12547",
"FundingCurrency": "USD",
"FundingAmount": "10000"
}
]
},
"MetaData": {
"SectionProgress": "InProgress"
}
}
|
||||||
| Response: | //Success Response
{
"opstatus":0,
"httpStatusCode":0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Funding update failed"
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
createInfinityProspect
| Description: | Creates a new Infinity prospect in the DBX DB. | |||||
| Method: | POST | |||||
| URL: | {URL}/services/data/v1/RBObjects/operations/InfinityUser/createInfinityProspect | |||||
| Security Level: | Anonymous App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters firstName (Mandatory) Specifies the first name of the user. lastName (Mandatory) Specifies the last name of the user. dateOfBirth (Mandatory) Specifies the date of birth of the user. email (Mandatory) Specifies the email ID of the user. phoneNumber (Mandatory) Specifies the phone number of the user. {
"firstName": "test",
"lastName": "test",
"dateOfBirth": "12-04-1995",
"email": "test@test.com",
"phoneNumber": "+91-1234567890"
}
|
|||||
| Response: |
Parameters UserName Specifies the unique ID of the user. id Specifies the unique ID of the user. {
"UserName":"xxxx",
"id":"xxxx"
}
|
|||||
| Error Code(s): |
Error Code: 10216 |
|||||
| Service Flow: |
|
createInfinityProspectAndLogin
| Description: | Creates a new Infinity prospect in the DBX Database and performs a silent login for the applicant. | |||||
| Method: | POST | |||||
| URL: | {URL}/services/data/v1/OnBoarding/operations/InfinityProspectAuth/createInfinityProspectAndLogin | |||||
| Security Level: | Anonymous App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters firstName (Mandatory) Specifies the first name of the user. lastName (Mandatory) Specifies the last name of the user. dateOfBirth (Mandatory) Specifies the date of birth of the user. email (Mandatory) Specifies the email ID of the user. phoneNumber (Mandatory) Specifies the phone number of the user. {
"firstName": "test",
"lastName": "test",
"dateOfBirth": "12-04-1995",
"email": "test@test.com",
"phoneNumber": "+91-1234567890"
}
|
|||||
| Response: |
Parameters dbxuserlogin Specifies the DBX user login that is required ti perform a silent login. session_token Specifies the session token that is required to perform a silent login. UserName Specifies the username. {
"dbxuserlogin":"xxxxx",
"session_token":"xxxx",
"UserName":"xxxx"
}
|
|||||
| Error Code(s): |
Error Code: 10216 |
|||||
| Service Flow: |
|
createRetailContract
| Description: | Creates a new retail contract. | |||||||||||||||||||||||||||||||||||
| Method: | POST | |||||||||||||||||||||||||||||||||||
| URL: | {{URL}}/services/data/v1/RBObjects/operations/InfinityUser/createRetailContract | |||||||||||||||||||||||||||||||||||
| Security Level: | Authenticated App User | |||||||||||||||||||||||||||||||||||
| Header Request: |
|
|||||||||||||||||||||||||||||||||||
| Body Request: |
Parameters customerId (Mandatory) Specifies the unique ID of the customer. accounts (Mandatory) Specifies an array of accounts and their corresponding details in a JSON object. {
"customerId":"1860393891",
"accounts":"[{\"accountName\":\"Rewards Savings\",\"accountId\":\"190128241502\",\"isEnabled\":\"true\",\"typeId\":\"2\",\"ownerType\":\"Owner\"},{\"accountName\":\"Core Checking\",\"accountId\":\"1908223242830\",\"isEnabled\":\"true\",\"typeId\":\"2\",\"ownerType\":\"Owner\"}]"
}
|
|||||||||||||||||||||||||||||||||||
| Response: |
Parameters id Specifies the unique ID of the contract. {
"id": "1860393891",
"opstatus": 0,
"httpStatusCode": 0
}
|
|||||||||||||||||||||||||||||||||||
| Error Code(s): |
|
|||||||||||||||||||||||||||||||||||
| Service Flow: |
|
getMFAScenario
| 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/MessagingObjectService/operations/OTP/getMFAScenario | |||||
| 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":"RESUME_AUTHENTICATION"
}
|
|||||
| Response: |
Parameters serviceKey Specifies the retrieved Multi-Factor Authentication service key value. {
"opstatus":0,
"serviceKey":"1d090929-907e-407c-bb04-f03018ae3380",
"httpStatusCode":0
}
|
|||||
| Error Code(s): |
Error Code: 74107 |
|||||
| Service Flow: |
|
getApplicationDetails
| Description: | Retrieves the application details stored in the Origination Data Microservice (ODMS) based on the application ID. | ||||
| Method: | GET | ||||
| URL: | {BASE URI}/services/data/v1/TaskManagementServices/operations/Application/getApplicationDetails | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters ApplicationId (Mandatory) Specifies the entity definition key. The applicationID value must be provided in the URL. {
"applicationId": "QNB8P9Q"(Mandatory)
}
|
||||
| Response: | {
"opstatus": 0,
"applicationDetails": {
"UserAction": {
"UserActions": [
{
"UserActionName": "AccountUsage",
"UserActionStatus": "Created",
"PartyId": "2009521090",
"ActionMetaData": [
{
"Response": "",
"Suggestions": [],
"Description": "If you plan to use this account for any international transfer, receiving or sending funds, please enter the total transfer amount expected on the next 12 months. If not, just answer 'No'.",
"FieldIdentifier": "internationalTransferResponse",
"DataType": "Text",
"ObjectAttribute": "",
"ObjectName": ""
}
],
"UserActionIdentifier": "AccountUsage_All_2009521090",
"SignalName": "",
"ProductId": "All"
}
]
},
"Funding": {},
"Applicants": [
{
"PersonalInfo": {
"DateOfBirth": "1985-05-05",
"MobileNumber": "9962817161",
"Email": "golconda.srujana@temenos.com",
"FirstName": "John",
"MobileCountryCode": "+91",
"Title": "",
"LastName": "Bailey",
"MiddleName": ""
},
"KYCInfo": {
"VendorID": "3246823604",
"questions": "",
"Decision": "Under Review",
"Field4": "",
"Field5": "No",
"Field2": "result.no.match",
"ProgressStatus": "",
"Field3": "",
"Field8": {
"result": "result.no.match",
"summary": "id.failure",
"idnotescore": "",
"idliveq-error": {
"message": "Not Eligible For Questions",
"key": "id.not.eligible.for.questions"
},
"opstatus": "0",
"qualifiers": [],
"error": "",
"idNumber": "3246823604",
"httpStatusCode": "200"
},
"Field9": "",
"Field6": "",
"Field7": "0",
"Field11": "",
"responses": "",
"Field10": "Completed",
"Field1": "id.failure"
},
"IdentityInfo": {
"IssuedDate": "1993-04-23",
"ExpirationDate": "2023-01-01",
"IdNumber": "945cwf5678",
"IssuedCountry": "",
"TaxIdNum": "065452564",
"IssuedState": "",
"IDType": "Driver License"
},
"AddressInfo": {
"AddressLine2": "",
"AddressLine1": "STREET",
"State": "IN-TG",
"Zipcode": "12345",
"Country": "IN",
"City": "hsh"
}
}
],
"ProductSelection": {
"NoOfProducts": "1",
"Products": [
{
"ProductGroupId": "PG2030125BDK",
"ProductGroupDisplayName": "Savings Accounts",
"ProductGroupRef": "SAVINGS.ACCOUNTS",
"ProductCurrencyId": "EUR",
"ProductName": "Prime Saving Account",
"ProductId": "PR20301ARET5",
"ProductRef": "SAVINGS.PRIME.INFINITY",
"BranchReference": "GB0010001",
"FeatureSelection": {
"NoOfFeatures": "1",
"Features": {
"Feature": [
{
"FeatureId": "CARD.ISSUE",
"SequenceNo": "1",
"Type": "CheckBox",
"FeatureDescription": "Carry your bank account safely wherever you go with the Debit card. And Do a lot more with your Debit Card!!",
"ProductRef": "SAVINGS.PRIME.INFINITY",
"ProductId": "PR20301ARET5",
"FeatureName": "Yes, I like to avail to Debit Card",
"SelectedValue": "OPT-IN"
}
]
}
},
"AccountNumber": " "
}
]
},
"Application": {
"Status": "UnderReview",
"StartDate": "2021-02-17",
"ApplicationType": "",
"UserActionCount": "1",
"EligibilityCriteria": "",
"IsExistingCustomer": "Yes",
"CoApplicantCount": "0"
},
"TermsAndCondition": {
"TnCFlag": "Accepted"
}
},
"applicationId": "6CSKSYP",
"httpStatusCode": 0
}
|
||||
| Error Code(s): |
Error Code: 71000 |
||||
| Service Flow: |
|
updateUserActionStatus
| Description: | This API updates the status of a user action in the Origination Data Microservice (ODMS). | ||||||
| Method: | POST | ||||||
| URL: | {BASEURI}/services/data/v1/TaskManagementServices/operations/Application/updateUserActionStatus | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters applicationId Specifies the unique ID of an application. UserActionIdentifier Specifies the unique ID of a user action. Status Specifies the status of a user action. {
"applicationId": "G36N4LJ",
"UserActionIdentifier": "MobilePhoneNumberConsent_2009521090_G36N4LJ",
"Status": "Completed",
"Response": ""
}
|
||||||
| Response: |
{
"opstatus": 0,
"message": "UserAction updated successfully",
"status": "Success",
"httpStatusCode": 200
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getTask
| Description: | This API retrieves all the details of a task and corresponding task’s application details. | ||||||
| Method: | POST | ||||||
| URL: | {BASE URI}/services/data/v1/TaskManagementServices/operations/Task/getTask | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters filter Specifies the parameter using which the specific applications are extracted. forceRefresh Specifies the mode of fetching data from Server or Cache. pageLimit Specifies the number of records per page. pageOffset Specifies the page number. startDate Specifies the start date of the required applications. endDate Specifies the end date of the required applications. {
"filter": [],
"forceRefresh": true,
"pageLimit": "10",
"pageOffset": "0",
"startDate": "2021-02-15",
"endDate": "2021-02-22"
}
|
||||||
| Response: |
Parameters /records/taskDetails Specifies the details of the tasks /records/taskDetails/taskType error, manual, user action /records/taskDetails/taskPotOwners Specifies the assigned user group for the task /records/taskDetails/taskPriority Specifies the priority of the task /records/taskDetails/taskInputData Specifies the input details of the task /records/taskDetails/taskName Specifies the name of the task. It could be error review, manual review, or user action review. /records/taskDetails/taskCreatedOn Specifies the date and time of the task when it is created. /records/taskDetails/taskProcessId Specifies the process id of the task /records/taskDetails/correlationKey Specifies the value of the correlation key /records/taskDetails/taskProcessInstanceId Specifies the process id of the task /records/taskDetails/taskStatus Specifies the status of the task /records/taskDetails/taskId Specifies the unique identifier of the task /records/applicationDetails Specifies all the details of an application /records/applicationDetails/StartDate Specifies the date on which the application was started. /records/applicationDetails/Status Specifies status of the application /records/applicationDetails/applicationId Specifies the unique identifier of theapplication /records/applicationDetails/CustomerId Specifies the unique identifier of the customer /records/applicationDetails/Country Specifies the applicant;s country /records/applicationDetails/FirstName Specifies the applicant's first name /records/applicationDetails/LastName Specifies the applicant's last name /records/applicationDetails/City Specifies the applicant's city /records/applicationDetails/DateOfBirth Specifies the applicant's date of birth /records/applicationDetails/Email Specifies the applicant's email. /records/applicationDetails/MobileNumber Specifies the applicant's mobile number /records/applicationDetails/CountryCode Specifies the applicant's country code
{
"records": [
{
"taskDetails": {
"taskType": "Error Review",
"taskPotOwners": "temenosusergroup",
"taskPriority": "0",
"taskInputData": {
"ErrorCode": "78005",
"applicationId": "VX455SS",
"ErrorMessage": "{\"dbpErrCode\":\"78005\",\"opstatus\":8009,\"dbpErrMsg\":\"Upgrade Digital Profile failed\",\"httpStatusCode\":400}"
},
"taskName": "Error Review",
"taskCreatedOn": "2021-02-19 12:07:41 GMT",
"taskProcessId": "RetailOnboarding.ErrorHandler",
"correlationKey": "527",
"taskProcessInstanceId": "527",
"taskStatus": "Ready",
"taskId": "229"
},
"applicationDetails": {
"StartDate": "2020-11-11",
"Status": "SUBMITTED",
"applicationId": "FHWEFHW",
"CustomerId": "100303",
"Country": "USA",
"FirstName": "Jane",
"LastName": "Smith",
"City": "Atlanta",
"DateOfBirth": "1995-01-01",
"Email": "jane.doe@gmail.com",
"MobileNumber": "4158586273",
"CountryCode": "+1"
}
}
]
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getAllTasksForAppID
| Description: | This API retrieves all tasks for a given application Id from RedHat PAM. | |||||
| Method: | POST | |||||
| URL: | {BASE URI>/services/data/v1/TaskManagementServices/operations/Task/getAllTasksForAppID | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters applicationId Specifies the unique ID of the application {
"ApplicationId":"TTNYGJM"
}
|
|||||
| Response: |
Parameters /taskInstance/taskPotOwners Specifies the assigned user group for the task /taskInstance/taskPriority Specifies the priority of the task /taskInstance/taskInputData Specifies the input details of the task /taskInstance/taskName Specifies the name of the task. It could be error review, manual review, or user action review. /taskInstance/taskCreatedOn Specifies the date and time of the task when it is created. /taskInstance/taskProcessId Specifies the process id of the task /taskInstance/correlationKey Specifies the value of the correlation key /taskInstance/taskProcessInstanceId Specifies the process id of the task /taskInstance/taskStatus Specifies the status of the task /taskInstance/taskId Specifies the unique task Id.
{
"taskInstance": [
{
"taskPotOwners": "temenosusergroup",
"taskPriority": 0,
"taskInputData": {
"ErrorCode": "78004",
"applicationId": "TTNYGJM",
"ErrorMessage": "{\"dbpErrCode\":\"78004\",\"opstatus\":8009,\"dbpErrMsg\":\"Upgrade Digital Profile failed\",\"httpStatusCode\":400}"
},
"taskName": "Error Review",
"taskCreatedOn": 1612950165528,
"taskProcessId": "RetailOnboarding.ErrorHandler",
"correlationKey": "15",
"taskProcessInstanceId": 15,
"taskStatus": "Ready",
"taskId": 4
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
startTask
| Description: | This API initiates action on the task and starts the task in RedHat PAM. | |||||
| Method: | POST | |||||
| URL: | {BASE URI}/services/data/v1/TaskManagementServices/operations/Task/startTask | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters taskContainerId Specifies the unique task container Id. taskId Specifies the unique task Id. {
"taskContainerId": "DealSubmission_1.0.0-SNAPSHOT",
"taskId": "344"
}
|
|||||
| Response: |
{
"status": "Success",
"message": "Updated task status successfully."
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
completeTask
| Description: | This API initiates action on the task and completes the task in RedHat PAM. | |||||
| Method: | POST | |||||
| URL: | {BASE URI}/services/data/v1/TaskManagementServices/operations/Task/completeTask | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters taskContainerId Specifies the unique task container Id. taskId Specifies the unique task Id. {
"taskContainerId": "DealSubmission_1.0.0-SNAPSHOT",
"taskId": "344"
}
|
|||||
| Response: |
{
"status": "Success",
"message": "Updated task status successfully."
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
getTaskDetails
| Description: | This API retrieves all the details of a task from PAM based on task ID and corresponding application Details from ODMS. | ||||||
| Method: | POST | ||||||
| URL: | <BASE URI>/services/data/v1/TaskManagementServices/operations/Task/getTaskDetails | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters taskId Specifies the unique ID of the task. {
"taskId": "1065",
}
|
||||||
| Response: |
Parameters /applicationDetails Specifies all the details of an application /applicationId Specifies the unique identifier of the application /applicationDetails/UserAction Specifies the user action /applicationDetails/Application/Status Specifies the status of the application /applicationDetails/Application/StartDate Specifies the date on which the application was started. /applicationDetails/Application/ApplicationType Specifies the type of applicant such as general applicant or co-applicant. /applicationDetails/Application/UserActionCount Specifies the number of pending user actions /applicationDetails/Application/BankReference Specifies the bank reference /applicationDetails/Application/IsDataChanged Specifies if the data of the existing user is changed /applicationDetails/Application/OpportunityId Specifies the oppurtunity Id in Salesforce /applicationDetails/Application/EligibilityCriteria Specifies the key value of Eligibility criteria /applicationDetails/Application/IsExistingCustomer Specifies if the applicant is an existing customer /applicationDetails/Application/ApplicationStage Specifies the stage of the application /applicationDetails/Application/CoApplicantCount Specifies the number of co-applicant /taskDetails Specifies the details of a task /taskDetails/taskDescription Specifies the description of a task /taskDetails/taskInputData Specifies the input details of the task /taskDetails/taskActualOwner Specifies the assignee of the task /taskDetails//taskType Specifies the type of the task /taskDetails//taskSubject Specifies the subject of the task /taskDetails//taskPotOwners Specifies the assigned user group for the task /taskDetails//taskOutputData Specifies the output data of the task /taskDetails//taskBusinessAdmins Specifies the business admins of the task /taskDetails//slaDueDate Specifies the service level agreement due date /taskDetails//taskCreatedOn Specifies the date and time of the task when it is created. /taskDetails//taskStatus Specifies the status of the task /taskDetails//taskCreatedBy Specifies by whom the task was created /taskDetails//taskExpirationTime Specifies the expiration time of the task /taskDetails//taskPriority Specifies the priority of the task /taskDetails//taskSkippable Specifies if the task is skippable /taskDetails//taskProcessId Specifies the process id of the task /taskDetails//taskContainerId Specifies the container id of the task /taskDetails//taskExclOwners Specifies the exclusive owners of the task /taskDetails//taskForm Specifies the form of the task /taskDetails//taskWorkitemId Specifies the unique id of the task work item /taskDetails//taskParentId Specifies the unique id of the parent task /taskDetails//taskActivationTime Specifies the task activation time
{
"opstatus": 0,
"applicationDetails": {
"applicationDetails": {
"UserAction": {},
"Application": {
"Status": "AutoApproved",
"StartDate": "2021-04-05",
"ApplicationType": "",
"UserActionCount": "0",
"BankReference": "",
"IsDataChanged": "false",
"OpportunityId": "",
"EligibilityCriteria": "33333",
"IsExistingCustomer": "No",
"ApplicationStage": "Started",
"CoApplicantCount": "0"
}
},
"applicationId": "DQ6YM2K"
},
"httpStatusCode": 0,
"taskDetails": {
"taskDescription": "",
"taskInputData": {
"ErrorCode": "75312",
"ApplicationId": "DQ6YM2K",
"ErrorMessage": "{\"dbpErrCode\":\"75312\",\"opstatus\":8009,\"dbpErrMsg\":\"Failed to get Core Id from backendidentifier\",\"httpStatusCode\":400}"
},
"taskActualOwner": "",
"taskType": "Error Review",
"taskSubject": "",
"taskPotOwners": {},
"taskOutputData": {},
"taskBusinessAdmins": {},
"slaDueDate": {},
"taskCreatedOn": {
"date": "2021-04-05 14:36:03 GMT"
},
"taskStatus": "Ready",
"taskCreatedBy": "",
"taskExpirationTime": {},
"taskPriority": "0",
"taskSkippable": {},
"taskProcessId": "RetailOnboarding.ErrorHandler",
"taskContainerId": "RetailOnboarding_2021.01.00",
"taskExclOwners": {},
"taskForm": "ErrorReview",
"taskWorkitemId": "9",
"taskParentId": {},
"taskActivationTime": {
"date": "2021-04-05 14:36:03 GMT"
},
"opstatus": "0",
"taskName": "Error Review",
"taskProcessInstanceId": "14",
"taskId": "2",
"httpStatusCode": "200"
}
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getConfigs
| Description: | This API retrieves the configurations stored from microservice. | |||||
| Method: | GET | |||||
| URL: | <BASE URI>/services/data/v1/ConfigurationObjectServices/operations/ConfigurationsMS/getConfigs | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters configGroup Specifies the name of the bundle from which the configurations are downloaded. {
"configGroup": "WORKSPACE.CONFIG"
}
|
|||||
| Response: |
Parameters Specifies data of the configurations in a specific bundle.
{
"opstatus":0,"items":[
{
"data":"
{
\\r\\n \\"common\\":
{
\\r\\n \\"navigation\\":
{
\\r\\n \\"properties\\": [\\r\\n
{
\\r\\n \\"label\\": \\"Back to Spotlight\\",\\r\\n \\"icon\\": \\"apps\\",\\r\\n \\"value\\": \\"spotlight\\"\\r\\n
}
,\\r\\n
{
\\r\\n \\"label\\": \\"Application Management\\",\\r\\n \\"icon\\": \\"description\\",\\r\\n \\"value\\": \\"applications\\"\\r\\n
}
,\\r\\n
{
\\r\\n \\"label\\": \\"Task Management\\",\\r\\n \\"icon\\": \\"assignment\\",\\r\\n \\"value\\": \\"tasks\\"\\r\\n
}
\\r\\n ]\\r\\n
}
\\r\\n
}
\\r\\n
}
",
"name":"WORKSPACE.CONFIG,UUXComponentConfiguration",
"id":"d290f1ee-6c54-4b01-90e6-d701748f9851",
"version":"1.0.0"
}
],"httpStatusCode":200
}
|
|||||
| Error Code(s): |
NA |
|||||
| Service Flow: |
|
createConfig
| Description: | Creates a record or configuration in the microservice. | ||||||
| Method: | POST | ||||||
| URL: | {BASE URI}/services/data/v1/ConfigurationObjectServices/objects/ConfigurationsMS | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters configGroup Specifies the name of the bundle from which the configurations are downloaded. configName Specifies the name of the config id Specifies a unique identifier {
"configGroup": "WORKSPACE.CONFIG",
"configName": "UUXComponentConfiguration",
"data": "{\"version\":1,\"screens\":{\"common\":{\"features\":{\"toolbar\":{\"items\":{\"user\":{\"label\":\"{{ fullName }}\"},\"configure\":{\"permissions\":[\"Relationship Manager\"]}}},\"breadcrumbs\":{\"items\":{\"taskSearch\":{\"label\":\"Tasks\"},\"applicationSearch\":{\"label\":\"Applications\"},\"applicationDetail\":{\"label\":\"Application Details\"},\"summaryApplication\":{\"label\":\"Application Details\",\"permissions\":[\"Relationship Manager\",\"Operations Associate\"]},\"summaryTask\":{\"label\":\"Task Details\"},\"taskDetail\":{\"label\":\"Task Details\"}}},\"footer\":{\"label\":\"Temenos Version {{ version }}\"},\"navigation\":{\"items\":{\"launchpad\":{\"label\":\"Launchpad\",\"icon\":\"apps\",\"properties\":[{\"label\":\"Spotlight\",\"value\":\"spotlight\"}]},\"applicationManagement\":{\"label\":\"Application Management\",\"icon\":\"description\",\"permissions\":[\"Relationship Manager\"]},\"taskManagement\":{\"label\":\"Task Management\",\"icon\":\"assignment\",\"permissions\":[\"Operations Associate\",\"IT Administrator\"]}}}}},\"taskSearch\":{\"features\":{\"tabs\":{\"properties\":[{\"label\":\"All Outstanding\",\"properties\":[]},{\"label\":\"Unassigned\",\"properties\":[{\"dataIndex\":\"taskDetails.taskActualOwner\",\"value\":\"\"}]},{\"label\":\"Assigned to me\",\"properties\":[{\"dataIndex\":\"taskDetails.taskActualOwner\",\"value\":\"{{ currentUser }}\"}]},{\"label\":\"Completed\",\"properties\":[{\"dataIndex\":\"taskDetails.taskStatus\",\"value\":\"Completed\"}]}]},\"title\":{\"label\":\"Tasks\"},\"select\":{\"label\":\"Queues\",\"properties\":[{\"label\":\"All\",\"value\":\"All\"},{\"label\":\"Manual Review\",\"value\":\"Manual Review\"},{\"label\":\"Error Review\",\"value\":\"Error Review\"},{\"label\":\"Customer Action\",\"value\":\"Customer Action\"}]},\"daterange\":{\"label\":\"Created Date\"},\"searchBar\":{\"label\":\"Columns\",\"properties\":[{\"label\":\"Application ID\",\"value\":\"applicationDetails.applicationId\"},{\"label\":\"Last Name\",\"value\":\"applicationDetails.LastName\"}]},\"table\":{\"properties\":[{\"label\":\"Application ID\",\"dataIndex\":\"applicationDetails.applicationId\",\"type\":\"text\",\"sortable\":true},{\"label\":\"Last Name\",\"dataIndex\":\"applicationDetails.LastName\",\"type\":\"text\"},{\"label\":\"Task ID\",\"dataIndex\":\"taskDetails.taskId\",\"type\":\"text\",\"sortable\":true},{\"label\":\"Task Name\",\"dataIndex\":\"taskDetails.taskName\",\"type\":\"text\"},{\"label\":\"Task Created\",\"dataIndex\":\"taskDetails.taskCreatedOn\",\"type\":\"date\",\"sortable\":true},{\"label\":\"Task Assignee\",\"dataIndex\":\"taskDetails.taskActualOwner\",\"type\":\"text\"},{\"label\":\"Last Modified\",\"dataIndex\":\"taskDetails.taskCreatedOn\",\"type\":\"date\",\"sortable\":true}]}}},\"applicationSearch\":{\"features\":{\"tabs\":{\"properties\":[{\"label\":\"Not Submitted\",\"properties\":[{\"dataIndex\":\"Status\",\"value\":[\"InProgress\"]}]},{\"label\":\"Submitted\",\"properties\":[{\"dataIndex\":\"Status\",\"value\":[\"UnderReview\"]}]},{\"label\":\"Completed\",\"properties\":[{\"dataIndex\":\"Status\",\"value\":[\"AutoApproved\",\"Approved\",\"AutoDenied\",\"Denied\"]}]}]},\"title\":{\"label\":\"Applications\"},\"daterange\":{\"label\":\"Created Date\"},\"searchBar\":{\"label\":\"Columns\",\"properties\":[{\"label\":\"Application ID\",\"value\":\"applicationId\"},{\"label\":\"First Name\",\"value\":\"FirstName\"},{\"label\":\"Last Name\",\"value\":\"LastName\"},{\"label\":\"Status\",\"value\":\"Status\"}]},\"table\":{\"properties\":[{\"label\":\"Application ID\",\"dataIndex\":\"applicationId\",\"type\":\"text\",\"sortable\":true},{\"label\":\"Type\",\"dataIndex\":\"ApplicationType\",\"type\":\"text\"},{\"label\":\"First Name\",\"dataIndex\":\"FirstName\",\"type\":\"text\",\"sortable\":true},{\"label\":\"Last Name\",\"dataIndex\":\"LastName\",\"type\":\"text\"},{\"label\":\"Status\",\"dataIndex\":\"Status\",\"type\":\"text\"},{\"label\":\"Creation Date\",\"dataIndex\":\"StartDate\",\"type\":\"date\"},{\"label\":\"Last Modified\",\"dataIndex\":\"EndDate\",\"type\":\"text\"}]}}},\"applicationSummary\":{\"features\":{\"hero\":{\"label\":\"Application ID\",\"dataIndex\":\"applicationDetails.applicationId\",\"properties\":[{\"label\":\"Application Type\",\"icon\":\"info\",\"dataIndex\":\"applicationDetails.applicationType\",\"type\":\"text\"},{\"label\":\"Application Status\",\"icon\":\"info\",\"dataIndex\":\"applicationDetails.Status\",\"type\":\"text\"},{\"label\":\"Applicant Name\",\"icon\":\"info\",\"dataIndex\":\"applicationDetails.PrimaryApplicant\",\"type\":\"text\"},{\"label\":\"Application Creation Date\",\"icon\":\"info\",\"dataIndex\":\"applicationDetails.StartDate\",\"type\":\"date\"}],\"items\":{\"resume\":{\"label\":\"Resume\",\"permissions\":[\"Relationship Manager\"]}}},\"customCards\":{\"hideEmpty\":true,\"items\":{\"Overview\":{\"label\":\"Overview\",\"type\":\"group\",\"properties\":[{\"label\":\"Overview\",\"type\":\"info\",\"properties\":[{\"label\":\"Application Created Date\",\"dataIndex\":\"Application.StartDate\",\"type\":\"date\"},{\"label\":\"Application Status\",\"dataIndex\":\"Application.Status\",\"type\":\"text\"},{\"label\":\"Existing Customer?\",\"dataIndex\":\"Application.IsExistingCustomer\",\"type\":\"text\"},{\"label\":\"Eligibility Criteria\",\"dataIndex\":\"Application.EligibilityCriteria\",\"type\":\"text\"},{\"label\":\" Data Discrepancy\",\"dataIndex\":\"Application.IsDataChanged\",\"type\":\"text\"}]},{\"label\":\"Funding\",\"type\":\"table\",\"dataSource\":\"Funding.FundingProducts\",\"properties\":[{\"label\":\"Product ID\",\"dataIndex\":\"FundingProductId\",\"type\":\"text\"},{\"label\":\"Currency\",\"dataIndex\":\"FundingCurrency\",\"type\":\"text\"},{\"label\":\"Amount\",\"dataIndex\":\"FundingAmount\",\"type\":\"text\"},{\"label\":\"Debit Account\",\"dataIndex\":\"DebitAccount\",\"type\":\"text\"},{\"label\":\"Debit IBAN\",\"dataIndex\":\"DebitIBAN\",\"type\":\"text\"},{\"label\":\"Debit Account Type\",\"dataIndex\":\"DebitAccountType\",\"type\":\"text\"},{\"label\":\"Bank Name\",\"dataIndex\":\"BankName\",\"type\":\"text\"},{\"label\":\"Payment Reference\",\"dataIndex\":\"PaymentReference\",\"type\":\"text\"}]},{\"label\":\"Consent\",\"type\":\"table\",\"dataSource\":\"Consent\",\"properties\":[{\"label\":\"ConsentIdentifier\",\"dataIndex\":\"ConsentIdentifier\",\"type\":\"text\"},{\"label\":\"AcceptanceStatus\",\"dataIndex\":\"AcceptanceStatus\",\"type\":\"text\"}]}]},\"Applicants\":{\"label\":\"Applicants\",\"type\":\"tableExtended\",\"dataSource\":\"Applicants\",\"properties\":[{\"label\":\"Primary Applicant\",\"dataIndex\":\"PersonalInfo.primaryApplicant\",\"type\":\"text\"},{\"label\":\"First Name\",\"dataIndex\":\"PersonalInfo.FirstName\",\"type\":\"text\"},{\"label\":\"Last Name\",\"dataIndex\":\"PersonalInfo.LastName\",\"type\":\"text\"},{\"label\":\"Email\",\"dataIndex\":\"PersonalInfo.Email\",\"type\":\"text\"}],\"sections\":[{\"label\":\"Personal Details\",\"type\":\"info\",\"properties\":[{\"label\":\"First Name\",\"dataIndex\":\"PersonalInfo.FirstName\",\"type\":\"text\"},{\"label\":\"Last Name\",\"dataIndex\":\"PersonalInfo.LastName\",\"type\":\"text\"},{\"label\":\"Email\",\"dataIndex\":\"PersonalInfo.Email\",\"type\":\"text\"},{\"label\":\"Phone\",\"dataIndex\":\"PersonalInfo.MobileNumber\",\"type\":\"text\"},{\"label\":\"Country Code\",\"dataIndex\":\"PersonalInfo.MobileCountryCode\",\"type\":\"text\"},{\"label\":\"Date Of Birth\",\"dataIndex\":\"PersonalInfo.DateOfBirth\",\"type\":\"date\"}]},{\"label\":\"Address for correspondence\",\"type\":\"info\",\"properties\":[{\"label\":\"Address Line 1\",\"dataIndex\":\"AddressInfo.AddressLine1\",\"type\":\"text\"},{\"label\":\"Address Line 2\",\"dataIndex\":\"AddressInfo.AddressLine2\",\"type\":\"text\"},{\"label\":\"City\",\"dataIndex\":\"AddressInfo.City\",\"type\":\"text\"},{\"label\":\"State\",\"dataIndex\":\"AddressInfo.State\",\"type\":\"text\"},{\"label\":\"Country\",\"dataIndex\":\"AddressInfo.Country\",\"type\":\"text\"},{\"label\":\"Postal Code\",\"dataIndex\":\"AddressInfo.Zipcode\",\"type\":\"text\"}]},{\"label\":\"Identity(ID)\",\"type\":\"info\",\"properties\":[{\"label\":\"ID Number\",\"dataIndex\":\"IdentityInfo.IdNumber\",\"type\":\"text\"},{\"label\":\"ID Type\",\"dataIndex\":\"IdentityInfo.IDType\",\"type\":\"text\"},{\"label\":\"Issue Date\",\"dataIndex\":\"IdentityInfo.IssuedDate\",\"type\":\"date\"},{\"label\":\"Expiry Date\",\"dataIndex\":\"IdentityInfo.ExpirationDate\",\"type\":\"date\"},{\"label\":\"Issuing State\",\"dataIndex\":\"IdentityInfo.IssuedState\",\"type\":\"text\"},{\"label\":\"Issuing Country\",\"dataIndex\":\"IdentityInfo.IssuedCountry\",\"type\":\"text\"},{\"label\":\"Tax ID Number\",\"dataIndex\":\"IdentityInfo.TaxIdNum\",\"type\":\"text\"}]},{\"label\":\"Identity Verification\",\"type\":\"info\",\"statusColors\":{\"Black\":[\"HARDFAIL\"],\"LightGreen\":[\"LOW\"],\"Green\":[\"Completed\",\"Approved\",\"Yes\"],\"Red\":[\"id.failure\",\"Denied\",\"No\"],\"Blue\":[\"REVIEW\",\"NEUTRAL\",\"UNVERIFIED\"],\"Orange\":[\"UnderReview\"]},\"properties\":[{\"label\":\"Verification ID\",\"dataIndex\":\"KYCInfo.VendorID\",\"type\":\"text\"},{\"label\":\"Decision\",\"dataIndex\":\"KYCInfo.Decision\",\"type\":\"text\"},{\"label\":\"Summary\",\"dataIndex\":\"KYCInfo.Field1\",\"type\":\"text\"},{\"label\":\"Result\",\"dataIndex\":\"KYCInfo.Field2\",\"type\":\"text\"},{\"label\":\"Screening\",\"dataIndex\":\"KYCInfo.Field10\",\"type\":\"text\"},{\"label\":\"Qualifiers\",\"link\":{\"dataIndex\":\"KYCInfo.Field4\",\"type\":\"text\"}},{\"label\":\"ID Authentication Required\",\"dataIndex\":\"KYCInfo.Field5\",\"type\":\"text\"},{\"label\":\"ID Authentication Result\",\"dataIndex\":\"KYCInfo.Field6\",\"type\":\"text\"},{\"label\":\"Answers Submitted\",\"dataIndex\":\"KYCInfo.Field7\",\"type\":\"text\"},{\"label\":\"Verification Response\",\"link\":{\"dataIndex\":\"KYCInfo.Field9\",\"type\":\"text\"}}]},{\"label\":\"Selfie Score\",\"type\":\"info\",\"statusColors\":{\"Green\":[\"Passed\"],\"Red\":[\"Failed\"]},\"properties\":[{\"label\":\"Score\",\"dataIndex\":\"SelfieScore.SelfieScore\",\"type\":\"text\"},{\"label\":\"Liveness score\",\"dataIndex\":\"SelfieScore.LivenessSelfieScore\",\"type\":\"text\"},{\"label\":\"Selfie result\",\"dataIndex\":\"SelfieScore.SelfieResult\",\"type\":\"text\"},{\"label\":\"Liveness result\",\"dataIndex\":\"SelfieScore.LivenessSelfieResult\",\"type\":\"text\"},{\"label\":\"Far selfie result\",\"dataIndex\":\"SelfieScore.FarSelfieResult\",\"type\":\"text\"},{\"label\":\"Decision\",\"dataIndex\":\"SelfieScore.Decision\",\"type\":\"text\"}]}]},\"Tasks\":{\"label\":\"Tasks\",\"type\":\"table\",\"dataSource\":\"taskList\",\"properties\":[{\"label\":\"Task ID\",\"dataIndex\":\"taskId\",\"type\":\"text\"},{\"label\":\"Task Name\",\"dataIndex\":\"taskName\",\"type\":\"text\"},{\"label\":\"Task Status\",\"dataIndex\":\"taskStatus\",\"type\":\"text\"},{\"label\":\"Task Assignee\",\"dataIndex\":\"taskPotOwners\",\"type\":\"text\"},{\"label\":\"Task Created\",\"dataIndex\":\"taskCreatedOn\",\"type\":\"text\"},{\"label\":\"Task Last Modified\",\"dataIndex\":\"taskCreatedOn\",\"type\":\"text\"}]},\"CustomerActions\":{\"label\":\"Customer Actions\",\"type\":\"table\",\"dataSource\":\"UserAction.UserActions\",\"properties\":[{\"label\":\"Group\",\"dataIndex\":\"ActionMetaData.Group\",\"type\":\"text\"},{\"label\":\"Title\",\"dataIndex\":\"ActionMetaData.Title\",\"type\":\"text\"},{\"label\":\"Status\",\"dataIndex\":\"UserActionStatus\",\"type\":\"text\"},{\"label\":\"UserActionName\",\"dataIndex\":\"UserActionName\",\"type\":\"text\"}]},\"Products\":{\"label\":\"Products\",\"type\":\"tableExtended\",\"dataSource\":\"ProductSelection.Products\",\"properties\":[{\"label\":\"Product ID\",\"dataIndex\":\"ProductId\",\"type\":\"text\"},{\"label\":\"Product Name\",\"dataIndex\":\"ProductName\",\"type\":\"text\"},{\"label\":\"Account Number\",\"dataIndex\":\"AccountNumber\",\"type\":\"text\"}],\"sections\":[{\"label\":\"Product Details\",\"type\":\"info\",\"properties\":[{\"label\":\"Name\",\"dataIndex\":\"ProductName\",\"type\":\"text\"},{\"label\":\"Reference\",\"dataIndex\":\"ProductRef\",\"type\":\"text\"},{\"label\":\"Group\",\"dataIndex\":\"ProductGroupDisplayName\",\"type\":\"text\"},{\"label\":\"Account Number\",\"dataIndex\":\"AccountNumber\",\"type\":\"text\"},{\"label\":\"Number of features\",\"dataIndex\":\"FeatureSelection.NoOfFeatures\",\"type\":\"text\"}]},{\"label\":\"Features\",\"type\":\"table\",\"dataSource\":\"FeatureSelection.Features.Feature\",\"properties\":[{\"label\":\"Feature ID\",\"dataIndex\":\"FeatureId\",\"type\":\"text\"},{\"label\":\"Name\",\"dataIndex\":\"FeatureName\",\"type\":\"text\"},{\"label\":\"Type\",\"dataIndex\":\"Type\",\"type\":\"text\"},{\"label\":\"Description\",\"dataIndex\":\"FeatureDescription\",\"type\":\"text\"}]},{\"label\":\"Certificate of Deposit (CD) plans\",\"type\":\"table\",\"dataSource\":\"CDSelection.CDPlans.CDPlan\",\"properties\":[{\"label\":\"Plan ID\",\"dataIndex\":\"CDPlanId\",\"type\":\"text\"},{\"label\":\"Interest Rate\",\"dataIndex\":\"InterestRate\",\"type\":\"text\"},{\"label\":\"Term\",\"dataIndex\":\"Term\",\"type\":\"text\"},{\"label\":\"Annual Percent Yield (APY)\",\"dataIndex\":\"APY\",\"type\":\"text\"},{\"label\":\"Deposit Amount\",\"dataIndex\":\"DepositAmount\",\"type\":\"text\"}]}]}}}}},\"taskSummary\":{\"features\":{\"hero\":{\"label\":\"Application ID\",\"dataIndex\":\"applicationDetails.applicationId\",\"properties\":[{\"label\":\"Application Type\",\"icon\":\"info\",\"dataIndex\":\"applicationDetails.applicationType\",\"type\":\"text\"},{\"label\":\"Primary Status\",\"icon\":\"info\",\"dataIndex\":\"applicationDetails.Status\",\"type\":\"text\"},{\"label\":\"Applicant Name\",\"icon\":\"info\",\"dataIndex\":\"applicationDetails.PrimaryApplicant\",\"type\":\"text\"},{\"label\":\"Application Created Date\",\"icon\":\"info\",\"dataIndex\":\"applicationDetails.StartDate\",\"type\":\"date\"}]},\"secondaryHero\":{\"label\":\"Task ID\",\"dataIndex\":\"taskDetails.taskId\",\"properties\":[{\"label\":\"Task ID\",\"icon\":\"info\",\"dataIndex\":\"taskDetails.taskId\",\"type\":\"text\"},{\"label\":\"Task Created\",\"icon\":\"info\",\"dataIndex\":\"taskDetails.taskCreatedOn.date\",\"type\":\"date\"},{\"label\":\"Task Assignee\",\"icon\":\"info\",\"dataIndex\":\"taskDetails.taskActualOwner\",\"type\":\"text\"},{\"label\":\"Last Modified\",\"icon\":\"info\",\"dataIndex\":\"taskDetails.taskActivationTime.date\",\"type\":\"date\"}],\"items\":{\"claim\":{\"label\":\"Claim\",\"permissions\":[\"Operations Associate\",\"IT Administrator\"]},\"retry\":{\"label\":\"Retry\",\"permissions\":[\"Operations Associate\",\"IT Administrator\"]},\"complete\":{\"label\":\"Complete\",\"permissions\":[\"Operations Associate\",\"IT Administrator\"]},\"decision\":{\"label\":\"Decision\",\"permissions\":[\"Operations Associate\",\"IT Administrator\"],\"properties\":[{\"label\":\"Approve\",\"value\":\"approve\",\"permissions\":[\"Operations Associate\",\"IT Administrator\"]},{\"label\":\"Reject\",\"value\":\"reject\",\"permissions\":[\"Operations Associate\",\"IT Administrator\"]}]}}},\"customCards\":{\"hideEmpty\":true,\"items\":{\"ErrorReview\":{\"label\":\"Error Review\",\"type\":\"info\",\"properties\":[{\"label\":\"Application ID\",\"dataIndex\":\"taskDetails.applicationId\",\"type\":\"text\"},{\"label\":\"Process ID\",\"dataIndex\":\"taskDetails.taskProcessId\",\"type\":\"text\"},{\"label\":\"Task ID\",\"dataIndex\":\"taskDetails.taskId\",\"type\":\"text\"},{\"label\":\"Task Created\",\"dataIndex\":\"taskDetails.taskCreatedOn.date\",\"type\":\"date\"},{\"label\":\"Task Status\",\"dataIndex\":\"taskDetails.taskStatus\",\"type\":\"text\"},{\"label\":\"Error ID\",\"dataIndex\":\"taskDetails.taskInputData.ErrorCode\",\"type\":\"text\"},{\"label\":\"Error Description\",\"dataIndex\":\"taskDetails.taskInputData.ErrorMessage\",\"type\":\"text\"},{\"label\":\"Last Modified\",\"dataIndex\":\"taskDetails.taskActivationTime.date\",\"type\":\"date\"},{\"label\":\"Task Name\",\"dataIndex\":\"taskDetails.taskName\",\"type\":\"text\"}]},\"ManualReview\":{\"label\":\"Manual Review\",\"type\":\"info\",\"properties\":[{\"label\":\"Application ID\",\"dataIndex\":\"taskDetails.applicationId\",\"type\":\"text\"},{\"label\":\"Process ID\",\"dataIndex\":\"taskDetails.taskProcessId\",\"type\":\"text\"},{\"label\":\"Task ID\",\"dataIndex\":\"taskDetails.taskId\",\"type\":\"text\"},{\"label\":\"Task Created\",\"dataIndex\":\"taskDetails.taskCreatedOn.date\",\"type\":\"date\"},{\"label\":\"Task Status\",\"dataIndex\":\"taskDetails.taskStatus\",\"type\":\"text\"},{\"label\":\"Last Modified\",\"dataIndex\":\"taskDetails.taskActivationTime.date\",\"type\":\"date\"},{\"label\":\"Task Name\",\"dataIndex\":\"taskDetails.taskName\",\"type\":\"text\"}]},\"CustomerAction\":{\"label\":\"Customer Action\",\"type\":\"info\",\"properties\":[{\"label\":\"Application ID\",\"dataIndex\":\"taskDetails.applicationId\",\"type\":\"text\"},{\"label\":\"Process ID\",\"dataIndex\":\"taskDetails.taskProcessId\",\"type\":\"text\"},{\"label\":\"Task ID\",\"dataIndex\":\"taskDetails.taskId\",\"type\":\"text\"},{\"label\":\"Task Created\",\"dataIndex\":\"taskDetails.taskCreatedOn.date\",\"type\":\"date\"},{\"label\":\"Task Name\",\"dataIndex\":\"taskDetails.taskName\",\"type\":\"text\"},{\"label\":\"Task Status\",\"dataIndex\":\"taskDetails.taskStatus\",\"type\":\"text\"},{\"label\":\"Action Status\",\"dataIndex\":\"taskDetails.userActionDataStatus\",\"type\":\"text\"},{\"label\":\"Task Assignee\",\"dataIndex\":\"taskDetails.taskActualOwner\",\"type\":\"text\"},{\"label\":\"Customer’s Answer\",\"dataIndex\":\"taskDetails.userActionData\",\"type\":\"text\"},{\"label\":\"Document\",\"dataIndex\":\"taskDetails.userActionDataDoc\",\"type\":\"text\",\"link\":{\"dataIndex\":\"taskDetails.userActionDataDoc\",\"type\":\"download\"}}]}}}}}}}",
"id": "d290f1ee-6c54-4b01-90e6-d701748f9851"
}
|
||||||
| Response: | {
"opstatus": 0,
"httpStatusCode": 200
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
resumeProspectOnboardingApplication
| Description: | This API retrieves the Origination URL to resume the application for prospect. | |||||
| Method: | POST | |||||
| URL: | {BASE URI}/services/data/v1/TaskManagementServices/operations/Application/resumeProspectOnboardingApplication | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters customerid Specifies the unique id of a customer. ApplicationId Specifies the unique id of an application. PhoneNumber Specifies the phone number of an applicant. {
"customerid": "1095134268",
"ApplicationId": "CMD66GG",
"PhoneNumber": "+91-9849552454"
}
|
|||||
| Response: |
Parameters /BankingURL Specifies the URL of the bank's app. {
"BankingURL": "https://dbxlendingqa.konycloud.com/apps/Onboarding/#_frmLanding?session_token=643978b8-5b53-411c-8dec-7ab2f0000973&ApplicationId=jDYWQ0ZXN2X7d7CnCNtQOw&Identifier=c360&IsCustomer=true"
"httpStatusCode": 0
"opstatus": 0
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
resumeCustomerOnboardingApplication
| Description: | This API retrieves the Origination URL to resume the application for customer. | |||||
| Method: | POST | |||||
| URL: | {BASE URI}/services/data/v1/TaskManagementServices/operations/Application/resumeCustomerOnboardingApplication | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters applicationId Specifies the unique id of the application. customerid Specifies the unique id of a customer. {
"customerid": "1002496540",
"ApplicationId": "2NSN67B"
}
|
|||||
| Response: |
Parameters /BankingURL Specifies the URL of the bank's app. {
"BankingURL": "https://dbxlendingqa.konycloud.com/apps/Onboarding/#_frmLanding?session_token=643978b8-5b53-411c-8dec-7ab2f0000973&ApplicationId=jDYWQ0ZXN2X7d7CnCNtQOw&Identifier=c360&IsCustomer=true"
"httpStatusCode": 0
"opstatus": 0
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
downloadDocument
| Description: | This API retrieves the document that is uploaded through the Infinity Origination app. | |||||
| Method: | POST | |||||
| URL: | {BASE URI}/services/data/v1/TaskManagementServices/operations/Application/downloadDocument | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters documentId Specifies the unique identifier of a document. documentGroup Specifies the unique identifier of the document group. ownerSystemId Specifies the owner id to identify the document. {
"documentId": "c860d983-475f-43e3-b2ec-2c5b9d4b1e20",
"documentGroup": "journey-retail-onboarding-HY3JDLS",
"ownerSystemId": "retail-onboarding"
}
|
|||||
| Response: |
Parameters /documentName Specifies the name of the document /message Specifies the message that is displayed after the document download is completed /content Specifies the content in base 64 format
{
"opstatus": 0,
"documentName": "UploadFile.pdf",
"message": "Document downloaded successfully",
"content": "+XQ0KPj4NCnN0YXJ0eHJlZg0KMTc4DQolJUVPRg0K", //Base64 encoded content
"httpStatusCode": 200
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
CreateUserActionOperation
| Description: | After an application is submitted and the application status goes to Under Review, this API creates a new user action from the RedHat. | |||||
| Method: | POST | |||||
| URL: | {{baseUrl}}/services/OnBoardingJavaServices/CreateUserActionsOperation | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters ApplicationId Specifies the unique identifier of the application ProductId Specifies the unique identifier of the product PartyId Specifies the unique identifier of the Party entry UserActionName Specifies the user action name /UserActionName/FormCode Specifies the application name {
"ApplicationId": "C6WGT11",
"ProductId": "SAVINGS.SALARY.INFINITY",
"PartyId": "191945",
"UserActionName": "EmploymentStatus",
"FormCode":"onboarding"
}
|
|||||
| Response: |
Parameters {
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
UpdateUserActionOperation
| Description: | This Api is invoked for each user action response submitted by the user. | |||||
| Method: | POST | |||||
| URL: | {{baseUrl}}/services/OnBoardingJavaServices/UpdateUserActionOperation | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters UserActionIdentifier Specifies the unique identifier of the user action Status Specifies the state of the user action Response Specifies the response of the user action {
"UserActionIdentifier": "BackupWithholding_SAVINGS.SALARY.INFINITY_2009521090",
"Status": "Submitted",
"Response": "No, I'm not subject to backup withholding"
}
|
|||||
| Response: | {
"opstatus": 0,
"id": "6034c59343dce940c95d80c3",
"httpStatusCode": 200
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
GetUserActionOperation
| Description: | This API retrieves the complete user action details of the application. | |||||
| Method: | POST | |||||
| URL: | {{baseUrl}}/services/OnBoardingJavaServices/getUserActionsOperation | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: | {}
|
|||||
| Response: | {
"Income": [
{
"UserActionName": "EmploymentStatus",
"UserActionStatus": "Created",
"PartyId": "191945",
"ActionMetaData": {
"Group": "Income",
"Options": [
"Employed",
"Self-Employed",
"Other"
],
"Description": "Select your current employment status.",
"NeedsReview": "true",
"Skippable": "false",
"Title": "Employment status",
"UserActionType": "Radio-Button Selection",
"OptionsType": "PREDEFINED"
},
"UserActionIdentifier": "EmploymentStatus_191945_C6WGT11",
"ProductId": "SAVINGS.SALARY.INFINITY"
}
],
"Legal": [
{
"UserActionName": "MobilePhoneNumberConsent",
"UserActionStatus": "Created",
"PartyId": "191945",
"ActionMetaData": {
"Group": "Legal",
"Options": [
"The bank can call or text me through automated means",
"The bank can only contact me through non-automated means",
"The bank can't contact me (this may impact your approval)"
],
"Description": "If the phone number provided on this application is a mobile phone number, it is my mobile phone number, and by clicking on the button below, I consent to receive auto-dialed and prerecorded/artificial calls, including texts, relating to my relationship with this bank. It may include handling, servicing, and billing for any of my account(s). Message and data rates may apply. You can stop these messages by contacting our service center.",
"NeedsReview": "true",
"Skippable": "false",
"Title": "Mobile phone number consent",
"UserActionType": "Radio-ButtonSelection",
"OptionsType": "PREDEFINED"
},
"UserActionIdentifier": "MobilePhoneNumberConsent_191945_C6WGT11",
"ProductId": "SAVINGS.SALARY.INFINITY"
},
{
"UserActionName": "BackupWithholding",
"UserActionStatus": "Created",
"PartyId": "191945",
"ActionMetaData": {
"Group": "Legal",
"Options": [
"No, I'm not subject to backup withholding",
"Yes, I have heard that I'm subject to backup withholding"
],
"Description": "Have you been notified by the local government that you are subject to backup withholding?",
"NeedsReview": "true",
"Skippable": "false",
"Title": "Backup withholding",
"UserActionType": "Radio-ButtonSelection",
"OptionsType": "PREDEFINED"
},
"UserActionIdentifier": "BackupWithholding_191945_C6WGT11",
"ProductId": "SAVINGS.SALARY.INFINITY"
}
],
"opstatus": 0,
"httpStatusCode": 0
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
AbandonRetailOriginationApplication
| Description: | Whenever cancel opportunity event is raised from Sales Force, this API updates the application status as Abandoned. |
| Method: | POST |
| URL: | <BASE URI>/services/data/v1/OnBoarding/operations/Application/abandonRetailOriginationApplication |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters applicationId Specifies the unique ID of the application {
"applicationId": "6CBPNMV"
}
|
| Response: |
Success Response:
{
"opstatus": 0,
"message": "Application abandoned successfully",
"httpStatusCode": 200
}
Error Responses:
{
"dbpErrCode":"73007",
"opstatus":0,"dbpErrMsg":"id field in Application can't be missing or empty",
"Exception ":"com.temenos.onboarding.errorhandling.OnBoardingException",
"httpStatusCode":0
}
{
"dbpErrCode":"78009",
"opstatus":0,"dbpErrMsg":"Submitted application cannot be abandoned",
"Exception ":"com.temenos.onboarding.errorhandling.OnBoardingException",
"httpStatusCode":0
}
{
"dbpErrCode":"78011",
"opstatus":0,"dbpErrMsg":"Application already abandoned",
"Exception ":"com.temenos.onboarding.errorhandling.OnBoardingException",
"httpStatusCode":0
}
|
| Error Code(s): |
|
ApplyForCreditCardService
| Description: | This service is used to create credit card (DBXDB card table). This is an orchestration service provisioning as an enabler to create such accounts on the 3rd party system and is invoked from redhat workflow. | |||||
| Method: | POST | |||||
| URL: | {baseUrl}/services/CreditCardOrchestration/ApplyForCreditCardService | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters applicationId Specifies the unique ID of the application ProductRef Specifies the product reference name CreditLimit Specifies the maximum credit limit given for the account. {
"ApplicationId": "WVDSSYUS",
"ProductRef": " INFINITY.ADAMANTIUM.CARD ",
"CreditLimit": "200"
}
|
|||||
| Response: | {
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
uploadDocument
| Description: | Enables uploading and storing of a document in the Document microservice. | |||||
| Method: | POST | |||||
| URL: | {baseUrl}/services/data/v1/DocumentStorageObjects/operations/DocumentStorage/uploadDocument | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters authorization(Mandatory) Authorization token is generated specifically for providing authentication to perform DocumentMicroservice operations, with the user having an entitlement added in the Entitlement MS with role as DocumentOwner. documentName(Mandatory) name of the document version(Mandatory) Specifies the version 1.0 documentGroup (Mandatory) Provides authentication by uniquely identifying a group of documents. referenceId (Mandatory) Specifies the referenceId against which the document is uploaded category (Not Mandatory) Determines the category of the document ownerSystemId (Mandatory) Uniquely determines the owner system ID for Origination application content (Mandatory) Specifies the valid Base64 encoded document content
{
"authorization":"eyJraWQiOiJLQTAxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhdWQiOiJkb2N1bWVudHMiLCJzdWIiOiIyMDA5NTIxMDkwIiwicm9sZUlkIjoi...",
"documentName": "attachment.pdf",
"version": "1.0",
"documentGroup":"journey-retail-onboarding-ZZ8LXWQ",
"referenceId": "ZZ8LXWQ_IncomeDocument",
"category": "userActions",
"ownerSystemId":"retail-onboarding",
"content":"JVBERi0xLjQNCiX/////DQoxIDAgb2JqDQo8PC9QYWdlcyAyIDAgUiAvVHlwZSAvQ2F0YWxvZyAvVmVyc2lvbiAvMS40Pj4NCmVuZG9iag0KMiAwIG9iag0KPDwvQ291bnQgMSAvS2lkcyBbNCAwIFJdIC9UeXBlIC9QYWdlcz4+DQplbmRvYmoNCjMgMCBvYmoNCjw8L0ZvbnQgPDwvRjAgNSAwIFI+Pj4+DQplbmRvYmoNCjQgMCBvYmoNCjw8L0NvbnRlbnRzIDcgMCBSIC9NZWRpYUJveCBbMCAwIDU5NS4yNzYgODQxLjg5XSAvUGFyZW50IDIgMCBSIC9SZXNvdXJjZXMgMyAwIFIgL1R5cGUgL1BhZ2U+Pg0KZW5kb2JqDQo1IDAgb2JqDQo8PC9CYXNlRm9udCAvQXJp..."
}
|
|||||
| Response: |
Success Response:
{
"opstatus": 0,
"documentId": "97c5a2a5-692d-4c28-b945-4ce4383728aa",
"message": "Document uploaded successfully",
"httpStatusCode": 200
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
AddEntitlementsOperation
| Description: | Automatically triggered by ODMS on successful updation of PartyId or CIF, and application creation to add an entitlement for the current user | |||||
| Method: | POST | |||||
| URL: | {baseUrl}/services/OnBoardingJavaServices/AddEntitlementsOperation | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters body(Mandatory) context(Mandatory)
{
"body": "{\"eventType\":\"CIF_LINKED\",\"entityDefinitionCode\":\"onboarding\",\"entityItemDefinitionName\":\"MetaData\",\"entityItemId\":\"607469cd8530237c0b6ca7cf\",\"key\":\"W6DRWRC\",\"name\":\"MetaData\",\"type\":\"JSON\",\"userType\":\"MetaData\",\"version\":2}",
"context": "{\"applicationId\":\"W6DRWRC\"}"
}
|
|||||
| Response: |
Success Response:
{
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Service Flow: |
|
AddEntitlementbyUserId
| Description: | Adds an entitlement based on the user Id. | |||||
| Method: | POST | |||||
| URL: | {baseUrl}/services/EntitlementAPIs/AddEntitlementByUserId | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters userId Specifies the unique ID of the application entitlements JSONArray consisting of information regarding the resourceFilter, resourceCategory and role to be assigned to the given userId. {
"userId": "2009521090",
"entitlements": [
{
"resources": [
{
"roles": [
"DocumentOwner"
],
"resourceFilter": "documentGroup=journey-retail-onboarding",
"resourceCategory": "document"
}
]
}
]
}
|
|||||
| Response: |
Success Response:
{
"userId": "2009521090",
"entitlements": [
{
"resources": [
{
"roles": [
"DocumentOwner"
],
"resourceFilter": "documentGroup=journey-retail-onboarding",
"resourceCategory": "document"
}
]
}
]
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
UpdateCustomerDetailsOnboarding
| Description: | This service is used to update Party microservice and/or Temenos Transact depending on the business outcome deployed. | |||||
| Method: | POST | |||||
| URL: | {BASE_URL}/services/data/v1/RBObjects/operations/User/updateCustomerDetailsOnboarding | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters Status (Mandatory) Status of customer (ACTIVE/PROSPECT) FirstName First name of customer LastName Last name of customer dateOfBirth Date of birth of customer TaxId Tax id of customer partyID id of customer from party microservice coreCustomerId id of customer from Transact startDate date on which application was created phoneNumbers Telephone contact details of customer Addresses address details of customer EmailIds Email address of customer Identities Identity details of customer
//Sample
{
"status": "ACTIVE",
"phoneNumbers": "[{'Extension':'Personal','phoneNumber':'1232321213','phoneCountryCode':' 91','isPrimary':'1'}]",
"Addresses": "[{'addrLine2':'PeachTree Place','City_id':'Atlanta','Region_id':'GA','ZipCode':'30318','isPrimary':'1','Addr_type':'ADR_TYPE_CURRENT','addrLine1':'222333'}]",
"EmailIds": "[{'Extension':'Personal','isPrimary':'1','value':'example@temenos.com'}]",
"identities": "[{'IdentityType':'Driver License','ExpiryDate':'12-12-2023','IssuingState':'','issueDate':'','IssuingCountry':'','IdentityNumber':'12345'}]",
"FirstName": "John",
"LastName": "Jonzz",
"dateOfBirth": "02-02-1975",
"TaxId": "33333333",
"partyID": "",
"startDate": "06-26-2020",
"coreCustomerID": "101280"
}
|
|||||
| Response: |
Response
{
"status": "Operation successful",
"opstatus": 0,
"httpStatusCode": 0
}
Error Response
{
"opstatus": 0,
"httpStatusCode": 400,
"dbpErrCode": "10218",
"dbpErrMessage": " dbxCustomer update failed",
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
createAccount
| Description: | This service is used to create account in Temenos Transact. | |||||
| Method: | POST | |||||
| URL: | {BASE_URL}/services/data/v1/RBObjects/operations/Accounts/createOnboardingAccount | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters applicantCif Core customer id of applicant coApplicantCif Core customer id of co-applicant productId product id selected by applicant productLine Product line which selected product id belongs to currencyId currency for which account must be created in companyId branch reference of transact where account must be created in {
"applicantCif": "100100",
"coApplicantCif": "",
"productId": "SAVINGS.SALARY.INFINITY",
"productLine": "ACCOUNTS",
"currencyId": "USD",
"companyId": "GB0010001"
}
|
|||||
| Response: |
Response
{
"accountId":"70012"
}
Error Response
{
"dbpErrCode":"4000",
"dbpErrMsg":"Account creation failed"
}
{
"dbpErrCode":"E-96024",
"dbpErrMsg":"Product not for sale"
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
In this topic
