OmniLife API

https://uat.omnilife.com.au/API/4
Admin
OmniLife API is a comprehensive insurance quoting and portfolio management system that provides...
Tokens:3,885
Snippets:17
Trust Score:5.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /legacy/products

Source: https://uat.omnilife.com.au/API/4

Retrieves a list of legacy products. This endpoint is for accessing product information from older systems.

```APIDOC
## GET /legacy/products

### Description
Retrieves a list of products from the legacy system.

### Method
GET

### Endpoint
`/legacy/products`

### Parameters
No parameters required.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **products** (array) - A list of legacy product objects.
```

--------------------------------

### GET /suppliers

Source: https://uat.omnilife.com.au/api/4

Retrieves a list of available suppliers.

```APIDOC
## GET /suppliers

### Description
Fetches a list of all available suppliers within the OmniLife system.

### Method
GET

### Endpoint
`/suppliers`

### Parameters
#### Query Parameters
- **suppliers** (string) - Optional - Filter suppliers by name or code.

### Response
#### Success Response (200)
- **suppliers** (array) - A list of supplier objects, each containing supplier details.

#### Response Example
```json
{
  "suppliers": [
    {
      "supplierCode": "SUP001",
      "name": "Example Insurance Provider",
      "contact": "contact@example.com"
    }
  ]
}
```
```

--------------------------------

### GET /products/{productCode}

Source: https://uat.omnilife.com.au/api/4

Retrieves details for a specific product using its product code.

```APIDOC
## GET /products/{productCode}

### Description
Retrieves detailed information about a specific insurance product identified by its unique product code.

### Method
GET

### Endpoint
`/products/{productCode}`

### Parameters
#### Path Parameters
- **productCode** (string) - Required - The unique identifier for the product.

### Response
#### Success Response (200)
- **productDetails** (object) - An object containing comprehensive details of the product.

#### Response Example
```json
{
  "productDetails": {
    "productCode": "TRM500",
    "name": "Term Life Insurance",
    "description": "Provides coverage for a specified term.",
    "features": [
      "Death Benefit",
      "Optional Riders"
    ]
  }
}
```
```

--------------------------------

### GET /occupations

Source: https://uat.omnilife.com.au/api/4

Retrieves a list of occupations.

```APIDOC
## GET /occupations

### Description
Fetches a list of all available occupations recognized by the system.

### Method
GET

### Endpoint
`/occupations`

### Response
#### Success Response (200)
- **occupations** (array) - A list of occupation objects, each with an ID and name.

#### Response Example
```json
{
  "occupations": [
    {
      "occupationId": "900105",
      "name": "Software Engineer"
    }
  ]
}
```
```

--------------------------------

### GET /products/{productCode}

Source: https://uat.omnilife.com.au/API/4

Retrieves detailed information about a specific product identified by its product code. This includes features, benefits, and other relevant product data.

```APIDOC
## GET /products/{productCode}

### Description
Retrieves detailed information for a specific product using its unique code.

### Method
GET

### Endpoint
`/products/{productCode}`

### Parameters
#### Path Parameters
- **productCode** (string) - Required - The unique identifier for the product.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **productDetails** (object) - An object containing detailed information about the product.
```

--------------------------------

### GET /legacy/portfolios

Source: https://uat.omnilife.com.au/API/4

Retrieves a list of legacy portfolios. This endpoint provides access to historical portfolio data.

```APIDOC
## GET /legacy/portfolios

### Description
Retrieves a list of portfolios from the legacy system.

### Method
GET

### Endpoint
`/legacy/portfolios`

### Parameters
No parameters required.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **portfolios** (array) - A list of legacy portfolio objects.
```

--------------------------------

### GET /legacy/suppliers

Source: https://uat.omnilife.com.au/API/4

Retrieves a list of legacy suppliers. This endpoint is for accessing data from older systems or deprecated supplier information.

```APIDOC
## GET /legacy/suppliers

### Description
Retrieves a list of suppliers from the legacy system.

### Method
GET

### Endpoint
`/legacy/suppliers`

### Parameters
No parameters required.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **suppliers** (array) - A list of legacy supplier objects.
```

