Eligibility Application
| Name | Description | Introduced In |
|---|---|---|
| getDetails | This API is used to retrieve the address details during the application registration process. | 2021.01 |
| getDetails | This API retrieves the identity details of an applicant from ODMS. | 2021.01 |
| updateApplication | This API updates the application to the Origination Data Microservice (ODMS) after obtaining the application status. | 2021.01 |
getDetails
| Description: | Retrieves the details that are provided in the Address Information section, such as city, state, and zip code. This API is used to retrieve the address details during the application registration process. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/EligibilityApplication/operations/Address/getDetails | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters ApplicantType Specifies the type of applicant.
{
"ApplicantType": "Applicant"
}
|
||||||
| Response: |
{
"EmploymentDetails": "[{\"OrganizationName\":\"Temenos\",\"Status\":\"Casual Employee\",\"ZipCode\":\"11111\",\"City\":\"Adradd\",\"EndDate\":\"\",\"StartDate\":\"2000-11-11\",\"AddressLine2\":\"Address Line 2\",\"AddressLine1\":\"Address Line 1\",\"State\":\"DZ-01\",\"Country\":\"DZ\",\"PhoneNumber\":\"2222222222\",\"CountryCode\":\"+91\",\"CurrentEmployment\":\"true\"}]",
"EstimatedAnnualIncome": "",
"TotalNetIncome": "40000",
"EmploymentStatus": "Casual Employee",
"ConsiderIncomeLoanEligibilityCalculation": "true",
"OtherIncomes": "[{\"SourceOfIncome\":\"Inheritance\",\"Income\":\"10000\"}]",
"TotalMonthlyLoanRepayment": "2000",
"CurrencyID": "USD",
"TotalGrossIncome": "200",
"Occupation": "Architect",
"TotalAsset": "1000",
"TotalLiabilities": "2000",
"TotalDebt": "",
"IncomePeriod": "Monthly",
"DeclarationDate": "2022-02-01",
"opstatus": 0,
"TotalMonthlyHouseholdExpenses": "2000",
"ID": "61f903d9547cbf232f8a294c",
"MonthlyIncome": "",
"ConsiderExpensesLoanEligibilityCalculation": "true",
"httpStatusCode": 0
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getDetails
| Description: | This API retrieves the identity details of an applicant from ODMS. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/EligibilityApplication/operations/Identity/getDetails | ||||||
| Security Level: | Anonymous App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters ApplicantType Specifies the type of applicant. {
"ApplicantType": "Applicant"
}
|
||||||
| Response: |
{"opstatus":0,"httpStatusCode":0}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
updateApplication
| Description: | Updates the application to the Origination Data Microservice (ODMS) after obtaining the application status. This API invokes the rules engine to fetch the individual decisions of the applicant and co-applicant, which contain information about the application status. After the API obtains the individual decisions, it submits the application to the Data microservice. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/EligibilityApplication/operations/Application/updateApplication | ||||||
| Security Level: | Anonymous App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters FormCode Specifies the unique entity definition code. Application_id Specifies the entity definition key. Status Specifies the status of the application. StartDate Specifies the date on which the application was started. ApplicationType Specifies the type of applicant such as general applicant or co-applicant. EligibilityCriteria Specifies the eligibility criteria for accessing the Origination application. IsExistingCustomer Specifies whether the user is an already existing customer in the Origination application. CoApplicantCount Specifies the number of co-applicants. EntityId Specifies the record ID for the entity item data.
{
"ApplicantType": "Applicant",
"EligibilityCriteria": "11111",
"ConsentIdentifier": "Create_EligibilityCheck_Consent",
"AcceptanceStatus": "Yes",
"EntityId": "60fe19e9decbb711d1e76601"
}
|
||||||
| Response: |
Parameters /totalRecords Specifies the total number of updated records. /Application_id Specifies the entity definition key. //Success Response
{
"opstatus": 0,
"id": "3X88WLM",
"httpStatusCode": 0
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
In this topic