Regionalized Solutions
R24 AMR | Min(s) read
APIs
Please find below the API details for the Lenders Mortgage Insurance module.
The API will only be useable if the module has been licensed by the client.
In the URL, vx.x.x denotes the swagger version that client has licensed.
| Endpoint | Method | URL | Description |
|---|---|---|---|
| createMortgageLoan | POST | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/loans/mortgages | Creates a mortgage loan with insurance policy taken to cover the credit risk for the customer's loan and capture rate lock interest details used to apply lowest of rate lock interest and carded rate. |
| updateMortgageLoan | PUT | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/loans/mortgages/{mortgageId} | Update static information of mortgage like title name. |
| getMortgageLoan | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/loans/mortgages/{mortgageId} | Retrieves the details of mortgage including the insurance policy Id. |
| createInsurancePolicy | POST | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/customers/insurances/policies/{insurerPolicyId} | Capture insurance policy details which is taken to cover the credit risk associated with the customer's loan. |
| updateInsurancePolicy | PUT | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/customers/insurances/policies/{insurerPolicyId} | Updates insurance policy details which is taken to cover the credit risk associated with the customer's loan. |
| getInsurancePolicy | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/customers/insurances/policies/{insurerPolicyId} | Retrieves the details of insurance policy which is taken to cover the credit risk associated with the customer's loan. |
| getMortgageInsuranceCoverage | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/customers/{customerId}/mortgages/insurances/coverage | Retrieves details of insurance coverage for mortgage loan such as percentage coverage. |
In this topic