--------------------------------

### GET /research/headings

Source: https://uat.omnilife.com.au/API/4

Retrieves a list of research headings. This endpoint is useful for navigating or categorizing research-related content.

```APIDOC
## GET /research/headings

### Description
Retrieves a list of available research headings.

### Method
GET

### Endpoint
`/research/headings`

### Parameters
No parameters required.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **headings** (array) - A list of research heading objects.
```

--------------------------------

### GET /suppliers/{supplierCode}/occupations

Source: https://uat.omnilife.com.au/API/4

Retrieves a list of occupations relevant to a specific supplier. This can be used to filter or validate occupation data for quotes associated with that supplier.

```APIDOC
## GET /suppliers/{supplierCode}/occupations

### Description
Fetches a list of occupations associated with a specific supplier.

### Method
GET

### Endpoint
`/suppliers/{supplierCode}/occupations`

### Parameters
#### Path Parameters
- **supplierCode** (string) - Required - The code of the supplier.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **occupations** (array) - A list of occupation objects relevant to the specified supplier.
```

--------------------------------

### GET /occupations/{occupationId}/exclusions

Source: https://uat.omnilife.com.au/API/4

Retrieves exclusion details for a specific occupation. This endpoint helps in understanding limitations or specific conditions related to an occupation.

```APIDOC
## GET /occupations/{occupationId}/exclusions

### Description
Retrieves exclusion details for a given occupation ID.

### Method
GET

### Endpoint
`/occupations/{occupationId}/exclusions`

### Parameters
#### Path Parameters
- **occupationId** (string) - Required - The ID of the occupation.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **exclusions** (array) - A list of exclusion objects related to the occupation.
```

--------------------------------

### POST /quote/portfolio/{portfolioCode}/productOptions

Source: https://uat.omnilife.com.au/API/4

Retrieves available product options for a specific portfolio code within a quote. This endpoint helps in selecting suitable products for the client's needs.

```APIDOC
## POST /quote/portfolio/{portfolioCode}/productOptions

### Description
Fetches available product options for a given portfolio code. This is useful for presenting choices to the user after an initial quote has been generated.

### Method
POST

### Endpoint
`/quote/portfolio/{portfolioCode}/productOptions`

### Parameters
#### Path Parameters
- **portfolioCode** (string) - Required - The code of the portfolio for which to retrieve product options.

#### Query Parameters
- **suppliers** (string) - Optional - Filters options by supplier.
- **premiumBreakdown** (boolean) - Optional - Includes a breakdown of premiums for each option.
- **premiumComponents** (boolean) - Optional - Includes detailed premium components.

### Request Example
```json
{
  "clients": [
    {
      "clientId": "fd9f4fd5-9d9d-47d9-a708-3961bbfb5fe2",
      "needs": [
        {
          "TRM": {
            "sumInsured": 500000
          }
        }
      ]
    }
  ]
}
```

### Response
#### Success Response (200)
- **productOptions** (array) - A list of available product options.
- **errors** (array) - Contains any errors encountered.
```

--------------------------------

### POST /quote/portfolio/{portfolioCodes}

Source: https://uat.omnilife.com.au/api/4

This endpoint allows for the creation or modification of a quote portfolio based on provided portfolio codes.

