List policy and policy details
A Consumer Service Portal (Service Portal) can list policies and policy details for a given policyholder.
- Display list of policies with policy name
- To display a list of policies with the policy name, call the following APIs:
- To get a list of policies created after a certain date, call the following API:
The results include information about the latest term of each policy. When the latest term has a future effective date, the results include information about the future policy and a policyref (GET /policies?customerId=customerId&createdSinceDt=createdSinceDate
systemId
) value for the current policy. - To display policy information about the current policy, call the following API:
GET /policies/systemId
- To determine the product name to display for each policy, call the following API:
For example, you can include the product name Homeowners or Premier Personal Auto as part of the policy description.GET /products?productVersionRefId=policy.policyMini.basicPolicy.productVersionIdRef
- To get a list of policies created after a certain date, call the following API:
- Display details of a policy
- To display the details of a policy, call the following API:
GET /policies/systemId/insuredPolicyDetails
- List policy documents
- To list policy documents, call the following API:
GET /policies/systemId/insuredDocuments
- Provide a download link to a policy document
- To provide a link that allows the policyholder to download a policy document, use the
following
API:
GET /policies/systemId/documents/documentId/content
Note: You can determine thedocumentId
values from the API response of theGET /policies/systemId/insuredDocuments
.For example, the documentID is
OutputItem-1417739612-1987242998
the API response:{ "documentListItems": [ { "ref": "OutputItem-1417739612-1987242998", "type": "Output", "name": "Insured Installment Invoice", "description": "Insured Installment Invoice", ... "_links": [ { "rel": "content", "href": "/coreapi/v5/policies/1/documents/OutputItem-1417739612-1987242998/content" }, { "rel": "parent", "href": "/coreapi/v5/policies/1" } ]