# Prosperity Partner Integration — Complete Documentation

> This file contains the complete partner integration documentation for the Prosperity insurance platform.
> It is optimized for consumption by AI coding assistants and LLMs.
> Source: https://partner-docs.life.li

---

## AI-Assisted Integration

URL: https://partner-docs.life.li/ai-integration

# AI-Assisted Integration

Accelerate your integration with the Prosperity platform using AI coding assistants. Every API operation in our documentation has a **Copy Prompt** button — click it, paste into your AI assistant, and get working integration code.

Each prompt includes the actual GraphQL schema types (SDL) read directly from our source code, so the type definitions, field constraints, and documentation comments are always in sync with the API.

## Copy Prompts (Per Operation)

Each page in the [Platform Integration](/platform-integrations) section has focused, self-contained prompts you can copy directly into your AI coding assistant:

### API Setup
- [Platform GraphQL API](/platform-integrations/graphql-api) — prompt to set up the authenticated API client

### Creating Offers
- [Creating Offers](/platform-integrations/creating-offers) — per-product prompts for:
  - Liechtenstein Life Invest (Germany)
  - Liechtenstein Life Wealth (Germany)
  - Prosperity Plus Germany (Germany)
  - Prosperity 3A (Switzerland)
  - Existing customer offers

### Other Operations
- Fetch offer and download PDF
- Update customer information
- Look up customer by email

Each prompt includes the exact GraphQL mutation/query, working example variables, authentication setup, relevant schema types (SDL), and product-specific notes. Just copy, paste, and tell your AI what to build.

## Schema Reference

Browse the full GraphQL schema for the Partner Platform API:

- [Schema Reference](/docs/schema) — browsable, auto-generated documentation for every type, input, enum, union, and interface
- [Platform Integration API Explorer](/platform-integrations/graphql-api) — interactive playground with full schema introspection

The schema reference is auto-generated from the source `.gql` files to stay in sync with the API.

## llms.txt (Auto-Discovered by AI Tools)