```APIDOC
## POST /quote/portfolio/{portfolioCodes}

### Description
Creates or updates a quote portfolio using the specified portfolio codes.

### Method
POST

### Endpoint
`/quote/portfolio/{portfolioCodes}`

### Parameters
#### Path Parameters
- **portfolioCodes** (string) - Required - The codes identifying the portfolios to be used in the quote.

#### Query Parameters
- **portfolioCodes** (string) - Optional - Additional portfolio codes.
- **suppliers** (string) - Optional - Specifies suppliers to include.
- **premiumBreakdown** (boolean) - Optional - Whether to include a premium breakdown.
- **premiumComponents** (boolean) - Optional - Whether to include premium components.
- **frequency** (string) - Optional - The premium payment frequency.
- **score** (boolean) - Optional - Whether to include a score.
- **includeTopFeatures** (boolean) - Optional - Whether to include top features.
- **includeBottomFeatures** (boolean) - Optional - Whether to include bottom features.
- **compareAllCombinations** (boolean) - Optional - Whether to compare all combinations.
- **nonSuperFrequency** (string) - Optional - Non-superannuation payment frequency.
- **superFrequency** (string) - Optional - Superannuation payment frequency.
- **scoreWeightingType** (string) - Optional - Type of score weighting.
- **scoreWeightingProfile** (string) - Optional - Profile for score weighting.
- **showProductExclusion** (boolean) - Optional - Whether to show product exclusions.

### Request Body
```json
{
  "clients": [
    {
      "age": 28,
      "gender": "M",
      "smoker": false,
      "occupationId": "900105",
      "employmentStatus": "E",
      "state": "NSW",
      "clientId": "fd32587a-ece1-467e-9eec-03e7040c4375",
      "needs": [
        {
          "TRM": {
            "sumInsured": 500000,
            "structure": "L",
            "owner": "S",
            "rollover": "N",
            "linkedNeeds": [
              {
                "TPE": {
                  "sumInsured": 250000,
                  "structure": "L",
                  "occupationType": "A",
                  "owner": "S",
                  "rollover": "N",
                  "lifeBuyBack": "L",
                  "doubleTPD": "X"
                }
              },
              {
                "TRE": {
                  "sumInsured": 100000,
                  "structure": "L",
                  "lifeBuyBack": "L",
                  "doubleTrauma": "X",
                  "traumaReinstatement": "X",
                  "priority": "C"
                }
              }
            ],
            "productCodes": {}
          }
        },
        {
          "TPS": {
            "sumInsured": 400000,
            "structure": "S",
            "occupationType": "O",
            "owner": "O",
            "rollover": "N",
            "productCodes": {}
          }
        },
        {
          "INC": {
            "sumInsured": 100000,
            "structure": "S",
            "owner": "O",
            "rollover": "N",
            "productCodes": {}
          }
        }
      ]
    }
  ]
}
```

### Response
#### Success Response (200)
- **quoteId** (string) - Description of the generated quote identifier.
- **portfolio** (object) - Description of the generated portfolio details.

#### Response Example
```json
{
  "quoteId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "portfolio": {
    "totalPremium": 150.75,
    "currency": "AUD"
  }
}
```
```

--------------------------------

### POST /quote/portfolio/{portfolioCodes}/features

Source: https://uat.omnilife.com.au/API/4

Retrieves features for a quote portfolio. This endpoint is similar to the research version but specifically for quote-related portfolios.

```APIDOC
## POST /quote/portfolio/{portfolioCodes}/features

### Description
Retrieves features associated with a quote portfolio.

### Method
POST

### Endpoint
`/quote/portfolio/{portfolioCodes}/features`

### Parameters
#### Path Parameters
- **portfolioCodes** (string) - Required - The codes of the portfolios.

#### Query Parameters
- **includeTopFeatures** (boolean) - Optional - Whether to include top features.
- **includeBottomFeatures** (boolean) - Optional - Whether to include bottom features.

### Request Example
(Request body might be needed depending on implementation, but not explicitly defined in the provided text.)

### Response
#### Success Response (200)
- **features** (object) - An object containing the features of the quote portfolio.
```

--------------------------------

### POST /research/portfolio/features

Source: https://uat.omnilife.com.au/API/4

Analyzes and returns features for a research portfolio. This endpoint is used for comparative analysis of different portfolio features.

```APIDOC
## POST /research/portfolio/features

### Description
Analyzes and returns features for a research portfolio. Used for comparing portfolio features.

### Method
POST

### Endpoint
`/research/portfolio/features`

### Parameters
#### Request Body
- **portfolioCodes** (array) - Required - A list of portfolio codes to analyze.
- **includeTopFeatures** (boolean) - Optional - Whether to include top features.
- **includeBottomFeatures** (boolean) - Optional - Whether to include bottom features.
```

