| Bookmark Name | Actions |
|---|
Infinity Onboarding
| API | Description | Introduced In |
|---|---|---|
| updateIdentityInfo | This API allows the user to update the Identity information section. | 2020.04 |
| getIdentityInfo | This API allows the user to fetch the Identity information section. | 2020.04 |
| updateAddressInfo | This API allows the user to update the address information section. | 2020.04 |
| getAddressInfo | This API allows the user to fetch the address information section. | 2020.04 |
| getAddressSuggestions | This API fetches the address suggestions. | 2020.04 |
| getFormattedAddress | This API fetches the street, city, country and zip code of the applicant. | 2020.04 |
| updatePersonalInfo | This API allows the user to update the personal information section. | 2020.04 |
| getPersonalInfo | This API allows the user to fetch the personal information. | 2020.04 |
| getProductSelection | This API fetches the selected products from Journey Manager. | 2020.04 |
| updateProductSelection | This API updates the selected products to Journey Manager; and the ProductIDs in Infinity. | 2020.04 |
| requestOTP | This API is used to request the application to send a One Time Password (OTP). | 2020.04 |
| verifyOTP | This API is used to validate the One Time Password (OTP) sent by the application. | 2020.04 |
| createApplication | This API creates an application in the Journey Manager. | 2020.04 |
| updateApplication | This API updates the application from Journey Manager. | 2020.04 |
| executeIDV | This API executes identity verification of an applicant. This API might return questions that a user will have to answer. | 2020.04 |
| verifyIDVResponse | This API verifies the responses or answers, of a user for their Identity verification questions. | 2020.04 |
| submitOnBoardingApplication | This API invokes the rules engines with individual decision of Applicant and Co-Applicant to obtain the ApplicationStatus. After the API obtains the individual descisions it submits the application to Journey Manager. | 2020.04 |
| sendResumeMail | This API sends a mail with an application id and a resume link as soon as the user closes his/her application. | 2020.04 |
| getProductList | This API retrieves the list of products from the Marketing Catalog microservice. | 2020.04 |
| decryptresumeLink | This API retrieves and de-crypts the URL for resuming the application. | 2020.04 |
| fetchConfigurations | This API retrieves the configurations from the Spotlight app. | 2020.04 |
| getMembershipEligibilityCriteriaList | This API retrieves the eligibility criteria list from the Spotlight app. | 2020.04 |
| getTermsAndConditionsConfigs | This API retrieves the URL for Terms and Conditions. | 2020.04 |
| getCountries | This API retrieves the list of countries from the Spotlight app. | 2020.04 |
| getRegions | This API retrieves the list of regions from the Spotlight app. | 2020.04 |
| isSharedTokenValid | This API verifies whether the CSR request is authorized a for new customer. | 2020.04 |
| VerifyDocuments | This API retrieves the uploaded/scanned doc details. | 2020.04 |
| getProductGroupsWithPurpose | This API fetches the list of product groups. The product groups are displayed as cards on the landing page and the hamburger menu. | 2020.07 |
| getProductsFromProductGroup | This API fetches the list of products that are part of a product group. The list is displayed on the frmProductGroup page | 2020.07 |
| getProductDetails | This API fetches 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. | 2020.07 |
| createFunding | This API creates a Funding application in the Journey Manager (a separate JS module in the Journey manager). The data that is passed to the Journey Manager includes the parent application id. | 2020.07 |
| updateFundingStatus | This API updates the status of the Funding application in the Funding module of the Journey Manager. The possible values for the funding status are Initiated, OptedOut, and Opted. | 2020.07 |
| getProductsSelected | This API retrieves the product that is selected by the user based on the application id. The product is retreived from the customer application and the Party backend system. | 2020.07 |
| updateFundingType | This API updates the Funding type. The possible for the funding type are Inter and Intra. | 2020.07 |
| updateFundingAllocation | This API updates the Funding allocation products and the amount provided by the user. | 2020.07 |
| getFundingType | This API fetches the Funding type that is set by the user. | 2020.07 |
| updatePaymentDetails | This API updates the payment details for the funding request. The payment details include account type, debit account number, routing number, currency and so on. | 2020.07 |
| getFundingProducts | This API 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. | 2020.07 |
| getProductSelectionHierarchy | This API fetches the products hierarchy data from the Journey Manager. | 2020.07 |
| updateProductSelectionHierarchy | This API updates the products hierarchy data in the Journey Manager. | 2020.07 |
| getProductsForPurpose | This API fetches the list of products for the given purpose from Marketing Catalog Microservice. | 2020.07 |
| getFeaturesForProducts | The API fetches the list of features that must be fetched for the given product IDs from the Marketing Catalog Micro Service. | 2020.07 |
| createProspectProfile | This API creates a prospect for an applicant and updates the prospect's personal information in Journey Manager. | 2020.07 |
| updatePropsectProfile | This API updates the personal information of the prospect in the Journey Manager. | 2020.07 |
| createCoApplicant | This API creates a prospect for the co-applicant and saves the prospect's personal information in the Journey Manager. | 2020.07 |
| getJMApplicationData | This API retrieves the Journey Manager application data, | 2020.07 |
| signoutOnboardingApplication | This API captures the audit logs at the time of logout and idle time out. | 2020.07 |
| updateLastEditedSection | This API updates the last Edited section in the Onboarding application. | 2020.07 |
| updateApplicationStatus | This API updates the decision of the application from the workspace. | 2020.10 |
| getAllCDPlansForProduct | This API fetches all the CD plans for product. | 2020.10 |
| createUserAndLogin | This API creates a user in the application and performs a server log-in. | 2020.10 |
updateIdentityInfo
| Description: | This API allows the user to update the Identity information section. | ||||||
| Method: | POST | ||||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/IdentityInfo/updateIdentityInfo | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters 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. ApplicantType Specifies the type of applicant such as general applicant or co-applicant. Application_id Specifies the Journey Manager tracking ID. DateOfBirth Specifies the date of birth of the user. {
"TaxIdNum": "123456789000",
"IdType": "License",
"IdNum": "945cwf5678",
"IssuedCountry": "USA",
"IssuedState": "Texas",
"IssuedDate": "1993-23-04",
"ExpirationDate": "1200-01-01",
"ApplicantType": "Applicant",
"Application_id": "5Y78JLZ",
"DateOfBirth": "1975-02-02"
}
|
||||||
| Response: | {
"httpStatusCode": 200,
"opstatus": 0
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getIdentityInfo
| Description: | This API allows the user to fetch the Identity information section. | |||||
| 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. Application_id Specifies the Journey Manager tracking ID. 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: | This API allows the user to update the address information section. | ||||||
| Method: | POST | ||||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/IdentityInfo/updateAddressInfo | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters 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. ApplicationType Specifies the type of applicant. Application_id Specifies the Journey Manager tracking ID. DateOfBirth Specifies the date of birth of the applicant. {
"AddressLine1": "AddressLine 1 ",
"AddressLine2": "AddressLine 2",
"City": "qwer",
"State": "Texas",
"Country": "USA",
"Zipcode": "12345",
"ApplicantType": "Applicant",
"Application_id": "5Y78JLZ",
"DateOfBirth": "1975-02-02"
}
|
||||||
| Response: | {
"opstatus":0,
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getAddressInfo
| Description: | This API is a client saving service that fetches the address info section. | |||||
| 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 Journey Manager tracking ID. 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: | This API fetches the address suggestions. | |||||
| 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: | This API fetches the street, city, country and the zip code of the applicant. | |||||
| 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: | This API allows the user to update the personal information section. | ||||||
| Method: | POST | ||||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/PersonalInfo/updatePersonalInfo | ||||||
| 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 address of the applicant. MobileCountryCode Specifies the mobile country code. MobileNumber Specifies the mobile 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. Application_id Specifies the Journey Manager tracking ID. //Applicant Case
{
"FirstName": "Logesh",
"LastName": "R",
"DateOfBirth": "23-04-1993",
"Email": "logeshr321@gmail.com",
"MobileCountryCode": "+1",
"MobileNumber": "9867899876",
"ApplicantType": "Applicant",
"Application_id": "GTA231",
"Party_id": "2003527400"
}
//Co-Applicant Case
{
"FirstName": "Logesh",
"LastName": "R",
"DateOfBirth": "23-04-1993",
"Email": "logeshr321@gmail.com",
"MobileCountryCode": "+1",
"MobileNumber": "9867899876",
"ApplicantType": "CoApplicant01",
"Application_id": "GTA231",
"Party_id": "2003527400"
}
|
||||||
| Response: | {
"httpStatusCode": 200,
"opstatus": 0
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getPersonalInfo
| Description: | This API allows the user to fetch the personal information. | |||||
| Method: | POST | |||||
| URL: | {base_url}/services/data/v1/OBLocationsObjServices/operations/Locations/getFormattedAddress | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters ApplicantType (Mandatory) Specifies the type of applicant. Application_id (Mandatory) Specifies the Journey Manager tracking ID. 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 Journey Manager tracking ID. {
"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: | This API fetches all the selected products from Journey Manager. | |||||
| 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 Journey Manager tracking ID. {
"Application_id": "JLV95SP"
}
|
|||||
| Response: |
Parameters /ProductCurrency Specifies the currency in which the product is sold. /ProductID Specifies the product ID. /ProductName Specifies the name of the product. /Application_id Specifies the Journey Manager tracking ID. {
"ProductCurrency1":"PC1",
"ProductCurrency2":"PC2",
"ProductCurrency3":"PC3",
"Application_id":"JLV95SP",
"ProductID4":"PI4",
"ProductCurrency4":"PC4",
"ProductID5":"PI5",
"ProductCurrency5":"PC5",
"ProductID2":"PI2",
"ProductID3":"PI3",
"ProductID1":"PI1",
"ProductName2":"PN2",
"ProductName3":"PN3",
"ProductName4":"PN4",
"ProductName5":"PN5",
"opstatus":0,"ProductName1":"PN1",
"httpStatusCode":0
}
|
|||||
| Error Code(s): |
Error Code: 73400 |
|||||
| Service Flow: |
|
updateProductSelection
| Description: | This API updates the selected products to Journey Manager; and the ProductIDs to Infinity. | ||||||
| Method: | POST | ||||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/ProductSelection/updateProductSelection | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters ProductCurrency Specifies the currency in which the product is sold. ProductID Specifies the product ID. ProductName Specifies the name of the product. Application_id Specifies the Journey Manager tracking ID. {
"Application_id": "JLV95SP",
"ProductID1":"PI1",
"ProductID2":"PI2",
"ProductID3":"PI3",
"ProductID4":"PI4",
"ProductID5":"PI5",
"ProductName1":"PN1",
"ProductName2":"PN2",
"ProductName3":"PN3",
"ProductName4":"PN4",
"ProductName5":"PN5",
"ProductCurrency1":"PC1",
"ProductCurrency2":"PC2",
"ProductCurrency3":"PC3",
"ProductCurrency4":"PC4",
"ProductCurrency5":"PC5"
}
|
||||||
| Response: | {
"httpStatusCode": 200,
"opstatus": 0
}
|
||||||
| Error Code(s): |
Error Code: 73200 |
||||||
| Service Flow: |
|
requestOTP
| Description: | This API is used to request the application to send a One Time Password (OTP). | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/MessagingObjectService/operations/OTP/requestOTP | ||||
| Security Level: | Authorized App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters Phone Specifies the phone number. {
"Phone": "+919705263959"
}
|
||||
| Response: |
Parameters /securityKey Specifies the security required during verification. {
"opstatus": 0,
"securityKey": "6f873df4-bdc4-41e2-b1b4-2533ff11fd74",
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
Error Code: 10059 |
||||
| Service Flow: |
|
verifyOTP
| Description: | This API is used to validate the One Time Password (OTP) sent by the application. | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/MessagingObjectService/operations/OTP/verifyOTP | ||||
| Security Level: | Authorized App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters Otp Specifies the value of the OTP. securityKey Specifies the security key required for verification. {
"Otp":"123456"
"securityKey":"6f873df4-bdc4-41e2-b1b4-2533ff11fd74"
}
|
||||
| Response: | {
"opstatus": 0,
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
Error Code: 10074 |
||||
| Service Flow: |
|
executeIDV
| Description: | This API executes identity verification of an applicant. This API might return questions that a user must answer. | ||||
| 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. Application_id (Mandatory) Specifies the Journey Manager tracking ID. 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 Journey Manager tracking ID. /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: | This API verifies the response or the answers, of a user for their Identity verification questions. | ||||
| 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 Journey Manager tracking ID. 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: | This API is a service that creates an application in the Journey Manager. | |||||||
| Method: | POST | |||||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/Application/createApplication | |||||||
| Security Level: | Anonymous App User | |||||||
| Header Request: |
|
|||||||
| Body Request: |
Parameters StartDate Specifies the start date. {
"StartDate": "2020-04-08"
}
|
|||||||
| 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. {
"Endpoint": "https://eventconsumer-dot-transact-ti-test.appspot.com/_ah/api",
"AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpbnNpZ2h0cy5hdm9rYS5jb20vRm9ybVJlcXVlc3QiOnsicmVxdWVzdEtleSI6bnVsbCwiY3VzdG9tZXJJZCI6IkF2b2thIiwidG1JbnN0YW5jZUlkIjoiNzhlZmRlZjhjYjFiYzI2MmZiYTE4ZTU2OTljNGJiYTIiLCJvcmdJZCI6NCwic3BhY2VJZCI6NywiZm9ybUlkIjoyNywiZm9ybVZlcnNpb25JZCI6MzUsImZvcm1UcmFuc2FjdGlvbklkIjo4OTkwLCJzZXNzaW9uSWQiOjQzNzE5LCJqb2JJZCI6LTEsImpvYlN0ZXBJZCI6LTEsImpvYkFjdGlvbklkIjotMX0sImV4cCI6MTU4NjQ5MzIxOSwiaWF0IjoxNTg2MzIwNDE5fQ.3CTW2Yg0fOQvupvhnoHGBD3eBfY8lkAZSv2164V-Pt0",
"RequestUrl": [
{
"#cdata-section": "https%3A%2F%2Femea-infinity-dev.imf.avoka-transact.com%2Finfinity%2Fapp%2F%3Fnull"
}
],
"StartTime": "1586320419024",
"Enabled": "true",
"opstatus": 0,
"id": "2FZ9NLJ",
"AddressHash": "6f94389d4b37b70878e23b7fafe9ded223843f3721b3f9f861f4449437763bbc",
"httpStatusCode": 0
}
|
|||||||
| Error Code(s): |
|
|||||||
| Service Flow: |
|
updateApplication
| Description: | This API invokes the rules engines with the individual decision of the applicant and co-applicant to obtain the ApplicationStatus. After the API obtains the individual decisions it submits the application to the Journey Manager. | ||||||
| Method: | POST | ||||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/Application/updateApplication | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters id Specifies the id of the application. isExistingCustomer Specifies whether the applicant is an existing customer. isConsentAccepted Specifies whether the consent is accepted by the applicant. CoApplicantCount Specifies the number of co-applicants. EligibilityCriteria Specifies the eligibility criteria for the applicant. currentSectionProgressStatus Specifies the status for the update process. {
"IsExistingCustomer": "No",
"IsConsentAccepted": "Yes",
"id": "69WQLSV",
"CoApplicantCount": 1,
"currentSectionProgressStatus": "Done"
}
|
||||||
| Response: |
Parameters /id Specifies the application id. {
"opstatus": 0,
"id": "69WQLSV",
"httpStatusCode": 0
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
submitOnBoardingApplication
| Description: | This API is a service that creates an application in the Journey Manager. | ||||||||
| 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 Journey Manager tracking ID. DateOfBirth Specifies the date of birth of the applicant.
{
"Application_id":"6FNB6CN",
"DateOfBirth":"1975-01-01"
}
|
||||||||
| Response: |
Parameters /Status Specifies the status of the application. /opstatus_SubmitOnBoardingApplicationOperation Specifies the opstatus of the SubmitOnBoardingApplication operation. /opstatus_GetApplicationIDVDecisions Specifies the opstatus of the GetApplicationIDVDecisions. /ApplicantStatus [] Specifies the array of status information of the applicant. /ApplicantStatus/ApplicantType Specifies the type of applicant. /ApplicantStatus/Decision Specifies the decision of the applicant. {
"Status": "UnderReview",
"opstatus": 0,
"opstatus_SubmitOnBoardingApplicationOperation": 0,
"opstatus_GetApplicationIDVDecisions": 0,
"httpStatusCode": 0,
"ApplicantStatus": [
{
"ApplicantType": "Applicant",
"Decision": "Under Review"
},
{
"ApplicantType": "CoApplicant",
"Decision": ""
}
]
}
|
||||||||
| 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 Journey Manager tracking ID. 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: |
|
getProductList
| Description: | This API retrieves the list of products from the Marketing Catalog microservice. | |||||
| Method: | POST | |||||
| URL: | {base_url}/services/data/v1/OnBoarding/operations/ProductSelection/getProductList | |||||
| Security Level: | Anonymous App User | |||||
| Header Request: |
|
|||||
| Body Request: | Not Required | |||||
| Response: |
View the Response Parameters
items [ ] A list that contains information about different products. Parameters items/marketingItems Specifies the list of all the marketing items. items/productItem Specifies the information about a product item. items/productItem/fees Specifies the details about fee amount and fee balance. items/productItem/fees/feeAmount Specifies the total fee amount. items/productItem/fees/feeBalance Specifies the total fee balance. items/productItem/currencyId Specifies the ID of the currency, such as USD. items/productItem/productId Specifies the ID of the product, such as Vehicle loan. items/productItem/creditInterest Specifies the details about the type of interest, interest rate, minimum balance, and maximum balance. items/productItem/creditInterest/interestMaximumBalance Specifies the maximum balance for credit interest. items/productItem/creditInterest/interestMinimumBalance Specifies the minimum balance for credit interest. items/productItem/creditInterest/interestType Specifies the interest type for credit interest. items/productItem/creditInterest/interestRate Specifies the interest rate for credit interest. items/productItem/productGroupId Specifies the ID of the product group, such as Personal loans. items/productItem/productLineId Specifies the ID of the product line, such as Lending. items/productItem/purposes Specifies the purpose of the particular product. items/productItem/productName Specifies the name of the particular product. items/productItem/status Specifies the status for the product item, such as Active. items/productItem/productLineDisplayName Specifies the product line display name. items/productItem/productGroupDisplayName Specifies the product group display name. items/productItem/productDescription Specifies the product description. View the Response Sample Code
{
"items": [
{
"marketingItems": {},
"productItem": {
"fees": {
"feeAmount": 3,
"feeFrequency": "e0Y e0M e0W e0D eLQUATF"
},
"currencyId": "USD",
"productId": "SAVINGS.ACCOUNT",
"creditInterest": {
"interestMaximumBalance": 25000,
"interestMinimumBalance": 25000,
"interestType": "BAND",
"interestRate": 0.5
},
"productGroupId": "SAVINGS.ACCOUNTS",
"productLineId": "ACCOUNTS",
"purposes": [
"Onboarding"
],
"productName": "Savings Account",
"status": "Active",
"productLineDisplayName": "Accounts",
"productGroupDisplayName": "Savings Accounts",
"productDescription": "Realize your savings goals with a personal account that offers a competitive interest rate on your balance"
}
},
{
"marketingItems": {},
"productItem": {
"fees": {
"feeAmount": 10,
"feeFrequency": "e0Y e1M e0W e0D e0F"
},
"currencyId": "USD",
"debitInterest": {
"interestType": "BAND",
"interestRate": 2
},
"productId": "PREFER.ACCOUNT",
"creditInterest": {
"interestType": "SINGLE",
"interestRate": 0
},
"productGroupId": "CURRENT.ACCOUNTS",
"productLineId": "ACCOUNTS",
"purposes": [
"Onboarding"
],
"productName": "Current Account (Preferred)",
"status": "Active",
"productLineDisplayName": "Accounts",
"productGroupDisplayName": "Current Accounts",
"productDescription": "A free account for everyone! With no minimum balance or monthly service charge after opening your account."
}
},
{
"marketingItems": {},
"productItem": {
"fees": {
"feeAmount": 35
},
"currencyId": "USD",
"debitInterest": {
"interestType": "BAND",
"interestRate": 2
},
"productId": "PREMIUM.ACCOUNT",
"creditInterest": {
"interestType": "SINGLE",
"interestRate": 0
},
"productGroupId": "CURRENT.ACCOUNTS",
"productLineId": "ACCOUNTS",
"purposes": [
"Onboarding"
],
"productName": "Current Account (Premium)",
"status": "Active",
"productLineDisplayName": "Accounts",
"productGroupDisplayName": "Current Accounts",
"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"
}
},
{
"marketingItems": {},
"productItem": {
"fees": {
"feeAmount": 5
},
"currencyId": "USD",
"productId": "PREF.SAVINGS.ACCOUNT",
"creditInterest": {
"interestType": "SINGLE",
"interestRate": 0
},
"productGroupId": "SAVINGS.ACCOUNTS",
"productLineId": "ACCOUNTS",
"purposes": [
"Onboarding"
],
"productName": "Preferred Savings Account",
"status": "Active",
"productLineDisplayName": "Accounts",
"productGroupDisplayName": "Savings Accounts",
"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"
}
},
{
"marketingItems": {},
"productItem": {
"fees": {
"feeAmount": 5
},
"currencyId": "USD",
"debitInterest": {
"interestType": "BAND",
"interestRate": 2
},
"productId": "STUDENT.ACCOUNT",
"creditInterest": {
"interestType": "SINGLE",
"interestRate": 0
},
"productGroupId": "CURRENT.ACCOUNTS",
"productLineId": "ACCOUNTS",
"purposes": [
"Onboarding"
],
"productName": "Current Account (Student)",
"status": "Active",
"productLineDisplayName": "Accounts",
"productGroupDisplayName": "Current Accounts",
"productDescription": "A variable interest rate account that earns competitive interest and has no minimum balance or monthly service charge after you open it."
}
}
]
}
|
|||||
| Error Code(s): | None | |||||
| Service Flow: |
|
decryptresumeLink
| Description: | This API retrieves and de-crypts the URL for resuming the application. | ||||||
| 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 Journey Manager tracking ID. {
"decryptedUrl":"X6W6JTS110",
"userType":"NEW_USER",
"applicationId":"X6W6JTS"
}
|
||||||
| Error Code(s): | None | ||||||
| Service Flow: |
|
fetchConfigurations
| Description: | This API retrieves the configurations from the Spotlight app. | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/OnBoardingConfigurations/operations/BundleConfigurations/fetchConfigurations | ||||
| Security Level: | Anonymous App User | ||||
| 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": "NUO",
"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
{
"opstatus":0,"Configurations":[
{
"isPreLoginConfiguration":"true",
"bundle_id":"NUO_CONFIG_BUNDLE",
"description":"Default account type",
"bundle_name":"NUO",
"type":"PREFERENCE",
"app_id":"NUO",
"value":"6",
"configuration_id":"114",
"key":"ACCOUNT_TYPE",
"target":"CLIENT"
}
,
{
"isPreLoginConfiguration":"true",
"bundle_id":"NUO_CONFIG_BUNDLE",
"description":"Default country code",
"bundle_name":"NUO",
"type":"PREFERENCE",
"app_id":"NUO",
"value":"India",
"configuration_id":"100",
"key":"COUNTRY_CODE",
"target":"CLIENT"
}
,
{
"isPreLoginConfiguration":"true",
"bundle_id":"NUO_CONFIG_BUNDLE",
"description":"Currency format for decimals",
"bundle_name":"NUO",
"type":"PREFERENCE",
"app_id":"NUO",
"value":"Period",
"configuration_id":"111",
"key":"CURRENCY_FORMAT_DECIMALS",
"target":"CLIENT"
}
,
{
"isPreLoginConfiguration":"true",
"bundle_id":"NUO_CONFIG_BUNDLE",
"description":"Currency format for thousands",
"bundle_name":"NUO",
"type":"PREFERENCE",
"app_id":"NUO",
"value":"Comma",
"configuration_id":"110",
"key":"CURRENCY_FORMAT_THOUSANDS",
"target":"CLIENT"
}
,
{
"isPreLoginConfiguration":"true",
"bundle_id":"NUO_CONFIG_BUNDLE",
"description":"Config for Data Validation of NUO objects",
"bundle_name":"NUO",
"type":"PREFERENCE",
"app_id":"NUO",
"value":"
{
"PersonalInfo":
{
"FirstName":"FIRSTNAME",
"LastName":"LASTNAME",
"Age":"MINOR_AGE",
"Email":"EMAIL",
"MobileNumber":"MOBILE_NUMBER"
}
,"IdentityInfo":
{
"IdNum":"ID_ALPHANUMERIC",
"IssuedCountry":"NAME",
"IssuedState":"NAME"
}
,"AddressInfo":
{
"Country":"NAME",
"State":"NAME",
"Zipcode":"ZIPCODE"
}
}
",
"configuration_id":"116",
"key":"DATA_VALIDATION_NUO",
"target":"CLIENT"
}
,
{
"isPreLoginConfiguration":"true",
"bundle_id":"NUO_CONFIG_BUNDLE",
"description":"Date format",
"bundle_name":"NUO",
"type":"PREFERENCE",
"app_id":"NUO",
"value":"MM/DD/YYYY",
"configuration_id":"105",
"key":"DATE_FORMAT",
"target":"CLIENT"
}
,
{
"isPreLoginConfiguration":"true",
"bundle_id":"NUO_CONFIG_BUNDLE",
"description":"OTPModulePresent",
"bundle_name":"NUO",
"type":"PREFERENCE",
"app_id":"NUO",
"value":"true",
"configuration_id":"126",
"key":"OTPModulePresent",
"target":"CLIENT"
}
,
{
"isPreLoginConfiguration":"true",
"bundle_id":"NUO_CONFIG_BUNDLE",
"description":"Scan Upload Doc ",
"bundle_name":"NUO",
"type":"PREFERENCE",
"app_id":"NUO",
"value":"true",
"configuration_id":"120",
"key":"SCAN_UPLOAD_DOC",
"target":"CLIENT"
}
],"httpStatusCode":200
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
getMembershipEligibilityCriteriaList
| Description: | This API retrieves the eligibility criteria list from the Spotlight app. | ||||
| 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: | This API retrieves the URL for Terms and Conditions from the Spotlight app. | ||||
| 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 Onboarding 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: | This API 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: | This API 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: | This API 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 Journey Manager tracking ID. 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: | This API retrieves the uploaded/scanned doc details. | ||||
| Method: | POST | ||||
| URL: | {base_url}/services/data/v1/IdologyScanObjectServices/operations/Documents/verifyDocuments | ||||
| Security Level: | Anonymous App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters 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. {
"documentType": "Passport",
"frontImage64": "...",
"backImage64": "..."
}
NOTE: The parameters change based on the type of document.. If the document type is Passport, the documentType and frontImage64 parameter are required. If the mandatory parameter is License, all the three parameters are mandatory. |
||||
| Response: |
View the Response Parameters
/SystemDate Specifies the date of the system. /DocumentIssueDate Specifies the date on which the document was issued. /BirthPlace Specifies the birth place of the applicant. /Address Specifies the address of the applicant. /Sex Specifies the sex of the applicant. /NationalityCode Specifies the nationality code of the applicant. /GivenName Specifies the name of the applicant. /LicenseClass Specifies the license class of the applicant. /Salutation Specifies the salutation of the applicant. /AddressPostalCode Specifies the postal code of the applicant. /IssuerName Specifies the name of the issuer of the document. /CardVersionNumber Specifies the version number of the card. /EyeColor Specifies the eye color of the applicant. /MRZ Specifies the Machine Readable Zone. /AddressCity Specifies the city of the applicant. /Classification Specifies the classification for the document. /Race Specifies the race of the applicant. /MRZ1 Specifies the first line of the Machine Readable Zone. /ClassName Specifies the name of the class. /MRZ2 Specifies the second line of the Machine Readable Zone. /Height Specifies the height of the applicant. /DocumentName Specifies the document name. /FirstName Specifies the first name of the applicant. /IssueType Specifies the issue type of the document. /IssueDate Specifies the issue date of the document. /IssuerCode Specifies the issuer code for the document. /DocumentNumber Specifies the document number. /MiddleName Specifies the middle name of the applicant. /Weight Specifies the weight of the applicant. /AddressLine2 Specifies the second line of the applicant's address. /AddressLine1 Specifies the first line of the applicant's address. /NationalityName Specifies the name of the applicant's nationality. /LicenseRestrictions Specifies restrictions for the license. /ExpirationDate Specifies the expiration date for the license. /FullName Specifies the full name of the applicant. /Signature Specifies the signature of the applicant. /Surname Specifies the surname of the applicant. /AddressState Specifies the state of the applicant. /BirthDate Specifies the date of birth of the applicant. View the Response Sample Code
{
"SystemDate": "06/Mar/2020",
"DocumentIssueDate": "Blank",
"BirthPlace": "",
"Address": "Addressline1_2 VIZ_FieldsAddressCity,VIZ_FieldsAddressState VIZ_FieldsAddressPostalCode",
"Sex": "F",
"NationalityCode": "",
"GivenName": "MARIANA",
"LicenseClass": "",
"Salutation": "",
"AddressPostalCode": "",
"IssuerName": "Ukraine",
"CardVersionNumber": "",
"EyeColor": "",
"MRZ": "P<UKRTKACHENKO<<MARIANA<<<<<<<<<<<<<<<<<<<<<XX000000<0UKR9108242F23092571234567890<<<<70",
"AddressCity": "",
"Classification": "",
"Race": "",
"MRZ1": "P<UKRTKACHENKO<<MARIANA<<<<<<<<<<<<<<<<<<<<<",
"ClassName": "",
"MRZ2": "XX000000<0UKR9108242F23092571234567890<<<<70",
"Height": "",
"DocumentName": "",
"FirstName": "MARIANA",
"IssueType": "",
"IssueDate": "25/Sep/2013",
"IssuerCode": "Ukraine",
"DocumentNumber": "XX000000",
"MiddleName": "",
"Weight": "",
"AddressLine2": "",
"AddressLine1": "",
"NationalityName": "",
"LicenseRestrictions": "",
"ExpirationDate": "25/Sep/2023",
"FullName": "MARIANA TKACHENKO",
"Signature": "",
"Surname": "TKACHENKO",
"AddressState": "",
"BirthDate": "24/Aug/1991"
}
|
||||
| Error Code(s): |
Error Code: 1009 |
||||
| Service Flow: |
|
getProductGroupsWithPurpose
| Description: | This API fetches the list of product groups. 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: |
Parameters 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: | This API fetches 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: | This API fetches 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: | This API creates a Funding application in the Journey Manager (a separate JS module in the Journey manager). The data that is passed to the Journey Manager 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 Journey Manager tracking ID. StartDate (Mandatory/ Not Mandatory?) Specifies the date on which the funding starts. Party_id (Mandatory/ Not Mandatory?) Specifies the unique applicant ID that is associated with the Party Micro Service. CoAppParty_id (Mandatory/ Not 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 Journey 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: |
|
updateFundingStatus
| Description: | This API updates the status of the Funding application in the Funding module of the Journey Manager. The possible values for the funding status are Initiated, OptedOut, and Opted. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/Funding/updateFundingStatus | ||||||
| Security Level: | Authenticated App Users | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters Application_id (Mandatory) Specifies the Journey Manager Tracking ID. FundingApplication_id (Mandatory) Specifies the funding application ID. FundingStatus (Mandatory) Specifies the status of the funding. {
"Application_id": "GXNY5KK",
"FundingApplication_id": "HJT8ZKG",
"FundingStatus": "OptedOut"
}
|
||||||
| Response: | {
"opstatus": 0,
"httpStatusCode": 200
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getProductsSelected
| Description: | This API retrieves the product that is selected by the user based on the application id. The product is retreived from the customer application and the Party backend 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 Journey Manager Tracking ID. {
"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: |
|
updateFundingType
| Description: | This API updates the Funding type. The possible for the funding type are Inter and Intra. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/Funding/updateFundingType | ||||||
| Security Level: | Authenticated App Users | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters Application_id (Mandatory) Specifies the Journey Manager Tracking ID. FundingApplication_id (Mandatory) Specifies the funding application ID. FundingType (Mandatory) Specifies the type of funding. {
"Application_id": "DJYYMZ2",
"FundingApplication_id": "42SNH85",
"FundingType": "Inter"
}
|
||||||
| Response: | {
"opstatus": 0,
"httpStatusCode": 200
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
updateFundingAllocation
| Description: | This API updates the Funding allocation products and the amount provided by the user. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/Funding/updateFundingAllocation | ||||||
| Security Level: | Authenticated App Users | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters Application_id (Mandatory) Specifies the Journey Manager Tracking ID. FundingApplication_id (Mandatory) Specifies the ID of the funding application. FundingProduct Specifies the funding product details. This parameter is mandatory based on group mandatory FundingProduct/FundingProductId Specifies the ID of the funding product. FundingProduct/FundingCurrency Specifies the currency of the funding. FundingProduct/FundingAmount Specifies the amount of funding. NOTE: In FundingProduct, if you provide a value to atleast one of the parameters, the other two parameters also become mandatory. {
"FundingApplication_id": "2FMFXN6",
"Application_id": "875GVQR",
"FundingProducts": {
"FundingProduct": [
{
"FundingProductId": "12547",
"FundingCurrency": "USD",
"FundingAmount": "10000"
}
]
}
}
|
||||||
| Response: | {
"opstatus": 0,
"httpStatusCode": 200
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getFundingType
| Description: | This API fetches the Funding type that is set by the user. | ||||
| 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 Journey Manager Tracking ID. FundingApplication_id (Mandatory) Specifies the funding application ID. {
"Application_id": "DJYYMZ2",
"FundingApplication_id": "42SNH85"
}
|
||||
| Response: |
Parameters /FundingType Specifies the type of funding. {
"opstatus": 0,
"FundingType": "Inter",
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
updatePaymentDetails
| Description: | This API updates the payment details for the funding request. The payment details include account type, debit account number, routing number, currency and so on. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/Funding/updatePaymentDetails | ||||||
| Security Level: | Authenticated App Users | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters Application_id (Mandatory) Specifies the Journey Manager Tracking ID. FundingApplication_id (Mandatory) Specifies the Funding application ID. DebitAccount (Mandatory) Specifies the debit account number. DebitCurrency Specifies the currency of the debit account. DebitIBAN Specifies the international bank debit account number. DebitRoutingNumber Specifies the routing number for the debit account. DebitAccountType Specifies the type of the debit account. BankName Specifies the name of the bank. {
"Application_id": "3SNQQ2X",
"FundingApplication_id": "ZWWBNX7",
"DebitAccount": "1234567774",
"DebitCurrency": "USD",
"DebitIBAN": "IBAN8787",
"DebitRoutingNumber": "23555555",
"DebitAccountType": "CURRENT",
"BankName": "INFINITY"
}
|
||||||
| Response: | {
"opstatus": 0,
"httpStatusCode": 200
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getFundingProducts
| Description: | This API 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 Journey Manager Tracking ID. FundingApplication_id (Mandatory) Specifies the Funding application ID. {
"Application_id": "DJYYMZ2",
"FundingApplication_id": "42SNH85"
}
|
||||
| Response: |
Parameters /FundingProduct Specifies the details of the funding product. /FundingProduct/BankName Specifies the name of the bank. /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/FundingCurrency Specifies the currency used in funding. /FundingProduct/FundingAmount Specifies the amount of the funding. /FundingProduct/FundingProductId Specifies the ID of the funding product. /productCatalogue/DebitIBAN Specifies the International Bank Account Number of the debtor. /productCatalogue/DebitAccount Specifies the debit account number. {
"opstatus": 0,
"FundingProduct": [
{
"BankName": "",
"DebitRoutingNumber": "",
"DebitCurrency": "",
"DebitAccountType": "",
"FundingCurrency": "",
"FundingAmount": "",
"FundingProductId": "",
"DebitIBAN": "",
"DebitAccount": ""
},
{
"BankName": "",
"DebitRoutingNumber": "",
"DebitCurrency": "",
"DebitAccountType": "",
"FundingCurrency": "",
"FundingAmount": "",
"FundingProductId": "",
"DebitIBAN": "",
"DebitAccount": ""
}
],
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
getProductSelectionHierarchy
| Description: | This API fetches the products hierarchy data from the Journey Manager. | ||||
| Method: | POST | ||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/ProductSelection/getProductSelectionHierarchy | ||||
| Security Level: | Authenticated App Users | ||||
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
||||
| Body Request: |
Parameters Application_id (Mandatory) Specifies the Journey Manager tracking ID. {
"Application_id":"FZYJ85H"
}
|
||||
| Response: |
Parameters /ProgressStatus Specifies the progress in fetching the product selection hierarchy. /Products Specifies the various details of the product. /Products/Product Specifies the product and its details. /Products/Product/ProductGroupId Specifies the ID of the product group to which the product belongs. /Products/Product/ProductId Specifies the Id of the product. {
"ProgressStatus": "",
"Products": {
"Product": [
{
"ProductGroupId": "CURRENT.ACCOUNTS",
"ProductId": "STUDENT.ACCOUNT"
}
]
},
"opstatus": 0,
"httpStatusCode": 0
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
updateProductSelectionHierarchy
| Description: | This API updates the products hierarchy data in the Journey Manager. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}services/data/v1/OnBoarding/operations/ProductSelection/updateProductSelectionHierarchy | ||||||
| Security Level: | Authenticated App Users | ||||||
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
||||||
| Body Request: |
View the Request Parameters
NoOfProducts Specifies the number of products that must be updated. NOTE: The NoOfProducts parameter can be skipped in the payload. ProductIDs (Mandatory) NOTE: Specifies the ID of the products that are must be updated. NOTE: The ProductIDs parameter's value can be provided as an empty value. Products (Mandatory) Specifies the hierarchy of products and features that must be updated. Products/Product (Mandatory) Specifies the number of products that must be updated. Products/Product/ProductGroupId (Mandatory) Specifies the number of products that must be updated. Products/Product/ProductCurrencyId (Mandatory) Specifies the number of products that must be updated. Products/Product/ProductGroupDisplayName Specifies the number of products that must be updated. Products/Product/ProductName Specifies the number of products that must be updated. Products/Product/ProductId (Mandatory) Specifies the number of products that must be updated. Products/Product/AccountNumber Specifies the number of products that must be updated. Products/Product/FeatureSelection Specifies the features that are selected. Products/Product/FeatureSelection/NoOfFeatures Specifies the number of features that are selected. Products/Product/FeatureSelection/Features Specifies the various features that are associated with the product. Products/Product/FeatureSelection/Features/Feature Specifies the properties of a feature. Products/Product/FeatureSelection/Features/Feature/FeatureId Specifies the properties of a feature. Products/Product/FeatureSelection/Features/Feature/Type Specifies the type of the feature. Products/Product/FeatureSelection/Features/Feature/FeatureDescription Specifies a description about the feature. Products/Product/FeatureSelection/Features/Feature/ProductId Specifies the product that is associated with the feature. Products/Product/FeatureSelection/Features/Feature/SequenceNo Specifies the sequence number for the feature (Order of Priority). Products/Product/FeatureSelection/Features/Feature/FeatureName Specifies the name of the feature. Products/Product/FeatureSelection/Features/Feature/SelectedValue Specifies the value that is associated with the selected feature. Application_id (Mandatory) Specifies the Journey Manager Tracking ID. ProgressStatus (Mandatory) Specifies the progress status for the updating process.. currentSectionProgressStatus (Mandatory) Specifies the current progress status. NOTE: The ProgressStatus and currentSectionProgressStatus parameter are mandatory for the Roadmap module. View the Response Sample Code
{
"NoOfProducts": 1,
"ProductIDs": "SAVINGS.SALARY.INFINITY",
"Products": {
"Product": [
{
"ProductGroupId": "SAVINGS.ACCOUNTS",
"ProductCurrencyId": "USD",
"ProductGroupDisplayName": "Savings Accounts",
"ProductName": "Salary Saving Account",
"ProductId": "SAVINGS.SALARY.INFINITY",
"AccountNumber": " ",
"FeatureSelection": {
"NoOfFeatures": 1,
"Features": {
"Feature": [
{
"FeatureId": "CARD.ISSUE",
"Type": "CheckBox",
"FeatureDescription": "Carry your bank account safely wherever you go with the Debit card. And Do a lot more with your Debit Card!!",
"ProductId": "SAVINGS.SALARY.INFINITY",
"SequenceNo": 1,
"FeatureName": "Yes, I like to avail to Debit Card",
"SelectedValue": "OPT-IN"
}
]
}
}
}
]
},
"Application_id": "BPCG3FN",
"ProgressStatus": "Done",
"currentSectionProgressStatus": "Done"
}}
|
||||||
| Response: |
Parameters /ProgressStatus Specifies the progress of fetching the product selection hierarchy. /Products Specifies the various details of the products. /Products/Product Specifies the product and its details. /Products/Product/ProductGroupId Specifies the ID of the product group to which the product belongs. /Products/Product/ProductId Specifies the ID of the product. {
"ProgressStatus": "",
"Products": {
"Product": [
{
"ProductGroupId": "CURRENT.ACCOUNTS",
"ProductId": "STUDENT.ACCOUNT"
}
]
},
"opstatus": 0,
"httpStatusCode": 0
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
GetProductsForPurpose
| Description: | This API fetches the list of products for the given purpose from the Marketing Catalog Micro Service. | ||||
| 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: | The API fetches the list of features that must be fetched for the given product IDs from the Marketing Catalog Micro Service. | ||||
| 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: | This API creates a prospect for an applicant and updates the prospect's personal information in Journey Manager. | |||||||||
| Method: | POST | |||||||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/PersonalInfo/createProspectProfile | |||||||||
| 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. id (Mandatory) Specifies the applicant ID. ApplicantType (Mandatory) Specifies the type of applicant such as general applicant or co-applicant. {
"FirstName": "bnm",
"LastName": "bnm",
"DateOfBirth": "1111-11-11",
"Email": "nn@ws.com",
"MobileCountryCode": "+91",
"MobileNumber": "123467890",
"id": "69WQLSV",
"ApplicantType": "Applicant"
}
|
|||||||||
| Response: |
Parameters /Party_Id Specifies the unique ID of the Party Microservice that is generated for the applicant. {
"opstatus": 0,
"Party_id": "2018219428",
"id": "69WQLSV",
"httpStatusCode": 200
}
|
|||||||||
| Error Code(s): |
|
|||||||||
| Service Flow: |
|
updateProspectProfile
| Description: | This API updates the personal information of the prospect in the Journey Manager. | |||||||||
| 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 Journey Manager tracking ID. 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: |
|
createCoApplicant
| Description: | This API creates a prospect for the co-applicant and saves the prospect's personal information in the Journey Manager. | |||||||||
| Method: | POST | |||||||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/PersonalInfo/createCoApplicant | |||||||||
| Security Level: | Authenticated App User | |||||||||
| Header Request: |
|
|||||||||
| Body Request: |
Parameters FirstName Specifies the first name of the co-applicant. LastName Specifies the last name of the co-applicant. DateOfBirth Specifies the date of birth of the co-applicant. Specifies the email ID of the co-applicant. MobileCountryCode Specifies the mobile country code of the co-applicant. MobileNumber Specifies the mobile number of the co-applicant. ApplicantType (Mandatory) Specifies the type of applicant, such as general applicant or co-applicant. id (Mandatory) Specifies the co-applicant ID. currentSectionProgressStatus Specifies the progress status of the application. {
"FirstName": "Jones",
"LastName": "Smith",
"DateOfBirth": "2000-11-11",
"Email": "jones.smith@temenos.com",
"MobileCountryCode": "+91",
"MobileNumber": "123456789",
"ApplicantType": "CoApplicant",
"id": "7KTYMZC",
"currentSectionProgressStatus": "Done"
}
|
|||||||||
| Response: |
Parameters /CoAppParty_Id Specifies the unique ID of the Party Microservice that is generated for the co-applicant. {
"opstatus": 0,
"CoAppParty_id": "2018224351",
"httpStatusCode": 200
}
|
|||||||||
| Error Code(s): |
|
|||||||||
| Service Flow: |
|
getJMApplicationData
| Description: | This API retrieves the Journey Manager application data, | ||||
| Method: | POST | ||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/Application/getJMApplicationData | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters TrackingCode (Mandatory) Specifies the tracking code of the applicant. SaveChallengeAnswer (Mandatory) Specifies the answer for the challenge question that is date of birth. {
"TrackingCode":"27F5SBM",
"SaveChallengeAnswer":"1975-02-02"
}
|
||||
| Response: |
Parameters View the Response Parameters
/AvokaSmartForm Specifies the Avoka Smart Form details that are present in the Journey Manager application /AvokaSmartForm/SFMData Specifies the meta data. /AvokaSmartForm/SFMData/SystemProfile Specifies the system profile details that belong to the SFM data. /AvokaSmartForm/SFMData/SystemProfile/Insights Specifies the attributes of the application. /AvokaSmartForm/SFMData/SystemProfile/InsightsEndpoint Specifies the Endpoint URL of the application. /AvokaSmartForm/SFMData/SystemProfile/InsightsAccessToken Specifies the access token of the application. /AvokaSmartForm/SFMData/SystemProfile/InsightsRequestUrl Specifies the request URL of the application. /AvokaSmartForm/SFMData/SystemProfile/InsightsStartTime Specifies the start time of the application. /AvokaSmartForm/SFMData/SystemProfile/InsightsEnabled Specifies whether Journey analytics is enabled. /AvokaSmartForm/SFMData/SystemProfile/InsightsAddressHash Specifies the address hash token. /AvokaSmartForm/SFMData/SystemProfile/RevisionNumber Specifies the revision number. /AvokaSmartForm/SFMData/SystemProfile/TrackingCode Specifies the application ID for the application. /AvokaSmartForm/SFMData/SystemProfile/ReceiptNumber Specifies the receipt number. /AvokaSmartForm/Application Specifies the JM application details. /AvokaSmartForm/Application/Status Specifies the status of the application. /AvokaSmartForm/Application/StartDate Specifies the start date for the application. /AvokaSmartForm/Application/ApplicationType Specifies the type of application. /AvokaSmartForm/Application/CoApplicant Specifies the list of co-applicants. /AvokaSmartForm/Application/CoApplicant/CIF Specifies the Customer Information file of the co-applicant. /AvokaSmartForm/Application/CoApplicant/PartyID Specifies the unique co-applicant Party ID. /AvokaSmartForm/Application/CoApplicant/PersonalInfo Specifies the personal information details such as mobile number, Email ID, and so on of the co-applicant. /AvokaSmartForm/Application/CoApplicant/PersonalInfo/MobileNumber Specifies the mobile number of the co-applicant. /AvokaSmartForm/Application/CoApplicant/PersonalInfo/ProgressStatus Specifies the status. /AvokaSmartForm/Application/CoApplicant/PersonalInfo/Email Specifies the Email ID of the co-applicant. /AvokaSmartForm/Application/CoApplicant/PersonalInfo/FirstName Specifies the first name of the co-applicant. /AvokaSmartForm/Application/CoApplicant/PersonalInfo/DoB Specifies the date of birth of the co-appplicant. /AvokaSmartForm/Application/CoApplicant/PersonalInfo/LastName Specifies the last name of the co-applicant. /AvokaSmartForm/Application/CoApplicant/PersonalInfo/CountryCode Specifies the country code of the co-applicant. /AvokaSmartForm/Application/CoApplicant/IDVInfo Specifies the Insurance Declared Value (IDV) of the co-applicant. /AvokaSmartForm/Application/CoApplicant/IDVInfo/Field4 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/CoApplicant/IDVInfo/Field5 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/CoApplicant/IDVInfo/Field2 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/CoApplicant/IDVInfo/ProgressStatus Specifies the progress status of the IDV application. /AvokaSmartForm/Application/CoApplicant/IDVInfo/Field3 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/CoApplicant/IDVInfo/Field8 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/CoApplicant/IDVInfo/Field9 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/CoApplicant/IDVInfo/Field6 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/CoApplicant/IDVInfo/VendorID Specifies the ID of the insurance vendor. /AvokaSmartForm/Application/CoApplicant/IDVInfo/Field7 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/CoApplicant/IDVInfo/Field1 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/CoApplicant/IDVInfo/Decision Specifies the decision of the co-applicant. /AvokaSmartForm/Application/CoApplicant/IdentityInfo Specifies the Identity Information details of the co-applicant. /AvokaSmartForm/Application/CoApplicant/IdentityInfo/ProgressStatus Specifies the progress status for the Identity information /AvokaSmartForm/Application/CoApplicant/IdentityInfo/IssuedDate Specifies the issued date of the identity document or card. /AvokaSmartForm/Application/CoApplicant/IdentityInfo/ExpirationDate Specifies the expiration date of the identity document or card. /AvokaSmartForm/Application/CoApplicant/IdentityInfo/IssuedCountry Specifies the country name in which the identity document was issued. /AvokaSmartForm/Application/CoApplicant/IdentityInfo/TaxIdNum Specifies the tax identification number of the co-applicant. /AvokaSmartForm/Application/CoApplicant/IdentityInfo/IdNum Specifies the Identification number. /AvokaSmartForm/Application/CoApplicant/IdentityInfo/IssuedState Specifies the name of the state in which the ID has been issued. /AvokaSmartForm/Application/CoApplicant/IdentityInfo/IdType Specifies the type of ID. /AvokaSmartForm/Application/CoApplicant/AddressInfo Specifies the address information details of the co-applicant. /AvokaSmartForm/Application/CoApplicant/AddressInfo/AddressLine2 Specifies the second line of the co-applicant's address. /AvokaSmartForm/Application/CoApplicant/AddressInfo/AddressLine1 Specifies the first line of the co-applicant;s address. /AvokaSmartForm/Application/CoApplicant/AddressInfo/ProgressStatus Specifies the progress status for the address information. /AvokaSmartForm/Application/CoApplicant/AddressInfo/State Specifies the name of the state. /AvokaSmartForm/Application/CoApplicant/AddressInfo/ZipCode Specifies the zip code of the region. /AvokaSmartForm/Application/CoApplicant/AddressInfo/Country Specifies the name of the country. /AvokaSmartForm/Application/CoApplicant/AddressInfo/City Specifies the name of the city. /AvokaSmartForm/Application/EligibilityCriteria Specifies the conditions for eligibility. /AvokaSmartForm/Application/IsExistingCustomer Specifies whether the applicant is an existing customer. /AvokaSmartForm/Application/TnCFlag Specifies the status of the terms and conditions flag. /AvokaSmartForm/Application/CoApplicantCount Specifies the number of co-applicant. /AvokaSmartForm/Application/ProductSelection Specifies the selected products details. /AvokaSmartForm/Application/ProductSelection/NoOfProducts Specifies the number of products that the applicant selected. /AvokaSmartForm/Application/ProductSelection/ProgressStatus Specifies the progress status of the product selection. /AvokaSmartForm/Application/ProductSelection/Products Specifies the various products that you selected and their details. /AvokaSmartForm/Application/ProductSelection/Products/Product Specifies a product from the list. /AvokaSmartForm/Application/ProductSelection/Products/Product/ProductGroupId Specifies the ID of the group to which the product belongs. /AvokaSmartForm/Application/ProductSelection/Products/Product/ProductGroupDisplayName Specifies the display name of the product. /AvokaSmartForm/Application/ProductSelection/Products/Product/ProductCurrencyId Specifies the ID of the product currency. /AvokaSmartForm/Application/ProductSelection/Products/Product/ProductName Specifies the name of the product. /AvokaSmartForm/Application/ProductSelection/Products/Product/ProductId Specifies the ID of the product. /AvokaSmartForm/Application/ProductSelection/Products/Product/FeatureSelection Specifies the selected features of the product and their details. /AvokaSmartForm/Application/ProductSelection/Products/Product/FeatureSelection/NoOfFeatures Specifies the number of features. /AvokaSmartForm/Application/ProductSelection/Products/Product/FeatureSelection/Features Specifies the various features that are supported by the product. /AvokaSmartForm/Application/ProductSelection/Products/Product/FeatureSelection/Features/Feature Specifies a feature. /AvokaSmartForm/Application/ProductSelection/Products/Product/FeatureSelection/Features/Feature/FeatureId Specifies the ID of the feature. /AvokaSmartForm/Application/ProductSelection/Products/Product/FeatureSelection/Features/Feature/SequenceNo Specifies the sequence number of the feature. /AvokaSmartForm/Application/ProductSelection/Products/Product/FeatureSelection/Features/Feature/Type Specifies the type of the feature. /AvokaSmartForm/Application/CoApplicant/ProductSelection/Products/Product/FeatureSelection/Features/Feature/FeatureDescription Specifies a description about the feature. /AvokaSmartForm/Application/ProductSelection/Products/Product/FeatureSelection/Features/Feature/ProductId Specifies the ID of the product that uses a specific feature. /AvokaSmartForm/Application/ProductSelection/Products/Product/FeatureSelection/Features/Feature/FeatureName Specifies the name of the feature. /AvokaSmartForm/Application/ProductSelection/Products/Product/FeatureSelection/Features/Feature/SelectedValue Specifies the selected value that is associated with the feature. /AvokaSmartForm/Application/ProductSelection/Products/Product/AccountNumber Specifies the account number for the product. /AvokaSmartForm/Application/IsConsentAccepted Specifies whether consent was accepted for the product. /AvokaSmartForm/Application/LastEditedSection Specifies the name of the section that was last edited. /AvokaSmartForm/Application/LastEditedSection/ResponsiveWeb Specifies the name of the section that was last edited in Responsive web. AvokaSmartForm/Application/Applicant Specifies the list of applicants. /AvokaSmartForm/Application/Applicant/CIF Specifies the Customer Information file of the applicant. /AvokaSmartForm/Application/Applicant/PartyID Specifies the unique applicant Party ID. /AvokaSmartForm/Application/Applicant/PersonalInfo Specifies the personal information details of the applicant, such as mobile number, Email ID and so on. /AvokaSmartForm/Application/Applicant/PersonalInfo/MobileNumber Specifies the mobile number of the applicant. /AvokaSmartForm/Application/Applicant/PersonalInfo/ProgressStatus Specifies the status of the applicant's personal information. /AvokaSmartForm/Application/Applicant/PersonalInfo/Email Specifies the Email ID of the applicant. /AvokaSmartForm/Application/Applicant/PersonalInfo/FirstName Specifies the first name of the applicant. /AvokaSmartForm/Application/Applicant/PersonalInfo/DoB Specifies the date of birth of the applicant. /AvokaSmartForm/Application/Applicant/PersonalInfo/LastName Specifies the last name of the applicant. /AvokaSmartForm/Application/Applicant/PersonalInfo/CountryCode Specifies the country code of the applicant. /AvokaSmartForm/Application/Applicant/IDVInfo Specifies the Insurance Declared Value (IDV) of the applicant. /AvokaSmartForm/Application/Applicant/IDVInfo/Field4 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/Applicant/IDVInfo/Field5 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/Applicant/IDVInfo/Field2 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/Applicant/IDVInfo/ProgressStatus Specifies the progress status for the Identity information /AvokaSmartForm/Application/Applicant/IDVInfo/Field3 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/Applicant/IDVInfo/Field8 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/Applicant/IDVInfo/Field9 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/Applicant/IDVInfo/Field6 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/Applicant/IDVInfo/VendorID Specifies the ID of the insurance vendor. /AvokaSmartForm/Application/Applicant/IDVInfo/Field7 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/Applicant/IDVInfo/Field1 Specifies a data field to fill the IDV information. /AvokaSmartForm/Application/Applicant/IDVInfo/Decision Specifies the decision of the applicant. /AvokaSmartForm/Application/Applicant/IdentityInfo Specifies the Identity Information details of the applicant. /AvokaSmartForm/Application/Applicant/IdentityInfo/ProgressStatus Specifies the progress status of the identity info. /AvokaSmartForm/Application/Applicant/IdentityInfo/IssuedDate Specifies the issued date for the identity document or card. /AvokaSmartForm/Application/Applicant/IdentityInfo/ExpirationDate Specifies the expiration date for the identity document or card. /AvokaSmartForm/Application/Applicant/IdentityInfo/IssuedCountry Specifies the name of the country in which the identity document was issued. /AvokaSmartForm/Application/Applicant/IdentityInfo/TaxIdNum Specifies the tax identification number. /AvokaSmartForm/Application/Applicant/IdentityInfo/IdNum Specifies the Identification number. /AvokaSmartForm/Application/Applicant/IdentityInfo/IssuedState Specifies the name of the state in which the ID has been issued. /AvokaSmartForm/Application/Applicant/IdentityInfo/IdType Specifies the type of ID. /AvokaSmartForm/Application/Applicant/AddressInfo Specifies the address information details of the applicant. /AvokaSmartForm/Application/Applicant/AddressInfo/AddressLine2 Specifies the second line of the applicant's address. /AvokaSmartForm/Application/Applicant/AddressInfo/AddressLine1 Specifies the first line of the co-applicant;s address. /AvokaSmartForm/Application/Applicant/AddressInfo/ProgressStatus Specifies the progress status of the product selection. /AvokaSmartForm/Application/Applicant/AddressInfo/State Specifies the name of the state. /AvokaSmartForm/Application/Applicant/AddressInfo/ZipCode Specifies the zip code of a region. /AvokaSmartForm/Application/Applicant/AddressInfo/Country Specifies the name of the country. /AvokaSmartForm/Application/Applicant/AddressInfo/City Specifies the name of the city. /controlXML Specifies the XML. /revisionNumber Specifies the revision number. /requestKey Specifies the request key. /formStatus Specifies the form status. /JSESSIONID Specifies the session ID of the JM. /trackingCode Specifies the tracking code of the application. View the Response Sample Code
{
"AvokaSmartForm": {
"SFMData": {
"SystemProfile": {
"Insights": {
"Endpoint": "https://eventconsumer-dot-transact-ti-test.appspot.com/_ah/api",
"AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpbnNpZ2h0cy5hdm9rYS5jb20vRm9ybVJlcXVlc3QiOnsicmVxdWVzdEtleSI6bnVsbCwiY3VzdG9tZXJJZCI6IkF2b2thIiwidG1JbnN0YW5jZUlkIjoiNzhlZmRlZjhjYjFiYzI2MmZiYTE4ZTU2OTljNGJiYTIiLCJvcmdJZCI6NCwic3BhY2VJZCI6NywiZm9ybUlkIjoyNywiZm9ybVZlcnNpb25JZCI6NDUsImZvcm1UcmFuc2FjdGlvbklkIjoyMjcyMSwic2Vzc2lvbklkIjo2OTM5OCwiam9iSWQiOi0xLCJqb2JTdGVwSWQiOi0xLCJqb2JBY3Rpb25JZCI6LTF9LCJleHAiOjE1OTM4NjMxMTYsImlhdCI6MTU5MzY5MDMxNn0.0OSKmfM9_gtuG1TU_lAG21SlBa420k8Dkl-6JWCbIws",
"RequestUrl": "https%3A%2F%2Femea-infinity-dev.imf.avoka-transact.com%2Finfinity%2Fapp%2F%3Fnull",
"StartTime": "1593690316302",
"Enabled": "true",
"AddressHash": "6f94389d4b37b70878e23b7fafe9ded223843f3721b3f9f861f4449437763bbc"
},
"RevisionNumber": "14",
"TrackingCode": "27F5SBM",
"ReceiptNumber": ""
}
},
"Application": {
"Status": "UnderReview",
"StartDate": "2020-06-30",
"ApplicationType": "",
"CoApplicant": {
"CIF": "",
"PartyID": "",
"PersonalInfo": {
"MobileNumber": "",
"ProgressStatus": "",
"Email": "",
"FirstName": "",
"DoB": "",
"LastName": "",
"CountryCode": ""
},
"IDVInfo": {
"Field4": "",
"Field5": "",
"Field2": "",
"ProgressStatus": "",
"Field3": "",
"Field8": "",
"Field9": "",
"Field6": "",
"VendorID": "",
"Field7": "",
"Field1": "",
"Decision": ""
},
"IdentityInfo": {
"ProgressStatus": "",
"IssuedDate": "",
"ExpirationDate": "",
"IssuedCountry": "",
"TaxIdNum": "",
"IdNum": "",
"IssuedState": "",
"IdType": ""
},
"AddressInfo": {
"AddressLine2": "",
"AddressLine1": "",
"ProgressStatus": "",
"State": "",
"ZipCode": "",
"Country": "",
"City": ""
}
},
"EligibilityCriteria": "",
"IsExistingCustomer": "Yes",
"TnCFlag": "Yes",
"CoApplicantCount": "0",
"ProductSelection": {
"NoOfProducts": "1",
"ProgressStatus": "Done",
"Products": {
"Product": {
"ProductGroupId": "CURRENT.ACCOUNTS",
"ProductGroupDisplayName": "Current Accounts",
"ProductCurrencyId": "USD",
"ProductName": "Basic Checking Account",
"ProductId": "STUDENT.ACCOUNT",
"FeatureSelection": {
"NoOfFeatures": "2",
"Features": {
"Feature": [
{
"FeatureId": "Overdraft protection",
"SequenceNo": "4",
"Type": "SingleSelection",
"FeatureDescription": "To avoid the inconvenience of declined transactions on your checking account by Overdraft Protection",
"ProductId": "STUDENT.ACCOUNT",
"FeatureName": "Overdraft protection",
"SelectedValue": "OPT-OUT"
},
{
"FeatureId": "Overdraft protection",
"SequenceNo": "4",
"Type": "SingleSelection",
"FeatureDescription": "To avoid the inconvenience of declined transactions on your checking account by Overdraft Protection",
"ProductId": "STUDENT.ACCOUNT",
"FeatureName": "Overdraft protection",
"SelectedValue": "OPT-OUT"
}
]
}
},
"AccountNumber": ""
}
}
},
"IsConsentAccepted": "Yes",
"LastEditedSection": {
"ResponsiveWeb": "SubmitModule|frmMembershipStatus"
},
"Applicant": {
"CIF": "190556",
"PartyID": "2018124517",
"PersonalInfo": {
"MobileNumber": "1234567890",
"ProgressStatus": "Done",
"Email": "jede@fifirc.com",
"FirstName": "john",
"DoB": "1975-02-02",
"LastName": "smith",
"CountryCode": "+91"
},
"IDVInfo": {
"Field4": "",
"Field5": "",
"Field2": "",
"ProgressStatus": "Done",
"Field3": "",
"Field8": "",
"Field9": "",
"Field6": "",
"VendorID": "",
"Field7": "",
"Field1": "",
"Decision": "Under Review"
},
"IdentityInfo": {
"ProgressStatus": "Done",
"IssuedDate": "1993-04-23",
"ExpirationDate": "2023-01-01",
"IssuedCountry": "USA",
"TaxIdNum": "1234567890333333",
"IdNum": "945cwf5678",
"IssuedState": "TX",
"IdType": "Driver License"
},
"AddressInfo": {
"AddressLine2": "",
"AddressLine1": "222333 peachtree place",
"ProgressStatus": "Done",
"State": "GA",
"ZipCode": "30318",
"Country": "USA",
"City": "atlanta"
}
}
}
},
"controlXML": "PFNGTURhdGE+CjxTeXN0ZW1Qcm9maWxlPgo8UmV2aXNpb25OdW1iZXI+MTQ8L1JldmlzaW9uTnVtYmVyPgo8VHJhY2tpbmdDb2RlPjI3RjVTQk08L1RyYWNraW5nQ29kZT4KPFJlY2VpcHROdW1iZXIvPgo8SW5zaWdodHM+CjxFbmRwb2ludD5odHRwczovL2V2ZW50Y29uc3VtZXItZG90LXRyYW5zYWN0LXRpLXRlc3QuYXBwc3BvdC5jb20vX2FoL2FwaTwvRW5kcG9pbnQ+CjxFbmFibGVkPnRydWU8L0VuYWJsZWQ+CjxBZGRyZXNzSGFzaD42Zjk0Mzg5ZDRiMzdiNzA4NzhlMjNiN2ZhZmU5ZGVkMjIzODQzZjM3MjFiM2Y5Zjg2MWY0NDQ5NDM3NzYzYmJjPC9BZGRyZXNzSGFzaD4KPFJlcXVlc3RVcmw+PCFbQ0RBVEFbaHR0cHMlM0ElMkYlMkZlbWVhLWluZmluaXR5LWRldi5pbWYuYXZva2EtdHJhbnNhY3QuY29tJTJGaW5maW5pdHklMkZhcHAlMkYlM0ZudWxsXV0+PC9SZXF1ZXN0VXJsPgo8QWNjZXNzVG9rZW4+ZXlKMGVYQWlPaUpLVjFRaUxDSmhiR2NpT2lKSVV6STFOaUo5LmV5SnBibk5wWjJoMGN5NWhkbTlyWVM1amIyMHZSbTl5YlZKbGNYVmxjM1FpT25zaWNtVnhkV1Z6ZEV0bGVTSTZiblZzYkN3aVkzVnpkRzl0WlhKSlpDSTZJa0YyYjJ0aElpd2lkRzFKYm5OMFlXNWpaVWxrSWpvaU56aGxabVJsWmpoallqRmlZekkyTW1aaVlURTRaVFUyT1Rsak5HSmlZVElpTENKdmNtZEpaQ0k2TkN3aWMzQmhZMlZKWkNJNk55d2labTl5YlVsa0lqb3lOeXdpWm05eWJWWmxjbk5wYjI1SlpDSTZORFVzSW1admNtMVVjbUZ1YzJGamRHbHZia2xrSWpveU1qY3lNU3dpYzJWemMybHZia2xrSWpvMk9UTTVPQ3dpYW05aVNXUWlPaTB4TENKcWIySlRkR1Z3U1dRaU9pMHhMQ0pxYjJKQlkzUnBiMjVKWkNJNkxURjlMQ0psZUhBaU9qRTFPVE00TmpNeE1UWXNJbWxoZENJNk1UVTVNelk1TURNeE5uMC4wT1NLbWZNOV9ndHVHMVRVX2xBRzIxU2xCYTQyMGs4RGtsLTZKV0NiSXdzPC9BY2Nlc3NUb2tlbj4KPFN0YXJ0VGltZT4xNTkzNjkwMzE2MzAyPC9TdGFydFRpbWU+CjwvSW5zaWdodHM+CjwvU3lzdGVtUHJvZmlsZT4KPC9TRk1EYXRhPgo=",
"revisionNumber": "14",
"requestKey": "64c2abb4f89b3802b23f8ce883373ac9",
"formStatus": "Saved",
"opstatus": 0,
"JSESSIONID": "O-sXMO_Avb9A_9RYapwtwiEKLAQAI-0i_Wug372V",
"trackingCode": "27F5SBM",
"httpStatusCode": 0
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
signoutOnboardingApplication
| Description: | This API captures the audit logs at the time of logout and idle time out. | ||||
| Method: | POST | ||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/Application/signoutOnboardingApplication | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: | X-Kony-Authorization | ||||
| Body Request: |
Parameters StartTime Specifies the time at which the user has logs out or leaves the application idle. ApplicationId (Mandatory) Specifies the Journey Manager tracking ID. eventSubType (Mandatory) Specifies the event sub type. {
"StartTime":"2020-07-02 17:23:15.610",
"ApplicationId":"LPS9FW9",
"eventSubType":"ONBOARDING_SIGNOUT"
}
|
||||
| Response: |
Parameters {
"opstatus":0,
"httpStatusCode":0
}
|
||||
| Error Code(s): |
None |
||||
| Service Flow: |
|
updateLastEditedSection
| Description: | This API updates the last Edited section in the Onboarding application. | ||||||
| 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 Journey Manager tracking ID. {
"LastUpdatedSection":"IdentityModule|frmIdentityDetails",
"Application_id":"LPS9FW9"
}
|
||||||
| Response: | {
"opstatus":0,
"httpStatusCode":0
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
updateApplicationStatus
| Description: | This API updates the decision of the application from the workspace. | |||||
| Method: | POST | |||||
| URL: | {{baseUrl}}/services/data/v1/OnBoarding/operations/Application/updateApplicationStatus | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters Application_id Specifies the Journey Manager tracking ID. Status Specifies the status of the application. {
"Application_id": "ABC1234",
"Status": "Approved"
}
|
|||||
| Response: |
Parameters Application_id Specifies the Journey Manager tracking ID. {
"Application_id": "ABC1234",
"opstatus": 0,
"httpStatusCode": 200
}
Error Response {
"opstatus": 8009,
"httpStatusCode": 400,
"dbpErrCode": "71017",
"dbpErrMsg:" "Failed to update application status"
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
getAllCDPlansForProduct
| Description: | This API fetches all the Certificate of Deposit plans specific for a product. | |||||
| 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 the Journey Manager tracking ID. /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: |
|
createUserAndLogin
| Description: | This API creates a user in the application and performs a server log-in. | |||
| Method: | POST | |||
| URL: | {baseURL}/services/data/v1/OnBoarding/operations/Application/createUserAndLogin | |||
| Security Level: | Anonymous App User | |||
| Header Request: |
|
|||
| Body Request: | {}
|
|||
| Response: |
Parameters /session_token Specifies the token for the application session. /dbxuserlogin Specifies the token for Infinity application login. {
"session_token":"42a260d3-f3ee-4a88-8140-649ccbc4dc93",
"dbxuserlogin":"42a260d3-f3ee-4a88-8140-649ccbc4dc93",
"opstatus": 0,
"httpStatusCode": 200
}
Error Response {
"dbpErrCode":"77229",
"opstatus":1582,
"errmsg":"One or more of the services failed in composite service.",
"dbpErrMsg":"User create failed",
"errmsg_OnBoardingLogin":"Backend request failed for service CreateUserAndLoginOpr7093 with HTTP status code 401.",
"opstatus_OnBoardingLogin":8009,
"httpStatusCode":400,
"opstatus_createUserOperation":8009
}
|
|||
| Error Code(s): |
Error Code: 77229 Error Message: One or more of the services failed in composite service. |
|||
| Service Flow: |
|
Add Bookmark
save your best linksView Bookmarks
Visit your best links
BACK
Are you sure you want to log-off?