Our documentation follows the [llms.txt standard](https://llmstxt.org/). AI tools that support this standard will automatically discover and consume our documentation.

- **Index:** [/llms.txt](https://partner-docs.life.li/llms.txt) — lightweight summary with links to all pages
- **Full content:** [/llms-full.txt](https://partner-docs.life.li/llms-full.txt) — complete documentation in one AI-optimized file

## Interactive GraphQL Playground

Each API documentation page includes an embedded GraphQL playground where you can explore the schema, run queries, and test mutations directly:

- [Platform Integration API Explorer](/platform-integrations/graphql-api) — for creating complete offers
- [Digital Onboarding API Explorer](/customer-digital-onboarding/graphql-api) — for partial offers with customer onboarding

## Which API Do I Need?

| Use Case | API | Graph |
|----------|-----|-------|
| You have **all customer data** and want to create complete, binding offers | Partner Platform | `partner-platform` |
| You have **partial data** and want customers to complete the offer in-app | Partner (Digital Onboarding) | `partner` |

## Need Help?

If you need assistance with AI-assisted integration or have questions, please reach out to our support team.


---

## Creating Offers With Onboarding Customer Flows

URL: https://partner-docs.life.li/customer-digital-onboarding/creating-offers

# Creating Offers With Onboarding Customer Flows

## Prerequisites

- You have received your API Key (for stable and production environment)

## Integrating our product

There are two ways to integrate our product – both lead the user from your website into our policy application flow (themed as per your brand guidelines) seamlessly.

### Option 1: Embedding our user creation widget

![User Creation Widget](/img/user-creation-widget.jpg)

You can integrate our user creation/registration widget inside your website as an `<iframe>` with the URL `https://example.com/partner/register`. On successful user creation, a verification email is then sent to the user with a verification link which will automatically redirect them to our policy application flow.

For a more customized experience, please have a look at our API. Use the register widget as a reference for implementing the consent checkboxes.

### Option 2: Integrating through our Partner API (bringing customers to our UI for verification and submission)

If you already have information about the user or have a custom onboarding experience, you can integrate our product using the Partner API to create the user with the relevant data points. A successful request will provide you with a magic link (if the user is already verified on your platform) that, when used, will automatically login into the user account and take them to our policy application flow with the additional data already being filled in for them.

```mermaid
sequenceDiagram
autonumber
participant Verified User
participant Your Software
participant Our Partner API
participant Our Website
Note right of Our Website: Custom themed
    Verified User -->>+ Your Software: Provides information
    Your Software -->>+ Our Partner API: trigger  createUser API
    Our Partner API -->>- Your Software: Response (with magic-link)
    Your Software -->>+ Our Website: redirect to magic-link (automatically login user)
```

#### Unverified user

The flow differs slightly in the case of a user who is not verified beforehand. On creating the unverified user on our platform, we will send the user a verification email with a verification link that will also work as a magic link.

```mermaid
sequenceDiagram
autonumber
participant Unverified User
participant Your Software
participant Our Partner API
participant Our Website
Note right of Our Website: Custom themed
    Unverified User -->>+ Your Software: Provides information
    Your Software -->>+ Our Partner API: trigger  createUser API
    Our Partner API -->>- Unverified User: E-mail verification (sent to the user)
    Unverified User -->>+ Our Website: Verification link (verifies and automatically login user)
```

### Option 3: API-only integration with Partner API (for partners with broker licenses)

If you already have all information about the user, you can integrate our product end-to-end with our Partner API and provide custom interfaces for the customers and brokers.

API-only integration allows you to create a flow from generating an offer for a customer to submitting the documents and applying for the offer with the insurance provider. This integration is for partners who want to create their broker dashboards to process and manage customers and complete another broker-related task without using external tools or interfaces for both brokers and customers.

The initial part of the flow remains the same as other integration. You can request the partner API to create a user with an offer. Once the user is created, you can use the user ID to perform additional actions on the offer.

```mermaid
sequenceDiagram
autonumber
participant Verified User
participant Your Software
participant Our Partner API
    Verified User -->>+ Your Software: Provides information
    Your Software -->>+ Our Partner API: trigger  createUser API
    Our Partner API -->>- Your Software: Response with UserID, OfferID, MagicLink
```

- If you created the user as a pre-verified user, you can upload the identity verification document.
- The next step is to generate a policy ID from the offer, which generates the application form, and validates the user and offer request, including checks on the combination of funds, investment risk level, and sustainability choices.
- The application is available for download once the policy ID is generated through the user query and uploaded back once the customer and the broker have signed it.
- The last step is to submit the offer to the insurance provider for verification and being issued, it can only be done once the signed application form has been uploaded.
- Once the offer has been submitted to the insurance company, no other mutation can be performed.
- The user query provides additional information about the verification status, signed application form upload status, and policy ID (if generated).

```mermaid
sequenceDiagram
autonumber
participant User
participant Brokers
participant Our Partner API
    Brokers -->>+ Our Partner API: Uploads ID Verification (mutation uploadIdentityVerificationDocument)
    Brokers -->>+ Our Partner API: Generate Policy ID (mutation validateAndGeneratePolicyID)
    Brokers -->>+ Our Partner API: Request application form (query user with policyApplicationForm field)
    Our Partner API -->>- Brokers: Use download link (PDF - valid for 5 mins)
    Brokers -->>+ User: Partner sends form to the user
    User -->- Brokers: Signed form received from the user
    Brokers -->>+ Our Partner API: Upload double-signed form (mutation uploadSignedApplicationForm)
    Brokers -->>+ Our Partner API: Submit to LLA (mutation submitOfferForIssuance)
```

This integration only works when the user/offer is created with all possible
inputs prefilled in the createUser mutation. If the information is missing or
invalid, we do not provide APIs to fix these issues, we return the response
from the insurance provider's API, and any problems with the offer have to be
fixed on the insurance provider's broker portal.

### Option 4: Post-pickup only integration

Partners can also have a limited integration of our application for users who have already picked up their policies without the onboarding experience. These users have an ongoing policy and have already opened their on the policy pickup email, created account on our application, and verified and picked up their policy.

This flow is for partners who have their own application and sell product outside of our application. This flow also supports all Liechtenstein Life insurance products.

Partners can fetch the details about their customers who are using our application through multiple ways:

- Use the GraphQL API to fetch all users using the `users` query
- You can subscribe to our webhook (by subscribing to `POLICY_ACTIVATED` event) this will notify the partners when new users are created that are associated with them.

Both these API steps result in user IDs that can be used to generate magic-links which can then be used to load the application with the user already logged in within an iframe.

```mermaid
sequenceDiagram
autonumber
participant Our Partner API
participant Partner System
participant Partner Website
    Our Partner API -->>+ Partner System: Fetch all users from GraphQL
    Our Partner API -->>+ Partner System: Recieved `POLICY_ACTIVATED` event webhook.
    Partner System -->>+ Our Partner API: Request magiclink for a certain user.
    Our Partner API -->>- Partner Website: Show the magiclink in an iframe.
```

## GraphQL API

- Detailed instructions on how to setup our graphQL API can be found in the [Our GraphQL API](/customer-digital-onboarding/graphql-api) section.
- The primary mutation you can start the integration process with is `createUser`. The operation can look like this:

```gql
mutation Mutation($user: UserInput!) {
  createUser(user: $user) {
    __typename
    ... on CreatedUnverifiedUser {
      id
    }
    ... on CreatedVerifiedUser {
      id
      magicLinkUrl
    }
    ... on ErrorInterface {
      message
    }
  }
}
```

**The schema is fully commented, so consider the Playground as the API reference ("Docs" on the right).**

We are handling errors inside of our schema (see `ErrorInterface` above). Possible errors are self-documenting and you know what to handle ahead of time. ([More on the pattern](https://sachee.medium.com/200-ok-error-handling-in-graphql-7ec869aec9bc))

Never query the error types directly and always access errors through the `ErrorInterface` as laid out above. This way you can avoid breaking changes, caused through added or removed errors.

## Registering webhooks

We also support registering your own webhooks that are triggered when meaningful policy and user update events occur. You can read about webhooks in the API documentation within the `registerWebhook` mutation.

## Integrating into native apps

- Use the partner API to get a magic link for your logged-in user.
- Load the magic link in a web-view as a separate tab or a modal.
- Ensure that the cookies are persisted between sessions so that the magic link does not have to be regenerated when reopening the app.


---

## Partner GraphQL API

URL: https://partner-docs.life.li/customer-digital-onboarding/graphql-api

# Partner GraphQL API

The Partner GraphQL API provides advanced capabilities for creating and managing complete offers. Access the API at:

- Test Environment: [https://api.stable.life.li/graphql/partner](https://api.stable.life.li/graphql/partner)
- Production: [https://api.life.li/graphql/partner](https://api.life.li/graphql/partner)

## Authentication

Both endpoints include a GraphQL playground for interactive API exploration. To authenticate:

1. In the browser authentication popup:

   - Leave the username empty
   - Enter your API key as the password

2. In the playground's Headers section, add:
   ```json
   {
     "Authorization": "Bearer YOUR-API-KEY",
     "x-partner-id": "YOUR-PARTNER-ID" // Required if you have multiple partner IDs
   }
   ```

If you're working with multiple partner IDs or are a platform serving multiple partners:

- Each Partner ID must be mapped to your API key
- Contact support to set up new ID mappings
  :::

## Environments

- **Stable**: A clone of our production environment, ideal for development and testing
- **Production**: Live environment for real transactions

If you previously used the Customer Digital Onboarding flow and the `partner` graph, your existing credentials will work with the `partner-platform` graph.

## Security Best Practices

1. Keep your API key secure and never expose it in client-side code
2. Use environment variables for storing credentials
3. Request new API keys if they are compromised
4. Use HTTPS for all API communications

## Interactive API Explorer

Explore the schema and run queries directly in the GraphQL playground:

- **Test**: [api.stable.life.li/graphql/partner](https://api.stable.life.li/graphql/partner)
- **Production**: [api.life.li/graphql/partner](https://api.life.li/graphql/partner)

Authenticate via the browser Basic Auth popup (leave username empty, enter your API key as password), then add your headers in the playground's Headers tab.


---

## Customer Digital Onboarding

URL: https://partner-docs.life.li/customer-digital-onboarding

# Customer Digital Onboarding

Customer digital onboarding enables a seamless transition between creating an offer through our API with initial customer information (from your CRM or collected through your flows) and allowing customers to continue their journey in the Prosperity App. In the app, customers can:

- Edit/add information required for the offer
- Perform ID verification
- Submit the offer
- Once the policy is issued, access and manage their policy details

## Integration Steps

1. [Getting Started with GraphQL API](/customer-digital-onboarding/graphql-api)
2. [Integrating Single Sign-On](/customer-digital-onboarding/single-sign-on)
3. [Creating Offers with Customer Onboarding](/customer-digital-onboarding/creating-offers)

## Supported Products

- 🇩🇪 [Liechtenstein Life Invest](https://liechtensteinlife.com/en-DE/markets/de/products/liechtenstein-life-invest)
- 🇩🇪 ~~yourlife netto plus~~ — **deprecated**, no new integrations accepted

## Need Help?

If you need assistance with the integration or have questions about the onboarding flow, please reach out to our support team.


---

## Integrating Single Sign-On

URL: https://partner-docs.life.li/customer-digital-onboarding/single-sign-on

# Integrating Single Sign-On

[Partner Life](https://partner.life.li) is our comprehensive portal for partners to manage contracts, support requests, customer information, and policy changes. This guide explains how to integrate your existing authentication system with Partner Life.

## Prerequisites

Before you begin, ensure you have:

- Your API Key
- You have your Partner ID (mentioned in your Partner Life invitation email) - (it looks like: `123000`, `23330-2`, etc.)
- You have the Partner IDs of your sub-brokers and employee accounts (found in their respective welcome email or in the colleague section of your Partner Life Account)

## Integration Steps

### 1. Basic Setup

First, set up access to our GraphQL API as described in the [GraphQL API Guide](/customer-digital-onboarding/graphql-api).

### 2. Generate Magic Links

Use the `createPartnerLifeMagicLink` mutation to generate direct access links to Partner Life:

```graphql
mutation Mutation($input: CreatePartnerLifeMagicLinkInput!) {
  createPartnerLifeMagicLink(input: $input) {
    __typename
    ... on PartnerLifeMagicLink {
      id
      magicLinkUrl
    }
    ... on ErrorInterface {
      message
    }
  }
}
```

Example input:

```json
{
  "input": {
    "partnerId": "12345",
    "alreadyMultiFactorAuthenticated": true,
    "acceptPartnerLifeTermsAndConditions": true,
    "acknowledgePartnerLifePrivacyPolicy": true
  }
}
```

### 3. Authentication Flow

The basic authentication flow works as follows:

```mermaid
sequenceDiagram
    participant B as Broker/Employee
    participant Y as Your Software
    participant P as Partner API
    participant L as partner.life.li
    B->>+Y: Normal Authentication
    Y->>+P: trigger createPartnerLifeMagicLink API
    P-->>-Y: Response (with magic-link)
    Y->>+L: redirect to magic-link (automatically login user)
    L->>+L: Multi-factor Authentication Check (SMS/Passkey)
```

### 4. Multi-Factor Authentication

If your system already implements MFA, you can skip Partner Life's MFA check:

```mermaid
sequenceDiagram
    participant B as Broker/Employee
    participant Y as Your Software
    participant P as Partner API
    participant L as partner.life.li
    B->>+Y: Multi-factor authenticated
    Y->>+P: trigger createPartnerLifeMagicLink API<br>(setting alreadyMultiFactorAuthenticated as true)
    P-->>-Y: Response (with magic-link)
    Y->>+L: redirect to magic-link<br>(automatically login user, no MFA check)
```

## Auto-Activation of Accounts

For new users with a Partner ID but no active account, you can automatically create their account by:

1. Setting both `acceptPartnerLifeTermsAndConditions` and `acknowledgePartnerLifePrivacyPolicy` to `true`
2. Ensuring the user has accepted:
   - [Terms and Conditions](https://partner.life.li/en/terms-and-conditions)
   - [Privacy Policy](https://partner.life.li/en/privacy-policy)

## Need Help?

If you don't have access to Partner Life or need assistance, contact [partner support](mailto:support@partner.life.li).


---

## Integration Options

URL: https://partner-docs.life.li/


# Integration Options

Welcome to Prosperity's Partner Integration documentation. We offer several integration options to suit your needs:

## Customer Digital Onboarding

Create a partial offer through the API and let customers continue editing the offer through the app.

<a href="/customer-digital-onboarding">
  Learn more about Customer Digital Onboarding →
</a>

## Platform Integration

Create a complete offer with all required information, and get the policy documents (or continue working on it on Partner Life).

<a href="/platform-integrations">Learn more about Platform Integration →</a>

## Embed Our Widgets

Add our calculators and onboarding widgets on your website, allow customers to start creating offers.

<a href="/widgets/embedded-calculator">Learn more about Embedded Widgets →</a>

## AI-Assisted Integration

Using an AI coding assistant? Download our AI integration prompt or connect via llms.txt to let your AI build the integration with full schema knowledge.

<a href="/ai-integration">Set Up AI-Assisted Integration →</a>

## Need Help?

If you need assistance with integration or have questions, please don't hesitate to reach out to our support team.


---

## Creating Offers and Generating Documents

URL: https://partner-docs.life.li/platform-integrations/creating-offers


# Creating Offers and Generating Documents

## Prerequisites

- You have received your API Key (for stable and production environment)

## Creating Offers for New Customers

### Option 1: Download Application Document

If you already have information about the customer within your internal system, you can directly create an offer using the Partner Platform API mutation `createOffer`. This will:

1. Create the customer in our system
2. Generate a `Contract ID`
3. Allow you to request the application form PDF

```mermaid
sequenceDiagram
    participant Y as Your Software
    participant P as Partner API
    Y->>+P: Trigger createOffer API
    P-->>-Y: Response (with Contract ID)
    Y->>+P: Trigger offer(with Contract ID)
    P-->>-Y: Returns PDF download link (valid for 5 minutes)
    Y->>+P: Request and download the PDF
```

Wait approximately 30 seconds before requesting documents after creating an offer. This allows our systems to sync with the insurance system.

### Option 2: Partner Life Integration

You can also view the offer in Partner Life by using:

1. The `Contract ID` as a redirect parameter
2. A magic link generated using `createPartnerLifeMagicLink` mutation

The URL format will be:

```
https://partner.life.li/en/magic-link/<Magic Link Token>?redirect=%2Fmy%2Foffers%2F<Contract ID>
```

This will automatically log in the partner and redirect them to the offer page.

```mermaid
sequenceDiagram
    participant Y as Your Software
    participant P as Partner API
    participant L as Partner Life
    Y->>+P: Trigger createOffer API
    P-->>-Y: Response (with Contract ID)
    Y->>+P: Trigger createPartnerLifeMagicLink API
    P-->>-Y: Response (magic link)
    Y->>+L: Redirect to Partner Life
```

### Option 3: End-to-End Submission via API

If you want to own the entire offer lifecycle inside your own software — collecting the signed application form, uploading identity documents, and submitting the offer for issuance — use the upload + submit mutations on top of Option 1. Nothing about Option 1 changes; this option simply continues from the downloaded PDF.

1. Create the offer with `createOffer` and download the application form PDF (Option 1)
2. Get the customer to sign the application form
3. Upload the signed form and the customer's identity document with `uploadDocument`
4. Submit the offer for issuance with `submitOffer`
5. (Optional) Track the offer lifecycle with `offerStatus` and respond to any `openReworks`

```mermaid
sequenceDiagram
    participant Y as Your Software
    participant P as Partner API
    Note over Y,P: Option 1: createOffer + download PDF
    Note over Y: Customer signs the application form
    Y->>+P: uploadDocument (SIGNED_APPLICATION_FORM)
    P-->>-Y: DocumentUploaded
    Y->>+P: uploadDocument (IDENTITY_VERIFICATION)
    P-->>-Y: DocumentUploaded
    Y->>+P: submitOffer(contractID)
    P-->>-Y: SubmittedOffer
```

See the [Uploading Required Documents](#uploading-required-documents) and [Submitting the Offer](#submitting-the-offer) sections below for the full mutation reference.

## Creating Offers for Existing Customers

For customers who already have a policy or offer where you are the broker, you can:

1. Use their customer ID (from our system)
2. Use their email address linked to existing policies

```mermaid
sequenceDiagram
    participant Y as Your Software
    participant P as Partner API
    Y->>+P: Create offer with customer email/ID
    P-->>-Y: Response (with Contract ID)
    Y->>+P: Request application form
    P-->>-Y: PDF download link (valid for 5 minutes)
```

We will soon provide a way to fetch the list of customers associated with your Partner account (including sub-brokers) using the `customers` query with filters.

## API Reference

### Creating a New Offer

The `createOffer` mutation handles both new and existing customers. The operation includes comprehensive error handling:

```graphql
mutation CreateOffer($input: CreateOfferInput!) {
  createOffer(input: $input) {
    ... on ErrorInterface {
      __typename
      message
    }
    ... on CreatedOffer {
      contractID
    }
    ... on InsuranceSystemError {
      reasons
    }
    ... on InputValidationError {
      invalidInput
      message
    }
  }
}
```

<CopyPrompt label="Create Liechtenstein Life Invest offer" prompt={CREATE_OFFER_LL_INVEST_PROMPT} />

<details id="example-liechtenstein-life-invest">
<summary>Example: Liechtenstein Life Invest</summary>

```json
{
  "input": {
    "liechtensteinLifeInvest": {
      "associatedPersons": [
        {
          "role": [
            "MAILING",
            "INSURED_PERSON",
            "POLICY_HOLDER",
            "PAYER",
            "ECONOMIC_INTEREST"
          ],
          "person": {
            "newCustomer": {
              "email": "sampleEmailAddress@example.com",
              "firstName": "John",
              "lastName": "Doe",
              "gender": "MALE",
              "dateOfBirth": "2000-04-06",
              "maritalStatus": "SINGLE",
              "nationality": "DE",

              "profession": "Lawyer",
              "occupation": "Lawyer",
              "taxIdentification": {
                "taxLiableInUSA": false,
                "residencies": [
                  {
                    "country": "DE",
                    "id": "96618720548"
                  }
                ]
              },
              "phoneNumber": "+4900000000",
              "address": {
                "country": "DE",
                "city": "berlin",
                "street": "Frankfuter-Alle",
                "zip": "10367",
                "houseNumber": "23A",
                "streetAppendix": "8th Cross"
              },
              "identification": {
                "birthPlace": "Tokyo",
                "documentNumber": "AR12333323232",
                "documentType": "PASSPORT",
                "issueDate": "2025-01-01",
                "issuedBy": "Govt of Japan",
                "validUntil": "2026-01-01"
              }
            }
          }
        }
      ],
      "productConfiguration": {
        "premiumDynamicPercentage": 10,
        "ageUntilPremiumIsPaid": 73,
        "additionalPayment": 1000000,
        "ageWhenPolicyEnds": 82,
        "monthlyPremium": 10000,
        "startDate": "2025-05-01",
        "language": "DE_DE",
        "deathCoveragePercentage": 100,
        "investmentStrategy": {
          "riskLevel": "MEDIUM",
          "fundSelection": [
            {
              "id": "IE0004766675",
              "percentage": 100
            }
          ],
          "goals": {
            "taxBenefit": false,
            "flexibility": true,
            "longTerm": true
          },
          "rebalancingType": "DYNAMIC",
          "sustainabilityDetails": {
            "environmentalAndSocialInvestmentFocusLevel": "SIGNIFICANT",
            "percentage": 0,
            "topicsToExclude": ["TOBACCO_INDUSTRY"],
            "topicsToInclude": [],
            "customerKnowledgeStatus": "NO_PRE_EXISTING_KNOWLEDGE_BUT_EDUCATED_BY_BROKER"
          }
        }
      },
      "customerFinancialStatus": {
        "moneyOrigin": "SAVINGS",
        "paymentMethod": {
          "wireTransfer": true
        },
        "policyReason": "PRIVATE_PENSION",
        "totalMonthlyExpenses": 100000,
        "totalMonthlyNetIncome": 400000,
        "moneyOriginOtherText": null,
        "policyReasonOtherText": null
      },
      "insuredPersonsHealthStatus": {
        "hasCriticalIllness": false,
        "criticalIllnessDetails": null,
        "weight": 47,
        "height": 156
      }
    }
  }
}
```

</details>

<CopyPrompt label="Create Liechtenstein Life Wealth offer" prompt={CREATE_OFFER_LL_WEALTH_PROMPT} />

<details id="example-liechtenstein-life-wealth">
<summary>Example: Liechtenstein Life Wealth</summary>

```json
{
  "input": {
    "liechtensteinLifeWealth": {
      "associatedPersons": [
        {
          "role": [
            "POLICY_HOLDER",
            "INSURED_PERSON",
            "PAYER",
            "MAILING",
            "ECONOMIC_INTEREST"
          ],
          "person": {
            "newCustomer": {
              "email": "policyHolder@example.com",
              "firstName": "John",
              "lastName": "Doe",
              "gender": "MALE",
              "dateOfBirth": "1976-04-06",
              "maritalStatus": "SINGLE",
              "nationality": "DE",
              "profession": "Lawyer",
              "occupation": "Lawyer",
              "taxIdentification": {
                "taxLiableInUSA": false,
                "residencies": [
                  {
                    "country": "DE",
                    "id": "96618720548"
                  }
                ]
              },
              "phoneNumber": "+4900000000",
              "address": {
                "country": "DE",
                "city": "berlin",
                "street": "Frankfuter-Alle",
                "zip": "10367",
                "houseNumber": "23A",
                "streetAppendix": "8th Cross"
              },
              "identification": {
                "birthPlace": "Tokyo",
                "documentNumber": "AR12333323232",
                "documentType": "PASSPORT",
                "issueDate": "2025-01-01",
                "issuedBy": "Govt of Japan",
                "validUntil": "2026-01-01"
              }
            }
          }
        },
        {
          "role": ["ADDITIONAL_INSURED_PERSON"],
          "person": {
            "newCustomer": {
              "email": "additionalInduredPerson@example.com",
              "firstName": "John",
              "lastName": "Doe",
              "gender": "MALE",
              "dateOfBirth": "2000-04-06",
              "maritalStatus": "SINGLE",
              "nationality": "DE",
              "profession": "Lawyer",
              "occupation": "Lawyer",
              "taxIdentification": {
                "taxLiableInUSA": false,
                "residencies": [
                  {
                    "country": "DE",
                    "id": "96618720548"
                  }
                ]
              },
              "phoneNumber": "+4900000000",
              "address": {
                "country": "DE",
                "city": "berlin",
                "street": "Frankfuter-Alle",
                "zip": "10367",
                "houseNumber": "23A",
                "streetAppendix": "8th Cross"
              }
            }
          }
        },
        {
          "role": ["ADDITIONAL_POLICY_HOLDER"],
          "person": {
            "newCustomer": {
              "email": "additionalPolicyHolder@example.com",
              "firstName": "Jane",
              "lastName": "Doe",
              "gender": "MALE",
              "dateOfBirth": "1978-04-06",
              "maritalStatus": "SINGLE",
              "nationality": "DE",
              "profession": "Lawyer",
              "occupation": "Lawyer",
              "taxIdentification": {
                "taxLiableInUSA": false,
                "residencies": [
                  {
                    "country": "DE",
                    "id": "96618720548"
                  }
                ]
              },
              "phoneNumber": "+4900000000",
              "address": {
                "country": "DE",
                "city": "berlin",
                "street": "Frankfuter-Alle",
                "zip": "10367",
                "houseNumber": "23A",
                "streetAppendix": "8th Cross"
              }
            }
          }
        }
      ],
      "productConfiguration": {
        "premiumDynamicPercentage": 10,
        "ageUntilPremiumIsPaid": 73,
        "additionalPayment": 1000000,
        "ageWhenPolicyEnds": 73,
        "regularPremium": 50000,
        "startDate": "2025-07-01",
        "language": "DE_DE",
        "minimumDeathBenefit": "TAX_MINIMUM",
        "additionalDeathBenefit": 150,
        "investmentStrategy": {
          "riskLevel": "MEDIUM",
          "fundSelection": [
            {
              "id": "IE0004766675",
              "percentage": 100
            }
          ],
          "goals": {
            "taxBenefit": false,
            "flexibility": true,
            "longTerm": true
          },
          "rebalancingType": "DYNAMIC",
          "sustainabilityDetails": {
            "environmentalAndSocialInvestmentFocusLevel": "SIGNIFICANT",
            "percentage": 0,
            "topicsToExclude": ["TOBACCO_INDUSTRY"],
            "topicsToInclude": [],
            "customerKnowledgeStatus": "NO_PRE_EXISTING_KNOWLEDGE_BUT_EDUCATED_BY_BROKER"
          }
        },
        "termFix": {
          "events": "BIRTH_OF_CHILD",
          "term": "2031-01-01",
          "funds": [
            {
              "id": "IE0004766675",
              "percentage": 100
            }
          ]
        },
        "premiumMode": null,
        "payoutPlan": {
          "schedules": [
            {
              "start": "2030-09-01",
              "end": "2034-09-01",
              "amount": 100000,
              "frequency": "MONTHLY"
            },
            {
              "start": "2035-09-01",
              "end": "2037-09-01",
              "amount": 100000,
              "frequency": "MONTHLY"
            }
          ],
          "iban": "DE75512108001245126199",
          "accountHolder": "John Doe"
        },
        "maturityManagement": true,
        "deathCoveragePayout": "FIRST_TO_DIE",
        "additionalPolicyHolderPercentage": 50
      },
      "customerFinancialStatus": {
        "moneyOrigin": "SAVINGS",
        "paymentMethod": {
          "wireTransfer": true
        },
        "policyReason": "PRIVATE_PENSION",
        "totalMonthlyExpenses": 100000,
        "totalMonthlyNetIncome": 400000,
        "moneyOriginOtherText": null,
        "policyReasonOtherText": null
      },
      "insuredPersonsHealthStatus": {
        "hasCriticalIllness": false,
        "hasNoMedicalConditions": true,
        "hasNoMedicalConsultation": true,
        "criticalIllnessDetails": null,
        "weight": 47,
        "height": 156
      },
      "additionalInsuredPersonsHealthStatus": {
        "hasCriticalIllness": false,
        "hasNoMedicalConditions": true,
        "hasNoMedicalConsultation": true,
        "criticalIllnessDetails": null,
        "weight": 47,
        "height": 156
      },
      "beneficiaries": {
        "lifeBeneficiary": {
          "beneficiaryType": "POLICY_HOLDER"
        },
        "deathBeneficiary": {
          "beneficiaryType": "PARTNER"
        },
        "isDeathBeneficiaryIrrevocable": true,
        "beneficiaryRights": "REVOCABLE",
        "termFixRights": "REVOCABLE"
      }
    }
  }
}
```

</details>

<CopyPrompt label="Create Prosperity Plus Germany offer" prompt={CREATE_OFFER_PP_GERMANY_PROMPT} />

<details id="example-prosperity-plus-germany">
<summary>Example: Prosperity Plus Germany</summary>

```json
{
  "input": {
    "prosperityPlusGermany": {
      "associatedPersons": [
        {
          "role": [
            "MAILING",
            "INSURED_PERSON",
            "POLICY_HOLDER",
            "PAYER",
            "ECONOMIC_INTEREST"
          ],
          "person": {
            "newCustomer": {
              "email": "sampleEmailAddress@example.com",
              "firstName": "John",
              "lastName": "Doe",
              "gender": "MALE",
              "dateOfBirth": "2000-04-06",
              "maritalStatus": "SINGLE",
              "nationality": "DE",
              "profession": "Lawyer",
              "occupation": "Lawyer",
              "taxIdentification": {
                "taxLiableInUSA": false,
                "residencies": [
                  {
                    "country": "DE",
                    "id": "96618720548"
                  }
                ]
              },
              "phoneNumber": "+4900000000",
              "address": {
                "country": "DE",
                "city": "berlin",
                "street": "Frankfuter-Alle",
                "zip": "10367",
                "houseNumber": "23A",
                "streetAppendix": "8th Cross"
              },
              "identification": {
                "birthPlace": "Tokyo",
                "documentNumber": "AR12333323232",
                "documentType": "PASSPORT",
                "issueDate": "2025-01-01",
                "issuedBy": "Govt of Japan",
                "validUntil": "2026-01-01"
              }
            }
          }
        }
      ],
      "productConfiguration": {
        "premiumDynamicPercentage": 10,
        "ageUntilPremiumIsPaid": 73,
        "additionalPayment": 1000000,
        "ageWhenPolicyEnds": 82,
        "monthlyPremium": 10000,
        "maturityManagement": true,
        "premiumWaiver": true,
        "startDate": "2025-08-01",
        "language": "DE_DE",
        "deathCoveragePercentage": 100,
        "investmentStrategy": {
          "riskLevel": "MEDIUM",
          "fundSelection": [
            {
              "id": "IE0004766675",
              "percentage": 100
            }
          ],
          "goals": {
            "taxBenefit": false,
            "flexibility": true,
            "longTerm": true
          },
          "rebalancingType": "DYNAMIC",
          "sustainabilityDetails": {
            "environmentalAndSocialInvestmentFocusLevel": "SIGNIFICANT",
            "percentage": 0,
            "topicsToExclude": ["TOBACCO_INDUSTRY"],
            "topicsToInclude": [],
            "customerKnowledgeStatus": "NO_PRE_EXISTING_KNOWLEDGE_BUT_EDUCATED_BY_BROKER"
          }
        },
        "brokerageFeePayoutMethod": "GROSS"
      },
      "customerFinancialStatus": {
        "moneyOrigin": "SAVINGS",
        "paymentMethod": {
          "wireTransfer": true
        },
        "policyReason": "PRIVATE_PENSION",
        "totalMonthlyExpenses": 100000,
        "totalMonthlyNetIncome": 400000,
        "moneyOriginOtherText": null,
        "policyReasonOtherText": null
      },
      "insuredPersonsHealthStatus": {
        "hasCriticalIllness": false,
        "criticalIllnessDetails": null,
        "weight": 47,
        "height": 156
      }
    }
  }
}
```

</details>

<CopyPrompt label="Create Liechtenstein Life Pension offer" prompt={CREATE_OFFER_LL_PENSION_PROMPT} />

<details id="example-liechtenstein-life-pension">
<summary>Example: Liechtenstein Life Pension (Basisrente)</summary>

- **Beneficiaries**: Death beneficiary is restricted to `PARTNER` only — this is a regulatory requirement for German Basisrente products (Schicht 1)
- **No life beneficiary**: Life beneficiaries are not supported
- **No premium dynamic**: `premiumDynamicPercentage` is not supported — omit this field
- **Guarantee options**: `NO_GUARANTEE`, `SELECT_50`, `SELECT_80`
- **`lifelong_pension_purpose`**: Always enforced as `true` regardless of the `goals.longTerm` input value

```json
{
  "input": {
    "liechtensteinLifePension": {
      "associatedPersons": [
        {
          "role": [
            "MAILING",
            "INSURED_PERSON",
            "POLICY_HOLDER",
            "PAYER",
            "ECONOMIC_INTEREST"
          ],
          "person": {
            "newCustomer": {
              "email": "sampleEmailAddress@example.com",
              "firstName": "John",
              "lastName": "Doe",
              "gender": "MALE",
              "dateOfBirth": "1985-06-15",
              "maritalStatus": "SINGLE",
              "nationality": "DE",
              "profession": "Software Engineer",
              "occupation": "Software Engineer",
              "taxIdentification": {
                "taxLiableInUSA": false,
                "residencies": [
                  {
                    "country": "DE",
                    "id": "96618720548"
                  }
                ]
              },
              "phoneNumber": "+4900000000",
              "address": {
                "country": "DE",
                "city": "Berlin",
                "street": "Musterstraße",
                "zip": "10115",
                "houseNumber": "1"
              },
              "identification": {
                "birthPlace": "Berlin",
                "documentNumber": "C01X00T478",
                "documentType": "ID_CARD",
                "issueDate": "2020-01-15",
                "issuedBy": "Stadt Berlin",
                "validUntil": "2030-01-15"
              }
            }
          }
        }
      ],
      "productConfiguration": {
        "ageUntilPremiumIsPaid": 67,
        "additionalPayment": 0,
        "ageWhenPolicyEnds": 67,
        "monthlyPremium": 10000,
        "maturityManagement": true,
        "premiumWaiver": true,
        "guarantee": "SELECT_80",
        "startDate": "2026-05-01",
        "language": "DE_DE",
        "deathCoveragePercentage": 0,
        "investmentStrategy": {
          "riskLevel": "MEDIUM",
          "fundSelection": [
            {
              "id": "AT0000A08LD9",
              "percentage": 100
            }
          ],
          "goals": {
            "taxBenefit": true,
            "flexibility": false,
            "longTerm": true
          },
          "rebalancingType": "NORMAL",
          "sustainabilityDetails": {
            "environmentalAndSocialInvestmentFocusLevel": "SIGNIFICANT",
            "percentage": 0,
            "topicsToExclude": [],
            "topicsToInclude": [],
            "customerKnowledgeStatus": "NO_PRE_EXISTING_KNOWLEDGE_BUT_EDUCATED_BY_BROKER"
          }
        },
        "absoluteReductionFundAdministrationCost": 0.5
      },
      "customerFinancialStatus": {
        "moneyOrigin": "SAVINGS",
        "paymentMethod": {
          "wireTransfer": true
        },
        "policyReason": "PRIVATE_PENSION",
        "totalMonthlyExpenses": 150000,
        "totalMonthlyNetIncome": 500000,
        "moneyOriginOtherText": null,
        "policyReasonOtherText": null
      },
      "insuredPersonsHealthStatus": {
        "hasCriticalIllness": false,
        "criticalIllnessDetails": null,
        "weight": 80,
        "height": 180
      },
      "beneficiaries": {
        "deathBeneficiary": "PARTNER",
        "isDeathBeneficiaryIrrevocable": false
      }
    }
  }
}
```

</details>

<CopyPrompt label="Create Value Invest VWL offer" prompt={CREATE_OFFER_VWL_PROMPT} />

<details id="example-value-invest-vwl">
<summary>Example: Value Invest VWL (employer-funded)</summary>

**VWL** (Vermögenswirksame Leistungen) is a German employer-funded capital-forming benefit. The employer pays a fixed monthly contribution into a contract held by the employee.

- **Exactly two associated persons required**:
  - **Employer (corporate entity)** — Roles: `[PAYER]` only. Provide either `existingCustomer` (employer already onboarded) or `newCompanyCustomer` (create the employer inline as part of the offer). `newCustomer` is rejected for PAYER because it cannot represent a company.
  - **Employee** — the contract holder. Roles: `[POLICY_HOLDER, INSURED_PERSON, MAILING, ECONOMIC_INTEREST]` — all four, exactly. Employee can be a new or existing individual customer. `newCompanyCustomer` is rejected for non-PAYER roles.
- **Onboard the employer once**: each employer should be created in our system once and re-used across all their employees' offers. Use `newCompanyCustomer` on the first offer for a new employer, then reference the same employer via `existingCustomer.byEmail` on subsequent offers.
- **Tariff**: `value invest VWL 2022` (fixed)
- **Currency**: EUR (amounts in cents — `4000` = EUR 40.00, the typical VWL contribution)
- **Language**: `DE_DE` only — VWL is a German-market product
- **Required**: `personalNumber` — the employer's internal payroll identifier for the employee
- **No premium dynamic**: `premiumDynamicPercentage` is not part of the schema
- **No health questionnaire**: `insuredPersonsHealthStatus` is omitted
- **Guarantee options**: `NO_GUARANTEE`, `SELECT_50`, `SELECT_80`
- **Death beneficiary**: `PARTNER` or `HEIRS`

The example below shows the most common shape: a brand-new employer (`newCompanyCustomer`) plus a brand-new employee (`newCustomer`) on the same request. For subsequent offers tied to the **same** employer, swap the `PAYER` entry to `{ "existingCustomer": { "byEmail": { "email": "hr@acme.example" } } }` — keep the rest unchanged.

```json
{
  "input": {
    "valueInvestVWL": {
      "associatedPersons": [
        {
          "role": ["PAYER"],
          "person": {
            "newCompanyCustomer": {
              "name": "Acme GmbH",
              "additionalName": "Acme Trading",
              "contactName": "HR Department",
              "legalForm": "GmbH",
              "financialInstitution": false,
              "email": "hr@acme.example",
              "mobilePhone": "+4915000000000",
              "landline": "+493012345678",
              "address": {
                "country": "DE",
                "city": "Berlin",
                "street": "Unter den Linden",
                "zip": "10117",
                "houseNumber": "1"
              },
              "taxInformation": {
                "taxLiableInUSA": false,
                "vatNumber": "DE123456789",
                "taxIDCountry": "DE"
              }
            }
          }
        },
        {
          "role": [
            "POLICY_HOLDER",
            "INSURED_PERSON",
            "MAILING",
            "ECONOMIC_INTEREST"
          ],
          "person": {
            "newCustomer": {
              "email": "employee@example.com",
              "firstName": "Anna",
              "lastName": "Schmidt",
              "gender": "FEMALE",
              "dateOfBirth": "1992-03-14",
              "maritalStatus": "SINGLE",
              "nationality": "DE",
              "profession": "Mechatronics Engineer",
              "occupation": "Mechatronics Engineer",
              "taxIdentification": {
                "taxLiableInUSA": false,
                "residencies": [
                  { "country": "DE", "id": "12345678911" }
                ]
              },
              "phoneNumber": "+4901701234567",
              "address": {
                "country": "DE",
                "city": "Munich",
                "street": "Leopoldstraße",
                "zip": "80802",
                "houseNumber": "12"
              },
              "identification": {
                "birthPlace": "Munich",
                "documentNumber": "L01XY12345",
                "documentType": "ID_CARD",
                "issueDate": "2022-01-15",
                "issuedBy": "Stadt München",
                "validUntil": "2032-01-15"
              }
            }
          }
        }
      ],
      "productConfiguration": {
        "personalNumber": "EMP-2026-0042",
        "startDate": "2026-06-01",
        "language": "DE_DE",
        "ageWhenPolicyEnds": 67,
        "monthlyPremium": 4000,
        "additionalPayment": 0,
        "guarantee": "SELECT_80",
        "investmentStrategy": {
          "riskLevel": "MEDIUM",
          "fundSelection": [
            { "id": "AT0000A08LD9", "percentage": 100 }
          ],
          "goals": {
            "taxBenefit": false,
            "flexibility": false,
            "longTerm": true
          },
          "rebalancingType": "NORMAL",
          "sustainabilityDetails": {
            "environmentalAndSocialInvestmentFocusLevel": "SIGNIFICANT",
            "percentage": 0,
            "topicsToExclude": [],
            "topicsToInclude": [],
            "customerKnowledgeStatus": "NO_PRE_EXISTING_KNOWLEDGE_BUT_EDUCATED_BY_BROKER"
          }
        }
      },
      "customerFinancialStatus": {
        "moneyOrigin": "EARNED_INCOME",
        "paymentMethod": {
          "wireTransfer": true
        },
        "policyReason": "PRIVATE_PENSION",
        "totalMonthlyExpenses": 180000,
        "totalMonthlyNetIncome": 320000
      },
      "beneficiaries": {
        "deathBeneficiary": "PARTNER",
        "isDeathBeneficiaryIrrevocable": false
      }
    }
  }
}
```

</details>

<details id="example-your-life-netto-plus">
<summary>Example: Your Life Netto Plus (Deprecated)</summary>

**yourlife netto plus is deprecated.** New integrations are no longer being accepted for this product. Existing integrations remain supported, but new partners should use one of the other Germany products (Liechtenstein Life Invest, Liechtenstein Life Wealth, Liechtenstein Life Pension, Prosperity Plus Germany) instead. Contact your integration partner manager if you have questions about migrating off YLN+.

```json
{
  "input": {
    "yourLifeNettoPlus": {
      "associatedPersons": [
        {
          "role": [
            "POLICY_HOLDER",
            "INSURED_PERSON",
            "PAYER",
            "MAILING",
            "ECONOMIC_INTEREST"
          ],
          "person": {
            "newCustomer": {
              "email": "sampleEmailAddress@example.com",
              "firstName": "Max",
              "lastName": "Mustermann",
              "dateOfBirth": "1990-01-15",
              "gender": "MALE",
              "maritalStatus": "SINGLE",
              "nationality": "DE",
              "address": {
                "street": "Musterstraße",
                "houseNumber": "1",
                "zip": "10115",
                "city": "Berlin",
                "country": "DE"
              },
              "mobilePhone": "+491701234567",
              "profession": "Software Engineer",
              "taxIdentification": {
                "taxLiableInUSA": false,
                "residencies": [
                  {
                    "id": "12345678911",
                    "country": "DE"
                  }
                ]
              }
            }
          }
        }
      ],
      "productConfiguration": {
        "startDate": "2026-04-01",
        "ageWhenPolicyEnds": 67,
        "monthlyPremium": 10000,
        "additionalPayment": 0,
        "deathCoveragePercentage": 100,
        "investmentStrategy": {
          "goals": {
            "longTerm": true,
            "taxBenefit": false,
            "flexibility": true
          },
          "sustainabilityDetails": {
            "customerKnowledgeStatus": "WAIVED_CONSULTATION_DUE_TO_PRE_EXISTING_KNOWLEDGE",
            "percentage": 0
          },
          "fundSelection": [
            {
              "id": "LU0360863863",
              "percentage": 100
            }
          ],
          "riskLevel": "MEDIUM"
        }
      },
      "customerFinancialStatus": {
        "policyReason": "PRIVATE_PENSION",
        "moneyOrigin": "EARNED_INCOME",
        "totalMonthlyNetIncome": 500000,
        "totalMonthlyExpenses": 300000,
        "paymentMethod": {
          "directDebit": {
            "iban": "DE89370400440532013000",
            "accountHolder": "Max Mustermann"
          }
        }
      },
      "insuredPersonsHealthStatus": {
        "hasCriticalIllness": false
      }
    }
  }
}
```

</details>

<CopyPrompt label="Create offer for existing customer" prompt={CREATE_OFFER_EXISTING_CUSTOMER_PROMPT} />

<details>
<summary>Example: Using Existing Customer</summary>

```json
{
  "input": {
    "liechtensteinLifeInvest": {
      "associatedPersons": [
        {
          "role": [
            "MAILING",
            "INSURED_PERSON",
            "POLICY_HOLDER",
            "PAYER",
            "ECONOMIC_INTEREST"
          ],
          "person": {
            "existingCustomer": {
              "byEmail": {
                "email": "sampleEmailAddressNetto4@test.com"
              }
            }
          }
        }
      ],
      "productConfiguration": {
        "additionalPayment": 1000000,
        "ageWhenPolicyEnds": 82,
        "monthlyPremium": 10000,
        "startDate": "2025-05-01",
        "language": "DE_DE",
        "deathCoveragePercentage": 100,
        "investmentStrategy": {
          "riskLevel": "MEDIUM",
          "fundSelection": [
            {
              "id": "IE0004766675",
              "percentage": 100
            }
          ],
          "goals": {
            "taxBenefit": false,
            "flexibility": true,
            "longTerm": true
          },
          "rebalancingType": "DYNAMIC",
          "sustainabilityDetails": {
            "environmentalAndSocialInvestmentFocusLevel": "SIGNIFICANT",
            "percentage": 0,
            "topicsToExclude": ["TOBACCO_INDUSTRY"],
            "topicsToInclude": [],
            "customerKnowledgeStatus": "NO_PRE_EXISTING_KNOWLEDGE_BUT_EDUCATED_BY_BROKER"
          }
        }
      },
      "customerFinancialStatus": {
        "moneyOrigin": "SAVINGS",
        "paymentMethod": {
          "wireTransfer": true
        },
        "policyReason": "PRIVATE_PENSION",
        "totalMonthlyExpenses": 100000,
        "totalMonthlyNetIncome": 400000,
        "moneyOriginOtherText": null,
        "policyReasonOtherText": null
      },
      "insuredPersonsHealthStatus": {
        "hasCriticalIllness": false,
        "criticalIllnessDetails": null,
        "weight": 47,
        "height": 156
      }
    }
  }
}
```

</details>

<CopyPrompt label="Create Prosperity 3A offer" prompt={CREATE_OFFER_P3A_PROMPT} />

<details id="example-prosperity-3a-swiss-pillar-3a">
<summary>Example: Prosperity 3A (Swiss Pillar 3a)</summary>

```json
{
  "input": {
    "prosperity3A": {
      "associatedPersons": [
        {
          "role": [
            "MAILING",
            "INSURED_PERSON",
            "POLICY_HOLDER",
            "PAYER",
            "ECONOMIC_INTEREST"
          ],
          "person": {
            "newCustomer": {
              "email": "sampleEmailAddress@example.com",
              "firstName": "James",
              "lastName": "Jones",
              "gender": "MALE",
              "dateOfBirth": "1975-07-21",
              "maritalStatus": "MARRIED",
              "nationality": "CH",
              "profession": "IT",
              "occupation": "Analyst",
              "taxIdentification": {
                "taxLiableInUSA": false,
                "residencies": [
                  {
                    "country": "CH",
                    "id": "756.9217.0769.85"
                  }
                ]
              },
              "phoneNumber": "+41000000000",
              "address": {
                "country": "CH",
                "city": "Ruggell",
                "street": "Industriering",
                "zip": "9491",
                "houseNumber": "3",
                "streetAppendix": null
              },
              "identification": {
                "birthPlace": "Zürich",
                "documentNumber": "P123457689",
                "documentType": "PASSPORT",
                "issueDate": "2014-03-21",
                "issuedBy": "Zurich Tax Hall",
                "validUntil": "2028-03-21"
              }
            }
          }
        }
      ],
      "productConfiguration": {
        "startDate": "2026-05-01",
        "ageWhenPolicyEnds": 65,
        "monthlyPremium": 15000,
        "premiumMode": "MONTHLY",
        "premiumDynamicPercentage": 3,
        "additionalPayment": 100000,
        "transferExisting3APolicy": {
          "sourceType": "BANK",
          "amount": 500000,
          "name": "UBS AG",
          "address": "Bahnhofstrasse 45",
          "zip": "8001",
          "city": "Zürich"
        },
        "guarantee": "SELECT_50",
        "investmentStrategy": {
          "riskLevel": "MEDIUM",
          "fundSelection": [
            {
              "id": "LU0070176184",
              "percentage": 60
            },
            {
              "id": "LLA030",
              "percentage": 40
            }
          ],
          "goals": {
            "taxBenefit": true,
            "flexibility": true,
            "longTerm": true
          },
          "rebalancingType": "NORMAL",
          "lowRiskInvestment": false,
          "sustainabilityDetails": {
            "environmentalAndSocialInvestmentFocusLevel": "NORMAL",
            "percentage": 0,
            "topicsToExclude": [],
            "topicsToInclude": [],
            "customerKnowledgeStatus": "WAIVED_CONSULTATION_DUE_TO_PRE_EXISTING_KNOWLEDGE"
          }
        },
        "coverage": {
          "type": "CHOSEN",
          "amount": 1444000
        },
        "crossBorderTariffApplicable": false,
        "durationOverRetirement": false,
        "maturityManagement": true,
        "language": "DE_CH"
      },
      "insuredPersonsHealthStatus": {
        "worksAsSelfEmployed": false,
        "employmentWorkload": 100,
        "height": 180,
        "weight": 75,
        "existingInsuranceContract": {
          "hasExistingInsuranceContract": false
        },
        "hasAggravatedTermsContract": false,
        "additionalHealthRisk": {
          "hasAdditionalRisks": false
        },
        "knownDiseases": {
          "hasHadKnownDiseases": false
        },
        "hasExistingDisabilities": false,
        "medication": {
          "hasBeenRegularlyMedicated": false
        },
        "hospitalization": {
          "hasBeenHospitalized": false
        },
        "hasAnnuity": false,
        "drugAbuse": {
          "hasBeenTreatedForDrugAbuse": false
        },
        "smoking": {
          "hasSmoked": false
        },
        "hasHIV": false,
        "medicalPractitionerInformation": "Dr. Hans Müller, Bahnhofstrasse 10, 8001 Zürich"
      },
      "customerFinancialStatus": {
        "moneyOrigin": "SAVINGS",
        "policyReason": "PRIVATE_PENSION",
        "totalMonthlyExpenses": 300000,
        "totalMonthlyNetIncome": 800000,
        "moneyOriginOtherText": null,
        "policyReasonOtherText": null,
        "differentWealthOrigin": false,
        "paymentMethod": {
          "wireTransfer": true
        }
      }
    }
  }
}
```

- **All amounts are in the smallest monetary unit** — Rappen for CHF (1 CHF = 100 Rappen). For example, `15000` = CHF 150.00, `1000000` = CHF 10,000.00
- **Disability annuity** — requires `premiumWaiver` to be set. The `jobClass` and `jobRisk` must be a valid pair from the [job classes reference](/platform-integrations/job-classes)
- **Health questionnaire** — required when `premiumWaiver` or `disabilityAnnuity` is set. Uses `insuredPersonsHealthStatus` with Swiss-specific fields. Several fields are structured objects containing a boolean flag and optional detail fields (required when the flag is `true`): `existingInsuranceContract`, `additionalHealthRisk`, `knownDiseases`, `medication`, `hospitalization`, `drugAbuse`, `smoking`. For example, if the person has been hospitalized: `"hospitalization": { "hasBeenHospitalized": true, "hospitalizationDetails": "Appendectomy, March 2022" }`.
- **No beneficiaries** — the insurance system handles beneficiary defaults automatically
- **Payment method (optional)** — use `paymentMethod` in `customerFinancialStatus` to specify a Swiss-specific payment method. Available options:
  - `{ "wireTransfer": true }` — bank transfer
  - `{ "lsvPlus": { "iban": "CH...", "bic": "UBSWCHZH80A", "signatureDate": "2026-03-01" } }` — LSV+ (Swiss direct debit)
  - `{ "esr": true }` — ESR (Swiss payment slip)
  - If omitted, the insurance system auto-assigns a standing order
- **Risk level required** — the selected risk level must match the risk class of the selected funds
- **Currency is CHF** — Swiss pillar 3a products use Swiss Francs
- **Age range 60–70** — Swiss retirement age constraints apply (`ageWhenPolicyEnds` must be between 60 and 70)
- **Coverage block** — uses `coverage: { type, amount }` instead of `deathCoveragePercentage`
- **Guarantee** — optional capital guarantee at maturity (`NO_GUARANTEE`, `SELECT_50`, `SELECT_80`, `SELECT_90`, `SELECT_100`, or omit for none)
- **3A transfer** — use `transferExisting3APolicy` to transfer from an existing 3a account. Specify `sourceType` (`BANK` or `INSURANCE`), `amount`, and institution details. Insurance-to-insurance transfers automatically zero acquisition costs.
- **Premium mode** — use the `Prosperity3APremiumMode` enum (`ANNUALLY`, `SEMI_ANNUALLY`, `QUARTERLY`, `MONTHLY`). Defaults to `MONTHLY` if omitted.
- **Coverage type** — `CHOSEN` requires an `amount`; `PERCENTAGE` gives 101% of actuarial reserve (no amount needed)
- **Low risk investment** — `lowRiskInvestment` on the investment strategy is required and used by the insurance system to validate fund selection
- **Language** — use the `Prosperity3AContractLanguage` enum (`DE_DE`, `DE_CH`, `FR_FR`, `IT_IT`). Defaults to `DE_DE` if omitted.

</details>

<CopyPrompt label="Create Prosperity Plus (3B) offer" prompt={CREATE_OFFER_PP_3B_PROMPT} />

<details id="example-prosperity-plus-swiss-pillar-3b">
<summary>Example: Prosperity Plus (Swiss Pillar 3b)</summary>

```json
{
  "input": {
    "prosperityPlus": {
      "associatedPersons": [
        {
          "role": [
            "POLICY_HOLDER",
            "INSURED_PERSON",
            "PAYER",
            "MAILING",
            "ECONOMIC_INTEREST"
          ],
          "person": {
            "newCustomer": {
              "email": "sampleEmailAddress@example.com",
              "firstName": "James",
              "lastName": "Jones",
              "gender": "MALE",
              "dateOfBirth": "1985-07-21",
              "maritalStatus": "MARRIED",
              "nationality": "CH",
              "profession": "IT",
              "occupation": "Analyst",
              "taxIdentification": {
                "taxLiableInUSA": false,
                "residencies": [
                  {
                    "country": "CH",
                    "id": "756.9217.0769.85"
                  }
                ]
              },
              "phoneNumber": "+41000000000",
              "address": {
                "country": "CH",
                "city": "Ruggell",
                "street": "Industriering",
                "zip": "9491",
                "houseNumber": "3",
                "streetAppendix": null
              },
              "identification": {
                "birthPlace": "Zürich",
                "documentNumber": "P123457689",
                "documentType": "PASSPORT",
                "issueDate": "2014-03-21",
                "issuedBy": "Zurich Tax Hall",
                "validUntil": "2028-03-21"
              }
            }
          }
        }
      ],
      "productConfiguration": {
        "startDate": "2026-05-01",
        "ageWhenPolicyEnds": 65,
        "monthlyPremium": 10000,
        "premiumMode": "MONTHLY",
        "additionalPayment": 0,
        "hasSecondPillar": true,
        "guarantee": "NO_GUARANTEE",
        "investmentStrategy": {
          "riskLevel": "HIGH",
          "fundSelection": [
            {
              "id": "LU1894683009",
              "percentage": 100
            }
          ],
          "goals": {
            "taxBenefit": false,
            "flexibility": true,
            "longTerm": true
          },
          "rebalancingType": "NONE",
          "lowRiskInvestment": false,
          "sustainabilityDetails": {
            "environmentalAndSocialInvestmentFocusLevel": "NORMAL",
            "percentage": 0,
            "topicsToExclude": [],
            "topicsToInclude": [],
            "customerKnowledgeStatus": "HAS_PRE_EXISTING_KNOWLEDGE"
          }
        },
        "coverage": {
          "type": "CHOSEN",
          "amount": 1000000
        },
        "crossBorderTariffApplicable": false,
        "maturityManagement": true,
        "postDelivery": false,
        "lifeBeneficiary": {
          "beneficiaryType": "POLICY_HOLDER"
        },
        "deathBeneficiary": {
          "beneficiaryType": "DEFAULT"
        },
        "language": "DE_CH"
      },
      "customerFinancialStatus": {
        "moneyOrigin": "EARNED_INCOME",
        "policyReason": "PRIVATE_PENSION",
        "totalMonthlyExpenses": 140000,
        "totalMonthlyNetIncome": 200000,
        "moneyOriginOtherText": null,
        "policyReasonOtherText": null,
        "differentWealthOrigin": false,
        "paymentMethod": {
          "wireTransfer": true
        }
      }
    }
  }
}
```

- **No tax benefits** — unlike 3A, Prosperity Plus (3b) does not offer tax-deductible contributions, but provides more flexibility
- **All amounts are in the smallest monetary unit** — Rappen for CHF (1 CHF = 100 Rappen). For example, `10000` = CHF 100.00, `1000000` = CHF 10,000.00
- **Beneficiaries** — supports both `lifeBeneficiary` and `deathBeneficiary` in `productConfiguration`:
  - **Life beneficiary**: `{ "beneficiaryType": "POLICY_HOLDER" }` (default) or provide `customBeneficiaries` array (each entry requires `firstName`, `lastName`, `dateOfBirth`, `gender`, `address`, `allotmentPercentage`)
  - **Death beneficiary**: `{ "beneficiaryType": "DEFAULT" }` (heirs) or custom with `customBeneficiaries` array
- **`hasSecondPillar`** — boolean indicating whether the customer has a second pillar pension
- **`postDelivery`** — boolean for postal delivery of documents
- **No 3A transfer** — `transferExisting3APolicy` is not available (pillar 3b is separate from 3a)
- **No `durationOverRetirement`** — this field is 3A-specific
- **Age range 18–99** — broader than 3A's 60–70 retirement constraint for `ageWhenPolicyEnds`
- **Payment method** — only `wireTransfer` and `esr` are available (no LSV+ direct debit)
- **Premium mode** — use the `ProsperityPlusPremiumMode` enum (`ANNUALLY`, `SEMI_ANNUALLY`, `QUARTERLY`, `MONTHLY`)
- **Disability annuity** — requires `premiumWaiver` to be set. The `jobClass` and `jobRisk` must be a valid pair from the [job classes reference](/platform-integrations/job-classes)
- **Health questionnaire** — required when `premiumWaiver` or `disabilityAnnuity` is set in `productConfiguration`. Uses the same structure as Prosperity 3A (`insuredPersonsHealthStatus`)
- **Guarantee** — optional capital guarantee at maturity (`NO_GUARANTEE`, `SELECT_50`, `SELECT_80`, `SELECT_90`, `SELECT_100`)
- **Coverage type** — `CHOSEN` requires an `amount`; `PERCENTAGE` gives 101% of actuarial reserve (no amount needed)
- **Language** — use the `ProsperityPlusContractLanguage` enum (`DE_DE`, `DE_CH`, `FR_FR`, `IT_IT`)
- **Currency is CHF** — Swiss pillar 3b products use Swiss Francs

</details>

<CopyPrompt label="Fetch offer and download PDF" prompt={FETCH_OFFER_PDF_PROMPT} />

### Fetching the PDF Document

Wait ~30 seconds after offer creation before requesting documents to avoid `offer not found` errors.

```graphql
query Offer($contractId: PolicyID!) {
  offer(contractID: $contractId) {
    ... on ErrorInterface {
      __typename
      message
    }
    ... on Offer {
      contractID
      applicationFormDownloadLink {
        ... on FileDownload {
          link
        }
      }
    }
  }
}
```

### Uploading Required Documents

Once the customer has signed the application form, upload it back along with an identity document using the `uploadDocument` mutation. Both documents are typically required by the insurance system before issuance. If either is missing, `submitOffer` will return `SubmitOfferValidationError` listing the specific issues from the insurance system.

```graphql
mutation UploadDocument($input: UploadDocumentInput!) {
  uploadDocument(input: $input) {
    __typename
    ... on DocumentUploaded {
      contractID
      documentId
    }
    ... on ErrorInterface {
      message
    }
  }
}
```

**Input fields:**

- `contractID` — the `Contract ID` returned by `createOffer`
- `file` — a multipart `Upload` (see note below)
- `documentType` — one of:
  - `SIGNED_APPLICATION_FORM` — the application form signed by both the customer and the broker
  - `IDENTITY_VERIFICATION` — an identity document (passport, ID card, etc.) for the customer. It is the partner's responsibility to ensure the document is legitimate and belongs to the customer.

**File requirements:**

- Formats: `pdf`, `doc`, `docx`
- Maximum size: **5 MB**
- Files that exceed the limit or have an unsupported format return `InvalidDocumentFormatError`

The `file` argument uses the [GraphQL multipart request spec](https://github.com/jaydenseric/graphql-multipart-request-spec). Send the request as `multipart/form-data` with an `operations` field containing the GraphQL payload, a `map` field binding the file variable, and the file itself. The request must also carry an `apollo-require-preflight: true` header — Apollo Server's CSRF prevention blocks multipart requests without it and returns a `BAD_REQUEST` error otherwise.

```bash
curl https://api.stable.life.li/graphql/partner-platform \
  -H "Authorization: Bearer YOUR-API-KEY" \
  -H "x-partner-id: YOUR-PARTNER-ID" \
  -H "apollo-require-preflight: true" \
  -F operations='{ "query": "mutation ($input: UploadDocumentInput!) { uploadDocument(input: $input) { __typename ... on DocumentUploaded { documentId } ... on ErrorInterface { message } } }", "variables": { "input": { "contractID": "YOUR-CONTRACT-ID", "file": null, "documentType": "SIGNED_APPLICATION_FORM" } } }' \
  -F map='{ "0": ["variables.input.file"] }' \
  -F 0=@./signed-application.pdf
```

The example above uses POSIX shell quoting and works in bash, zsh, and PowerShell. On Windows `cmd.exe`, use PowerShell or WSL, or use a GraphQL client library (Apollo, urql) instead.

Most GraphQL clients (Apollo, urql, graphql-request) have first-class support for `Upload` via plugins such as `apollo-upload-client`.

**Possible responses:**

| Type                         | When                                                               |
| ---------------------------- | ------------------------------------------------------------------ |
| `DocumentUploaded`           | Upload succeeded; `documentId` identifies the file                 |
| `OfferNotFoundError`         | No offer exists for `contractID` under your partner account        |
| `InvalidDocumentFormatError` | Unsupported file type, or file exceeds the 5 MB limit              |
| `UnexpectedError`            | System failure — retry once. If the error persists, contact support. |

### Submitting the Offer

Once you have uploaded the documents needed by the insurance system, submit the offer for issuance with the `submitOffer` mutation. Submission is **protected against duplicates**: a second call for the same `contractID` returns `OfferAlreadySubmittedError`, which indicates the offer is already in the submission pipeline — no further action is required. This makes `submitOffer` safe to retry after a network timeout: if the first call actually reached the server, the retry will report `OfferAlreadySubmittedError` rather than re-submitting.

```graphql
mutation SubmitOffer($input: SubmitOfferInput!) {
  submitOffer(input: $input) {
    __typename
    ... on SubmittedOffer {
      contractID
    }
    ... on SubmitOfferValidationError {
      message
      validationErrors {
        title
        description
      }
    }
    ... on ErrorInterface {
      message
    }
  }
}
```

**Possible responses:**

| Type                          | When                                                                                                                                                      |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SubmittedOffer`              | Offer was accepted by the insurance system and enters the issuance workflow                                                                               |
| `OfferNotFoundError`          | No offer exists for `contractID` under your partner account                                                                                               |
| `OfferAlreadySubmittedError`  | Offer was already submitted (or a submission is in progress) — no action needed                                                                           |
| `SubmitOfferValidationError`  | Insurance system rejected the offer with validation errors listed in `validationErrors`. Fix the flagged data (or re-upload documents) and retry.         |
| `UnexpectedError`             | System failure — retry once. If the error persists, contact support.                                                                                      |

When `SubmitOfferValidationError` is returned, the offer's submission state is rolled back internally so you can fix the data and call `submitOffer` again. No manual reset step is required.

### Checking Offer Status

Use the `offerStatus` query to check the lifecycle state of an offer and whether it has any open reworks. This is a lightweight read and can be polled after `submitOffer` to track progress without fetching the full offer.

```graphql
query OfferStatus($contractID: PolicyID!) {
  offerStatus(contractID: $contractID) {
    __typename
    ... on OfferStatus {
      contractID
      status
      isSubmitted
      isIssued
      hasOpenReworks
      openReworks {
        taskId
        openedOn
        reason
        status
      }
    }
    ... on ErrorInterface {
      message
    }
  }
}
```

**Lifecycle states (`status`):**

| Value       | Meaning                                                                                  |
| ----------- | ---------------------------------------------------------------------------------------- |
| `OFFER`     | Offer created, not yet submitted                                                         |
| `SUBMITTED` | Offer sent to the insurance system, processing in progress                               |
| `ISSUED`    | Offer has been converted into an active policy                                           |
| `CANCELLED` | Offer has been cancelled (terminal — overrides `ISSUED` if cancelled after issuance)     |

### Responding to Open Reworks

If the insurance system needs additional information or corrections, it opens a **rework** against the offer. Unlike the `openReworks` field inside `offerStatus` (which returns reworks for a single offer), the `openReworks` query returns all open reworks across every offer under your partner account — useful for building a rework dashboard. Use it to list all open reworks:

```graphql
query OpenReworks {
  openReworks {
    __typename
    ... on OpenReworks {
      totalCount
      reworks {
        taskId
        contractID
        openedOn
        reason
        status
      }
    }
    ... on ErrorInterface {
      message
    }
  }
}
```

Only reworks with status `WAITING` (awaiting a response from the broker) are returned. After you address the flagged items (typically by re-uploading a corrected document with `uploadDocument`), the rework automatically transitions from `WAITING` to `FROZEN` (broker responded, internal confirmation pending). The transition to `FINISHED` is completed by the insurance system and may take additional processing time.

<CopyPrompt label="Update customer information" prompt={UPDATE_CUSTOMER_PROMPT} />

### Updating Customer Information

You can update existing customer information through the API if:

- They are linked to your partner account
- The information is allowed to be updated (some fields are restricted once contracts exist)

```graphql
mutation UpdateCustomer(
  $customerBy: CustomerByInput!
  $input: UpdateCustomerInput!
) {
  updateCustomer(customerBy: $customerBy, input: $input) {
    ... on ErrorInterface {
      message
    }
    ... on InsuranceSystemError {
      message
      reasons
    }
    ... on UpdatedCustomer {
      customer {
        ... on IndividualPersonCustomer {
          ID
        }
      }
    }
  }
}
```

For security reasons, certain fields (first name, last name, gender, date of birth) cannot be changed through the API if the customer has open applications or existing contracts. Contact support for such updates.

<CopyPrompt label="Look up customer by email" prompt={CUSTOMER_LOOKUP_PROMPT} />

### Looking Up Customer ID

You can retrieve a customer's ID using their email address:

```graphql
query Customer($input: CustomerByInput!) {
  customer(input: $input) {
    __typename
    ... on ErrorInterface {
      message
    }
    ... on IndividualPersonCustomer {
      ID
    }
    ... on CorporateEntityCustomer {
      ID
    }
  }
}
```

## Error Handling

The API uses a schema-based error handling approach:

- All errors implement `ErrorInterface`
- Errors are self-documenting
- Never query error types directly
- Access errors through `ErrorInterface` to avoid breaking changes

Common error responses:

```json
{
  "data": {
    "createOffer": {
      "__typename": "InsuranceSystemError",
      "message": "Offer can not be created due to some insurance system errors",
      "reasons": [
        "Negative projection: The model cannot be computed. The basic data must be changed",
        "Premium: Application limits regular premium (yearly): EUR 1,200.00 - EUR 1,000,000.00"
      ]
    }
  }
}
```

Learn more about our [error handling pattern](https://sachee.medium.com/200-ok-error-handling-in-graphql-7ec869aec9bc).


---

## Platform GraphQL API

URL: https://partner-docs.life.li/platform-integrations/graphql-api

# Platform GraphQL API

The Platform GraphQL API provides advanced capabilities for creating and managing complete offers. Access the API at:

- Test Environment: [https://api.stable.life.li/graphql/partner-platform](https://api.stable.life.li/graphql/partner-platform)
- Production: [https://api.life.li/graphql/partner-platform](https://api.life.li/graphql/partner-platform)

## Authentication

Both endpoints include a GraphQL playground for interactive API exploration. To authenticate:

1. In the browser authentication popup:

   - Leave the username empty
   - Enter your API key as the password

2. In the playground's Headers section, add:
   ```json
   {
     "Authorization": "Bearer YOUR-API-KEY",
     "x-partner-id": "YOUR-PARTNER-ID" // Required if you have multiple partner IDs
   }
   ```

If you're working with multiple partner IDs or are a platform serving multiple partners:

- Each Partner ID must be mapped to your API key
- Contact support to set up new ID mappings
  :::

## Environments

- **Stable**: A clone of our production environment, ideal for development and testing
- **Production**: Live environment for real transactions

If you previously used the Customer Digital Onboarding flow and the `partner` graph, your existing credentials will work with the `partner-platform` graph.

## Security Best Practices

1. Keep your API key secure and never expose it in client-side code
2. Use environment variables for storing credentials
3. Request new API keys if they are compromised
4. Use HTTPS for all API communications

## AI Integration Prompt

Copy this prompt and paste it into your AI coding assistant to set up the API client:

<CopyPrompt label="Set up Platform API client" prompt={API_SETUP_PROMPT} />

## Interactive API Explorer

Explore the schema and run queries directly in the GraphQL playground:

- **Test**: [api.stable.life.li/graphql/partner-platform](https://api.stable.life.li/graphql/partner-platform)
- **Production**: [api.life.li/graphql/partner-platform](https://api.life.li/graphql/partner-platform)

Authenticate via the browser Basic Auth popup (leave username empty, enter your API key as password), then add your headers in the playground's Headers tab.


---

## Platform Integration

URL: https://partner-docs.life.li/platform-integrations

# Platform Integration

For partners with existing platforms or CRM systems containing complete customer and policy information, our Platform Integration allows you to create binding offers through our API. This integration enables you to:

- Create complete offers with all required fields
- Download offer documents
- Upload signed application forms and identity documents
- Submit offers for issuance to the insurance system
- Track offer status and respond to open reworks
- Access offers through Partner Life
- Manage the entire process through API integration

## Integration Steps

1. [Getting Started with GraphQL API](/platform-integrations/graphql-api)
2. [Partner Life Single Sign-On](/platform-integrations/single-sign-on)
3. [Creating Complete Offers](/platform-integrations/creating-offers)

## Supported Products

| Product | Market | Offering Details | API Integration |
|---------|--------|-----------------|-----------------|
| **Liechtenstein Life Invest** | Germany 🇩🇪 | [View Details](https://liechtensteinlife.com/en-DE/markets/de/products/liechtenstein-life-invest) | [View Example](/platform-integrations/creating-offers#example-liechtenstein-life-invest) |
| **Liechtenstein Life Wealth** | Germany 🇩🇪 | [View Details](https://liechtensteinlife.com/en-DE/markets/de/products/liechtenstein-life-wealth) | [View Example](/platform-integrations/creating-offers#example-liechtenstein-life-wealth) |
| **Prosperity Plus Germany** | Germany 🇩🇪 | [View Details](https://liechtensteinlife.com/en-DE/markets/de/products/prosperity-plus) | [View Example](/platform-integrations/creating-offers#example-prosperity-plus-germany) |
| **Liechtenstein Life Pension** | Germany 🇩🇪 | [View Details](https://liechtensteinlife.com/en-DE/markets/de/products/liechtenstein-life-pension) | [View Example](/platform-integrations/creating-offers#example-liechtenstein-life-pension) |
| **Value Invest VWL** | Germany 🇩🇪 | [View Details](https://liechtensteinlife.com/en-DE/markets/de/products/value-invest-vwl) | [View Example](/platform-integrations/creating-offers#example-value-invest-vwl) |
| ~~**Yourlife Netto Plus**~~ _(deprecated — no new integrations)_ | Germany 🇩🇪 | — | — |
| **Prosperity 3A** | Switzerland 🇨🇭 | [View Details](https://liechtensteinlife.com/en-CH/markets/ch/products/prosperity-3a) | [View Example](/platform-integrations/creating-offers#example-prosperity-3a-swiss-pillar-3a) |
| **Prosperity Plus (3B)** | Switzerland 🇨🇭 | [View Details](https://liechtensteinlife.com/en-CH/markets/ch/products/prosperity-3b) | [View Example](/platform-integrations/creating-offers#example-prosperity-plus-swiss-pillar-3b) |

## Need Help?

If you need assistance with the integration or have questions about supported products, please reach out to our support team.


---

## Prosperity 3A — Job Classes & Risk Levels

URL: https://partner-docs.life.li/platform-integrations/job-classes

# Prosperity 3A — Job Classes & Risk Levels

When configuring `disabilityAnnuity` for a Prosperity 3A offer, you must provide a valid `jobClass` and `jobRisk` pair.
The `jobClass` string must match exactly (case-sensitive), and the `jobRisk` must be a valid risk level for that job class.

Some job classes have multiple valid risk levels (e.g., "Professional Footballer" has risk levels 1–5).

Use the search box below to find valid job classes.

<JobClassTable />

## Usage in GraphQL

```graphql
"disabilityAnnuity": {
  "yearlyPensionAmount": 600000,
  "excludeAccident": false,
  "annuityIncrease": true,
  "waitingPeriodMonths": 24,
  "jobClass": "Pharmacist",
  "jobRisk": 1
}
```

## Notes

- The `jobClass` value is **case-sensitive** and must match the table exactly
- If an invalid `jobClass` or `jobRisk` is provided, the API returns `PRODUCT_CONFIGURATION_INVALID_JOB_CLASS`
- Risk levels range from 1 (lowest risk) to 5 (highest risk)
- 29 job classes have multiple valid risk levels — check the table for the correct one


---

## Partner Life Single Sign-On

URL: https://partner-docs.life.li/platform-integrations/single-sign-on

# Partner Life Single Sign-On

[Partner Life](https://partner.life.li) is the comprehensive portal for partners to manage contracts, support requests, customer information, and policy changes. This guide explains how to integrate your existing authentication system with Partner Life using the Platform GraphQL API.

## Prerequisites

Before you begin, ensure you have:

- Your API Key
- Your Partner ID (the insurance system broker ID, e.g., `123000`, `23330-2`)
- The Partner IDs of your sub-brokers and employee accounts (found in their welcome emails or in the colleague section of your Partner Life account)

## Integration Steps

### 1. Basic Setup

First, set up access to the Platform GraphQL API as described in the [Platform GraphQL API Guide](/platform-integrations/graphql-api).

### 2. Generate Magic Links

Use the `createPartnerLifeMagicLink` mutation to generate direct access links to Partner Life:

```graphql
mutation CreatePartnerLifeMagicLink($input: CreatePartnerLifeMagicLinkInput!) {
  createPartnerLifeMagicLink(input: $input) {
    ... on PartnerLifeMagicLink {
      url
    }
    ... on ErrorInterface {
      message
    }
  }
}
```

Example input — logging in the partner identified by the `x-partner-id` header:

```json
{
  "input": {
    "alreadyMultiFactorAuthenticated": true,
    "acceptPartnerLifeTermsAndConditions": true,
    "acknowledgePartnerLifePrivacyPolicy": true
  }
}
```

Example input — logging in a sub-partner or colleague account:

```json
{
  "input": {
    "partnerLifewareId": "123456",
    "alreadyMultiFactorAuthenticated": true,
    "acceptPartnerLifeTermsAndConditions": true,
    "acknowledgePartnerLifePrivacyPolicy": true
  }
}
```

If `partnerLifewareId` is omitted, the magic link is created for the partner identified by the `x-partner-id` request header. To create magic links for sub-partners or colleague accounts, provide their Partner ID in the `partnerLifewareId` field. The target partner must be within your broker tree.

### 3. Authentication Flow

The basic authentication flow works as follows:

```mermaid
sequenceDiagram
    participant B as Broker/Employee
    participant Y as Your Software
    participant P as Platform API
    participant L as partner.life.li
    B->>+Y: Normal Authentication
    Y->>+P: createPartnerLifeMagicLink mutation
    P-->>-Y: Response (with magic link URL)
    Y->>+L: Redirect to magic link URL (auto-login)
    L->>+L: Multi-factor Authentication Check (SMS/Passkey)
```

### 4. Multi-Factor Authentication

If your system already implements MFA, you can skip Partner Life's MFA check by setting `alreadyMultiFactorAuthenticated` to `true`:

```mermaid
sequenceDiagram
    participant B as Broker/Employee
    participant Y as Your Software
    participant P as Platform API
    participant L as partner.life.li
    B->>+Y: Multi-factor authenticated
    Y->>+P: createPartnerLifeMagicLink mutation<br/>(alreadyMultiFactorAuthenticated: true)
    P-->>-Y: Response (with magic link URL)
    Y->>+L: Redirect to magic link URL<br/>(auto-login, no MFA check)
```

## Auto-Activation of Accounts

For partners with a Partner ID but no active Partner Life account, you can automatically activate their account by setting both `acceptPartnerLifeTermsAndConditions` and `acknowledgePartnerLifePrivacyPolicy` to `true`.

Before activating, ensure the partner has accepted:

- [Terms and Conditions](https://partner.life.li/en/terms-and-conditions)
- [Privacy Policy](https://partner.life.li/en/privacy-policy)

## Error Handling

The mutation returns a union type. Always handle the error cases:

| Error Type | Meaning | Resolution |
|---|---|---|
| `PartnerHasNoPartnerLifeAccountError` | Account not yet activated | Set both T&C and privacy policy flags to `true` |
| `PartnerNotFoundError` | Partner ID not found or not in your broker tree | Verify the Partner ID is correct and within your access scope |
| `PartnerHasNoEmailError` | Partner has no email configured | Contact support to set up the partner's email address |
| `UnexpectedError` | Unexpected internal failure | Log the error, optionally retry the request, and contact support if the problem persists |

## Security Best Practices

1. **Protect magic link URLs** — they are single-use authentication tokens. Do not log or cache them.
2. **Use server-side calls only** — never call the API from client-side code; your API key would be exposed.
3. **Validate MFA claims** — only set `alreadyMultiFactorAuthenticated` to `true` when your system has genuinely verified the user with multiple factors.
4. **Minimal scope** — only request magic links for partners within your broker tree. The API enforces this, but your integration should validate upfront.

## Need Help?

If you don't have access to Partner Life or need assistance, contact [partner support](mailto:support@partner.life.li).


---

## Embed Our Calculator Widget

URL: https://partner-docs.life.li/widgets/embedded-calculator

---
sidebar_position: 1
---

# Embed Our Calculator Widget

We offer a powerful and user-friendly calculator widget that can be easily integrated into your website. The widget provides your customers with a seamless experience to understand and customize their pension plans through an interactive simulation graph.

![Calculator](/img/calculator.jpg)

## Integration Guide

You can integrate our calculator widget into your website as an `<iframe>` using the following URL:

```html
<iframe
  src="https://example.com/widgets/calculator"
  width="100%"
  height="800px"
  frameborder="0"
></iframe>
```

## URL Parameters

The widget can be initialized with default values using URL parameters. Here are the supported parameters:

| Parameter         | Default | Options            | Description                                                                                 |
| ----------------- | ------- | ------------------ | ------------------------------------------------------------------------------------------- |
| graphType         | preTax  | postTax, preTax    | Initializes the widget with the selected graph type. Users can still switch between graphs. |
| initialPayment    | 0       | -                  | Initial payment amount at policy start                                                      |
| monthlyPayment    | 100     | min = 30           | Monthly payment amount                                                                      |
| riskLevel         | high    | high, medium, low  | Initial risk level selection (high: 9%, medium: 6%, low: 3%)                                |
| currentAge        | 25      | min = 18, max = 55 | Customer's current age                                                                      |
| startInXYears     | 0       | -                  | Initializes with start year difference comparison graph if > 0                              |
| ageWhenPolicyEnds | 67      | 67, 75, 85         | Expected policy end age                                                                     |

## Example Usage

Here's an example of embedding the calculator with some predefined parameters:

```html
<iframe
  src="https://example.com/widgets/calculator?graphType=postTax&monthlyPayment=150&riskLevel=medium&currentAge=30"
  width="100%"
  height="800px"
  frameborder="0"
></iframe>
```

## Customization

The widget automatically adapts to your website's layout and provides a responsive experience across different screen sizes. The height can be adjusted based on your needs by modifying the `height` attribute of the iframe.


---

## Embed Our Calculator Widget

URL: https://partner-docs.life.li/widgets/embedded-calculator

# Embed Our Calculator Widget

We offer a powerful and user-friendly calculator widget that can be easily integrated into your website. The widget provides your customers with a seamless experience to understand and customize their pension plans through an interactive simulation graph.

![Calculator](/img/calculator.jpg)

## Integration Guide

You can integrate our calculator widget into your website as an `<iframe>` using the following URL:

```html
<iframe
  src="https://example.com/widgets/calculator"
  width="100%"
  height="800px"
  frameborder="0"
></iframe>
```

## URL Parameters

The widget can be initialized with default values using URL parameters. Here are the supported parameters:

| Parameter         | Default | Options            | Description                                                                                 |
| ----------------- | ------- | ------------------ | ------------------------------------------------------------------------------------------- |
| graphType         | preTax  | postTax, preTax    | Initializes the widget with the selected graph type. Users can still switch between graphs. |
| initialPayment    | 0       | -                  | Initial payment amount at policy start                                                      |
| monthlyPayment    | 100     | min = 30           | Monthly payment amount                                                                      |
| riskLevel         | high    | high, medium, low  | Initial risk level selection (high: 9%, medium: 6%, low: 3%)                                |
| currentAge        | 25      | min = 18, max = 55 | Customer's current age                                                                      |
| startInXYears     | 0       | -                  | Initializes with start year difference comparison graph if > 0                              |
| ageWhenPolicyEnds | 67      | 67, 75, 85         | Expected policy end age                                                                     |

## Example Usage

Here's an example of embedding the calculator with some predefined parameters:

```html
<iframe
  src="https://example.com/widgets/calculator?graphType=postTax&monthlyPayment=150&riskLevel=medium&currentAge=30"
  width="100%"
  height="800px"
  frameborder="0"
></iframe>
```

## Customization

The widget automatically adapts to your website's layout and provides a responsive experience across different screen sizes. The height can be adjusted based on your needs by modifying the `height` attribute of the iframe.


---