--------------------------------

### Define Insurance Client Portfolio Request

Source: https://uat.omnilife.com.au/API/4

A JSON structure representing a client's insurance profile, including demographic details, occupation data, and specific coverage needs such as Trauma (TRM), Total and Permanent Disability (TPE/TPS), and Income Protection (INC). This payload is used for portfolio quoting and premium assessment.

```json
{
  "clients": [
    {
      "age": 28,
      "gender": "M",
      "smoker": false,
      "occupationId": "900105",
      "employmentStatus": "E",
      "state": "NSW",
      "clientId": "fd9f4fd5-9d9d-47d9-a708-3961bbfb5fe2",
      "needs": [
        {
          "TRM": {
            "sumInsured": 500000,
            "structure": "L",
            "owner": "S",
            "rollover": "N",
            "linkedNeeds": [
              {
                "TPE": {
                  "sumInsured": 250000,
                  "structure": "L",
                  "occupationType": "A",
                  "owner": "S",
                  "rollover": "N",
                  "lifeBuyBack": "L",
                  "doubleTPD": "X"
                }
              },
              {
                "TRE": {
                  "sumInsured": 100000,
                  "structure": "L",
                  "lifeBuyBack": "L",
                  "doubleTrauma": "X",
                  "traumaReinstatement": "X",
                  "priority": "C"
                }
              }
            ],
            "productCodes": {}
          }
        },
        {
          "TPS": {
            "sumInsured": 400000,
            "structure": "S",
            "occupationType": "O",
            "owner": "O",
            "rollover": "N",
            "productCodes": {}
          }
        },
        {
          "INC": {}
        }
      ]
    }
  ]
}
```

--------------------------------

### Define Insurance Portfolio Request JSON

Source: https://uat.omnilife.com.au/api/4

A JSON structure used to define client demographics and insurance needs, including specific coverage types like TRM, TPE, TRE, TPS, and INC. This payload is typically sent to portfolio quote endpoints to calculate premiums and product options.

```json
{
  "clients": [
    {
      "age": 28,
      "gender": "M",
      "smoker": false,
      "occupationId": "900105",
      "employmentStatus": "E",
      "state": "NSW",
      "clientId": "fd32587a-ece1-467e-9eec-03e7040c4375",
      "needs": [
        {
          "TRM": {
            "sumInsured": 500000,
            "structure": "L",
            "owner": "S",
            "rollover": "N",
            "linkedNeeds": [
              {
                "TPE": {
                  "sumInsured": 250000,
                  "structure": "L",
                  "occupationType": "A",
                  "owner": "S",
                  "rollover": "N",
                  "lifeBuyBack": "L",
                  "doubleTPD": "X"
                }
              },
              {
                "TRE": {
                  "sumInsured": 100000,
                  "structure": "L",
                  "lifeBuyBack": "L",
                  "doubleTrauma": "X",
                  "traumaReinstatement": "X",
                  "priority": "C"
                }
              }
            ],
            "productCodes": {}
          }
        },
        {
          "TPS": {
            "sumInsured": 400000,
            "structure": "S",
            "occupationType": "O",
            "owner": "O",
            "rollover": "N",
            "productCodes": {}
          }
        },
        {
          "INC": {
            "sumInsured": 200000,
            "structure": "L"
          }
        }
      ]
    }
  ]
}
```

--------------------------------

### POST /occupations/{occupationId}/exclusions

Source: https://uat.omnilife.com.au/API/4

Allows for the creation or update of exclusion details for a specific occupation. This endpoint is typically used for administrative purposes.

```APIDOC
## POST /occupations/{occupationId}/exclusions

### Description
Creates or updates exclusion details for a specific occupation.

### Method
POST

### Endpoint
`/occupations/{occupationId}/exclusions`

### Parameters
#### Path Parameters
- **occupationId** (string) - Required - The ID of the occupation.

#### Request Body
- **exclusionDetails** (object) - Required - An object containing the exclusion details to be created or updated.
```
Tokens:
Raw