Introduction
The available APIs are listed below.
Category
API | Description |
---|---|
GET Offer/Category/Lookup/{client}/{channel}/{broker}?effectiveDate={effectiveDate} |
This API is used to retrieve a category grouping code by Client, Channel, and Broker. |
GET Offer/Category/{client}/{categoryGroup}?effectiveDate={effectiveDate} |
This API provides a list of available products, optionally grouped in a set of product categories, as determined by client configuration. |
Product
API | Description |
---|---|
GET Offer/Product/{client}/{product}/Certificate?effectiveDate={effectiveDate} |
This API provides the certificate of insurance for a product in PDF form. |
GET Offer/Product/{client}/{product}/DistributionGuide?effectiveDate={effectiveDate} |
This API provides the distribution guide for a product in PDF form. |
GET Offer/Product/{client}/{product}/Exclusions?effectiveDate={effectiveDate} |
This API provides the exclusions summary guide for a product in PDF form. |
GET Offer/Product/{client}/{product}/{documentCode}?effectiveDate={effectiveDate} |
This API provides the document for the product requested. |
GET Offer/Product/{client}/{product}?effectiveDate={effectiveDate} |
This API provides details about an insurance product. |
GET Offer/Product/{preExCode} |
This API provides the Pre Ex details for the provided Pre Ex code. |
Offer
The responsible for processing requests for insurance offers.
API | Description |
---|---|
POST Offer |
Issues an insurance offer. The products included in the response are dependent on client configuration and eligibility based on the requested coverage. |
GET Offer |
No documentation available. |
GET Offer/Setup |
No documentation available. |
Purchase
API | Description |
---|---|
POST Policy/Purchase |
This API issues insurance policies. |
License
The is responsible for processing License Interactions for Agency Admin.
API | Description |
---|---|
GET AgencyAdmin/License/{licenseId} |
No documentation available. |
POST AgencyAdmin/License/Save |
No documentation available. |
DELETE AgencyAdmin/License/Delete?licenseId={licenseId} |
No documentation available. |
GET AgencyAdmin/AgencyLicense/{agencyId}/{licenseSeq}/{licenseId} |
No documentation available. |
GET AgencyAdmin/AgentLicense/{agentId}/{licenseSeq}/{licenseId} |
No documentation available. |
POST AgencyAdmin/AgencyLicense/Save |
No documentation available. |
POST AgencyAdmin/AgentLicense/Save |
No documentation available. |
DELETE AgencyAdmin/AgencyLicense/Delete/{agencyId}/{licenseSeq}/{licenseId} |
No documentation available. |
DELETE AgencyAdmin/AgentLicense/Delete/{agentId}/{licenseSeq}/{licenseId} |
No documentation available. |
Lookup
The responsible for processing Lookup Interactions for Agency Admin.
API | Description |
---|---|
GET AgencyAdmin/Lookup/ParentAgencies |
No documentation available. |
GET AgencyAdmin/Lookup/BDMs |
No documentation available. |
GET AgencyAdmin/Lookup/MainChannels |
No documentation available. |
GET AgencyAdmin/Lookup/Provinces |
No documentation available. |
GET AgencyAdmin/Lookup/UserRoles |
No documentation available. |
GET AgencyAdmin/Lookup/LicenseTypes/{province} |
No documentation available. |
GET AgencyAdmin/Lookup/GetLicenseByType?licenseType={licenseType} |
No documentation available. |
Agent
The responsible for processing Agent Interactions for Agency Admin.
API | Description |
---|---|
GET AgencyAdmin/Agent/Detail/{agentId} |
No documentation available. |
GET AgencyAdmin/Agent/AgencyAgents/{agencyId} |
No documentation available. |
POST AgencyAdmin/Agent/Add |
No documentation available. |
PUT AgencyAdmin/Agent/Update/{agentId} |
No documentation available. |
DELETE AgencyAdmin/Agent/Delete/{agentId} |
No documentation available. |
GET AgencyAdmin/Agent/{agentId}/license |
No documentation available. |
GET AgencyAdmin/Agent/GetByEmail/{email} |
No documentation available. |
PUT AgencyAdmin/Agent/{agentId}/Update/Status/{status} |
No documentation available. |
PUT AgencyAdmin/Agent/UpdateAgentAgency |
No documentation available. |
PUT AgencyAdmin/Agent/UpdateAgentEmail |
No documentation available. |
Agency
The responsible for processing Agency Interactions for Agency Admin.
Benefit
API | Description |
---|---|
GET Benefit/{client}/{product}?effectiveDate={effectiveDate} |
No documentation available. |