New Business Transaction

curl --request POST \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "policyStatus": "active",
    "annualPremium": 85000,
    "policyStartDate": {
      "year": 2025,
      "month": 1,
      "day": 1,
      "timezone": "America/New_York"
    },
    "policyEndDate": {
      "year": 2026,
      "month": 1,
      "day": 1,
      "timezone": "America/New_York"
    },
    "fullTermPricingInfo": {
      "pricingComponents": [
        {
          "label": "Policy Premium",
          "group": "Policy Invoice",
          "kind": "Premium",
          "value": 85000
        },
        {
          "label": "Policy Fee",
          "group": "Policy Invoice",
          "kind": "Fees",
          "value": 500
        }
      ]
    },
    "primaryInsured": {
      "id": "550e8400-e29b-41d4-a716-446655440010",
      "exposureType": "MedicalFacility",
      "bedCount": 120
    },
    "additionalExposures": []
  }
}
'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business"

payload = { "data": {
        "policyStatus": "active",
        "annualPremium": 85000,
        "policyStartDate": {
            "year": 2025,
            "month": 1,
            "day": 1,
            "timezone": "America/New_York"
        },
        "policyEndDate": {
            "year": 2026,
            "month": 1,
            "day": 1,
            "timezone": "America/New_York"
        },
        "fullTermPricingInfo": { "pricingComponents": [
                {
                    "label": "Policy Premium",
                    "group": "Policy Invoice",
                    "kind": "Premium",
                    "value": 85000
                },
                {
                    "label": "Policy Fee",
                    "group": "Policy Invoice",
                    "kind": "Fees",
                    "value": 500
                }
            ] },
        "primaryInsured": {
            "id": "550e8400-e29b-41d4-a716-446655440010",
            "exposureType": "MedicalFacility",
            "bedCount": 120
        },
        "additionalExposures": []
    } }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    data: {
      policyStatus: 'active',
      annualPremium: 85000,
      policyStartDate: {year: 2025, month: 1, day: 1, timezone: 'America/New_York'},
      policyEndDate: {year: 2026, month: 1, day: 1, timezone: 'America/New_York'},
      fullTermPricingInfo: {
        pricingComponents: [
          {
            label: 'Policy Premium',
            group: 'Policy Invoice',
            kind: 'Premium',
            value: 85000
          },
          {label: 'Policy Fee', group: 'Policy Invoice', kind: 'Fees', value: 500}
        ]
      },
      primaryInsured: {
        id: '550e8400-e29b-41d4-a716-446655440010',
        exposureType: 'MedicalFacility',
        bedCount: 120
      },
      additionalExposures: []
    }
  })
};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'policyStatus' => 'active',
        'annualPremium' => 85000,
        'policyStartDate' => [
                'year' => 2025,
                'month' => 1,
                'day' => 1,
                'timezone' => 'America/New_York'
        ],
        'policyEndDate' => [
                'year' => 2026,
                'month' => 1,
                'day' => 1,
                'timezone' => 'America/New_York'
        ],
        'fullTermPricingInfo' => [
                'pricingComponents' => [
                                [
                                                                'label' => 'Policy Premium',
                                                                'group' => 'Policy Invoice',
                                                                'kind' => 'Premium',
                                                                'value' => 85000
                                ],
                                [
                                                                'label' => 'Policy Fee',
                                                                'group' => 'Policy Invoice',
                                                                'kind' => 'Fees',
                                                                'value' => 500
                                ]
                ]
        ],
        'primaryInsured' => [
                'id' => '550e8400-e29b-41d4-a716-446655440010',
                'exposureType' => 'MedicalFacility',
                'bedCount' => 120
        ],
        'additionalExposures' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business"

	payload := strings.NewReader("{\n  \"data\": {\n    \"policyStatus\": \"active\",\n    \"annualPremium\": 85000,\n    \"policyStartDate\": {\n      \"year\": 2025,\n      \"month\": 1,\n      \"day\": 1,\n      \"timezone\": \"America/New_York\"\n    },\n    \"policyEndDate\": {\n      \"year\": 2026,\n      \"month\": 1,\n      \"day\": 1,\n      \"timezone\": \"America/New_York\"\n    },\n    \"fullTermPricingInfo\": {\n      \"pricingComponents\": [\n        {\n          \"label\": \"Policy Premium\",\n          \"group\": \"Policy Invoice\",\n          \"kind\": \"Premium\",\n          \"value\": 85000\n        },\n        {\n          \"label\": \"Policy Fee\",\n          \"group\": \"Policy Invoice\",\n          \"kind\": \"Fees\",\n          \"value\": 500\n        }\n      ]\n    },\n    \"primaryInsured\": {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440010\",\n      \"exposureType\": \"MedicalFacility\",\n      \"bedCount\": 120\n    },\n    \"additionalExposures\": []\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"policyStatus\": \"active\",\n    \"annualPremium\": 85000,\n    \"policyStartDate\": {\n      \"year\": 2025,\n      \"month\": 1,\n      \"day\": 1,\n      \"timezone\": \"America/New_York\"\n    },\n    \"policyEndDate\": {\n      \"year\": 2026,\n      \"month\": 1,\n      \"day\": 1,\n      \"timezone\": \"America/New_York\"\n    },\n    \"fullTermPricingInfo\": {\n      \"pricingComponents\": [\n        {\n          \"label\": \"Policy Premium\",\n          \"group\": \"Policy Invoice\",\n          \"kind\": \"Premium\",\n          \"value\": 85000\n        },\n        {\n          \"label\": \"Policy Fee\",\n          \"group\": \"Policy Invoice\",\n          \"kind\": \"Fees\",\n          \"value\": 500\n        }\n      ]\n    },\n    \"primaryInsured\": {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440010\",\n      \"exposureType\": \"MedicalFacility\",\n      \"bedCount\": 120\n    },\n    \"additionalExposures\": []\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"policyStatus\": \"active\",\n    \"annualPremium\": 85000,\n    \"policyStartDate\": {\n      \"year\": 2025,\n      \"month\": 1,\n      \"day\": 1,\n      \"timezone\": \"America/New_York\"\n    },\n    \"policyEndDate\": {\n      \"year\": 2026,\n      \"month\": 1,\n      \"day\": 1,\n      \"timezone\": \"America/New_York\"\n    },\n    \"fullTermPricingInfo\": {\n      \"pricingComponents\": [\n        {\n          \"label\": \"Policy Premium\",\n          \"group\": \"Policy Invoice\",\n          \"kind\": \"Premium\",\n          \"value\": 85000\n        },\n        {\n          \"label\": \"Policy Fee\",\n          \"group\": \"Policy Invoice\",\n          \"kind\": \"Fees\",\n          \"value\": 500\n        }\n      ]\n    },\n    \"primaryInsured\": {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440010\",\n      \"exposureType\": \"MedicalFacility\",\n      \"bedCount\": 120\n    },\n    \"additionalExposures\": []\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "policyId": "550e8400-e29b-41d4-a716-446655440001",
  "policyVersion": 1,
  "transactionId": "550e8400-e29b-41d4-a716-446655440002",
  "startDate": "2025-01-01",
  "endDate": "2026-01-01",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "primaryInsuredName": "Mercy General Hospital",
  "primaryInsuredId": "550e8400-e29b-41d4-a716-446655440010",
  "policyNumber": "POL-2025-000123",
  "policyStartDate": {
    "year": 2025,
    "month": 1,
    "day": 1,
    "timezone": "America/New_York"
  },
  "policyEndDate": {
    "year": 2026,
    "month": 1,
    "day": 1,
    "timezone": "America/New_York"
  },
  "fullTermPricingInfo": {
    "premium": 85000,
    "taxes": 0,
    "fees": 500,
    "brokerCommission": 0,
    "programCommission": 0,
    "pricingComponents": [
      {
        "label": "Policy Premium",
        "group": "Policy Invoice",
        "kind": "Premium",
        "earningBasis": null,
        "value": 85000
      },
      {
        "label": "Policy Fee",
        "group": "Policy Invoice",
        "kind": "Fees",
        "earningBasis": null,
        "value": 500
      }
    ]
  },
  "fullTermPolicyRatingResult": null,
  "segments": [
    {
      "startDate": "2025-01-01",
      "endDate": "2026-01-01",
      "data": {
        "policyStatus": "active",
        "policyNumber": "POL-2025-000123",
        "policyStartDate": {
          "year": 2025,
          "month": 1,
          "day": 1,
          "timezone": "America/New_York"
        },
        "policyEndDate": {
          "year": 2026,
          "month": 1,
          "day": 1,
          "timezone": "America/New_York"
        },
        "primaryInsuredId": "550e8400-e29b-41d4-a716-446655440010",
        "primaryInsuredName": "Mercy General Hospital",
        "annualPremium": 85000,
        "fullTermPricingInfo": {
          "premium": 85000,
          "taxes": 0,
          "fees": 500,
          "brokerCommission": 0,
          "programCommission": 0,
          "pricingComponents": [
            {
              "label": "Policy Premium",
              "group": "Policy Invoice",
              "kind": "Premium",
              "earningBasis": null,
              "value": 85000
            },
            {
              "label": "Policy Fee",
              "group": "Policy Invoice",
              "kind": "Fees",
              "earningBasis": null,
              "value": 500
            }
          ]
        },
        "primaryInsured": {
          "id": "550e8400-e29b-41d4-a716-446655440010",
          "exposureType": "MedicalFacility",
          "bedCount": 120
        },
        "additionalExposures": []
      }
    }
  ]
}

Transactions

New Business Transaction

Creates a new policy via a NEW_BUSINESS transaction. This is the entry point for the transaction-based policy lifecycle. The transaction produces a single segment covering the full policy term.

The request body is the complete initial policy state in data — the policy-level fields at the top level of that object. Any embedded exposure fields your company configuration defines (e.g. primaryInsured / additionalExposures in the default configuration) ride along as ordinary configured fields, validated per-field against the Exposure configuration. The primary insured is derived from those exposures; you do not send it.

Term bounds come solely from the policy’s own root fields. policyStartDate and policyEndDate are read from data.policyStartDate and data.policyEndDate — there are no top-level date parameters. The transaction’s effective date is the policy start date.

Policy invoices. Optionally send invoicePlan, a fully explicit keep/void/create plan. Nothing is defaulted or inferred; omission posts no invoices. The plan is validated and committed atomically with the policy.

Required permission: company.policy:create

POST

api

companies

{companyId}

policies

transaction

new-business

New Business Transaction

curl --request POST \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "policyStatus": "active",
    "annualPremium": 85000,
    "policyStartDate": {
      "year": 2025,
      "month": 1,
      "day": 1,
      "timezone": "America/New_York"
    },
    "policyEndDate": {
      "year": 2026,
      "month": 1,
      "day": 1,
      "timezone": "America/New_York"
    },
    "fullTermPricingInfo": {
      "pricingComponents": [
        {
          "label": "Policy Premium",
          "group": "Policy Invoice",
          "kind": "Premium",
          "value": 85000
        },
        {
          "label": "Policy Fee",
          "group": "Policy Invoice",
          "kind": "Fees",
          "value": 500
        }
      ]
    },
    "primaryInsured": {
      "id": "550e8400-e29b-41d4-a716-446655440010",
      "exposureType": "MedicalFacility",
      "bedCount": 120
    },
    "additionalExposures": []
  }
}
'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business"

payload = { "data": {
        "policyStatus": "active",
        "annualPremium": 85000,
        "policyStartDate": {
            "year": 2025,
            "month": 1,
            "day": 1,
            "timezone": "America/New_York"
        },
        "policyEndDate": {
            "year": 2026,
            "month": 1,
            "day": 1,
            "timezone": "America/New_York"
        },
        "fullTermPricingInfo": { "pricingComponents": [
                {
                    "label": "Policy Premium",
                    "group": "Policy Invoice",
                    "kind": "Premium",
                    "value": 85000
                },
                {
                    "label": "Policy Fee",
                    "group": "Policy Invoice",
                    "kind": "Fees",
                    "value": 500
                }
            ] },
        "primaryInsured": {
            "id": "550e8400-e29b-41d4-a716-446655440010",
            "exposureType": "MedicalFacility",
            "bedCount": 120
        },
        "additionalExposures": []
    } }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    data: {
      policyStatus: 'active',
      annualPremium: 85000,
      policyStartDate: {year: 2025, month: 1, day: 1, timezone: 'America/New_York'},
      policyEndDate: {year: 2026, month: 1, day: 1, timezone: 'America/New_York'},
      fullTermPricingInfo: {
        pricingComponents: [
          {
            label: 'Policy Premium',
            group: 'Policy Invoice',
            kind: 'Premium',
            value: 85000
          },
          {label: 'Policy Fee', group: 'Policy Invoice', kind: 'Fees', value: 500}
        ]
      },
      primaryInsured: {
        id: '550e8400-e29b-41d4-a716-446655440010',
        exposureType: 'MedicalFacility',
        bedCount: 120
      },
      additionalExposures: []
    }
  })
};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'policyStatus' => 'active',
        'annualPremium' => 85000,
        'policyStartDate' => [
                'year' => 2025,
                'month' => 1,
                'day' => 1,
                'timezone' => 'America/New_York'
        ],
        'policyEndDate' => [
                'year' => 2026,
                'month' => 1,
                'day' => 1,
                'timezone' => 'America/New_York'
        ],
        'fullTermPricingInfo' => [
                'pricingComponents' => [
                                [
                                                                'label' => 'Policy Premium',
                                                                'group' => 'Policy Invoice',
                                                                'kind' => 'Premium',
                                                                'value' => 85000
                                ],
                                [
                                                                'label' => 'Policy Fee',
                                                                'group' => 'Policy Invoice',
                                                                'kind' => 'Fees',
                                                                'value' => 500
                                ]
                ]
        ],
        'primaryInsured' => [
                'id' => '550e8400-e29b-41d4-a716-446655440010',
                'exposureType' => 'MedicalFacility',
                'bedCount' => 120
        ],
        'additionalExposures' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business"

	payload := strings.NewReader("{\n  \"data\": {\n    \"policyStatus\": \"active\",\n    \"annualPremium\": 85000,\n    \"policyStartDate\": {\n      \"year\": 2025,\n      \"month\": 1,\n      \"day\": 1,\n      \"timezone\": \"America/New_York\"\n    },\n    \"policyEndDate\": {\n      \"year\": 2026,\n      \"month\": 1,\n      \"day\": 1,\n      \"timezone\": \"America/New_York\"\n    },\n    \"fullTermPricingInfo\": {\n      \"pricingComponents\": [\n        {\n          \"label\": \"Policy Premium\",\n          \"group\": \"Policy Invoice\",\n          \"kind\": \"Premium\",\n          \"value\": 85000\n        },\n        {\n          \"label\": \"Policy Fee\",\n          \"group\": \"Policy Invoice\",\n          \"kind\": \"Fees\",\n          \"value\": 500\n        }\n      ]\n    },\n    \"primaryInsured\": {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440010\",\n      \"exposureType\": \"MedicalFacility\",\n      \"bedCount\": 120\n    },\n    \"additionalExposures\": []\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"policyStatus\": \"active\",\n    \"annualPremium\": 85000,\n    \"policyStartDate\": {\n      \"year\": 2025,\n      \"month\": 1,\n      \"day\": 1,\n      \"timezone\": \"America/New_York\"\n    },\n    \"policyEndDate\": {\n      \"year\": 2026,\n      \"month\": 1,\n      \"day\": 1,\n      \"timezone\": \"America/New_York\"\n    },\n    \"fullTermPricingInfo\": {\n      \"pricingComponents\": [\n        {\n          \"label\": \"Policy Premium\",\n          \"group\": \"Policy Invoice\",\n          \"kind\": \"Premium\",\n          \"value\": 85000\n        },\n        {\n          \"label\": \"Policy Fee\",\n          \"group\": \"Policy Invoice\",\n          \"kind\": \"Fees\",\n          \"value\": 500\n        }\n      ]\n    },\n    \"primaryInsured\": {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440010\",\n      \"exposureType\": \"MedicalFacility\",\n      \"bedCount\": 120\n    },\n    \"additionalExposures\": []\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/transaction/new-business")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"policyStatus\": \"active\",\n    \"annualPremium\": 85000,\n    \"policyStartDate\": {\n      \"year\": 2025,\n      \"month\": 1,\n      \"day\": 1,\n      \"timezone\": \"America/New_York\"\n    },\n    \"policyEndDate\": {\n      \"year\": 2026,\n      \"month\": 1,\n      \"day\": 1,\n      \"timezone\": \"America/New_York\"\n    },\n    \"fullTermPricingInfo\": {\n      \"pricingComponents\": [\n        {\n          \"label\": \"Policy Premium\",\n          \"group\": \"Policy Invoice\",\n          \"kind\": \"Premium\",\n          \"value\": 85000\n        },\n        {\n          \"label\": \"Policy Fee\",\n          \"group\": \"Policy Invoice\",\n          \"kind\": \"Fees\",\n          \"value\": 500\n        }\n      ]\n    },\n    \"primaryInsured\": {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440010\",\n      \"exposureType\": \"MedicalFacility\",\n      \"bedCount\": 120\n    },\n    \"additionalExposures\": []\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "policyId": "550e8400-e29b-41d4-a716-446655440001",
  "policyVersion": 1,
  "transactionId": "550e8400-e29b-41d4-a716-446655440002",
  "startDate": "2025-01-01",
  "endDate": "2026-01-01",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "primaryInsuredName": "Mercy General Hospital",
  "primaryInsuredId": "550e8400-e29b-41d4-a716-446655440010",
  "policyNumber": "POL-2025-000123",
  "policyStartDate": {
    "year": 2025,
    "month": 1,
    "day": 1,
    "timezone": "America/New_York"
  },
  "policyEndDate": {
    "year": 2026,
    "month": 1,
    "day": 1,
    "timezone": "America/New_York"
  },
  "fullTermPricingInfo": {
    "premium": 85000,
    "taxes": 0,
    "fees": 500,
    "brokerCommission": 0,
    "programCommission": 0,
    "pricingComponents": [
      {
        "label": "Policy Premium",
        "group": "Policy Invoice",
        "kind": "Premium",
        "earningBasis": null,
        "value": 85000
      },
      {
        "label": "Policy Fee",
        "group": "Policy Invoice",
        "kind": "Fees",
        "earningBasis": null,
        "value": 500
      }
    ]
  },
  "fullTermPolicyRatingResult": null,
  "segments": [
    {
      "startDate": "2025-01-01",
      "endDate": "2026-01-01",
      "data": {
        "policyStatus": "active",
        "policyNumber": "POL-2025-000123",
        "policyStartDate": {
          "year": 2025,
          "month": 1,
          "day": 1,
          "timezone": "America/New_York"
        },
        "policyEndDate": {
          "year": 2026,
          "month": 1,
          "day": 1,
          "timezone": "America/New_York"
        },
        "primaryInsuredId": "550e8400-e29b-41d4-a716-446655440010",
        "primaryInsuredName": "Mercy General Hospital",
        "annualPremium": 85000,
        "fullTermPricingInfo": {
          "premium": 85000,
          "taxes": 0,
          "fees": 500,
          "brokerCommission": 0,
          "programCommission": 0,
          "pricingComponents": [
            {
              "label": "Policy Premium",
              "group": "Policy Invoice",
              "kind": "Premium",
              "earningBasis": null,
              "value": 85000
            },
            {
              "label": "Policy Fee",
              "group": "Policy Invoice",
              "kind": "Fees",
              "earningBasis": null,
              "value": 500
            }
          ]
        },
        "primaryInsured": {
          "id": "550e8400-e29b-41d4-a716-446655440010",
          "exposureType": "MedicalFacility",
          "bedCount": 120
        },
        "additionalExposures": []
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId

string<uuid>

required

Company identifier

Body

application/json

data

object

required

The policy-level fields, at the top level of this object. Must include policyStatus, policyStartDate and policyEndDate. May also include fullTermPricingInfo, fullTermPolicyRatingResult and any custom fields defined in your field configuration — including embedded exposure fields (the default configuration models a primaryInsured object + an additionalExposures list, but the platform imposes no structural exposure shape).

Custom fields — including the values of any embedded exposure fields — are validated against your company's field configuration. Unknown fields are rejected, required fields must be present, and values must match their configured types (including option set membership). Embedded exposure values are validated per-field against that exposure's own configuration.

Before 2026-08-05 these same fields were sent one level deeper, inside fieldModelV1Data.policy. Send data.policyNumber where you sent fieldModelV1Data.policy.policyNumber.

Show child attributes

transactionTimestamp

string<date-time>

When the business decision was made. Defaults to the current time if omitted. Set explicitly for imports (e.g., aligning to a bordereau booking date).

displayAuthor

string

Optional user-visible author label (trimmed; must be non-empty). When set, the transaction is displayed as filed by this label (e.g. "Data Import") instead of the acting user; audit attribution (createdBy) stays server-set.

Maximum string length: 255

invoicePlan

object

A fully explicit, detached policy-invoice batch. Existing invoices not named in voidInvoices are kept. The complete kept-plus-created set must conserve every bound component of the policy's current pricing contract.

Show child attributes

Response

Policy created successfully

Response returned by policy transaction endpoints. Contains the policy version produced by the transaction, including all derived segments.

policyId

string<uuid>

required

Policy identifier

policyVersion

integer

required

Sequential version number produced by this transaction

transactionId

string<uuid>

required

Identifier of the transaction that produced this version

startDate

string<date>

required

Policy term start date (ISO 8601)

endDate

string<date>

required

Policy term end date (ISO 8601)

createdAt

string<date-time>

required

When the transaction was created (ISO 8601)

segments

object[]

required

Derived segments for this policy version. Each segment represents a maximal contiguous date range where policy state is identical. Adjacent segments with identical data are automatically merged.

Show child attributes

primaryInsuredName

string | null

Plain-text primary-insured name, read from the policy's own primaryInsuredName field — the source of truth for the primary insured. Reported as of the END of the term, so a policy whose insured changed mid-term returns the later name; segments[] carries the per-segment history. Null only when the version carries no policy data.

primaryInsuredId

string | null

Id of the entity behind primaryInsuredName. Null when the policy's configuration does not populate it.

policyNumber

string | null

The policy number, read from the policy's own policyNumber field — the source of truth, invariant across the whole term. Null only when the version carries no policy data.

policyStartDate

object | null

Policy term start date as the structured date object, read from the policy's own policyStartDate field — the source of truth, invariant across the whole term. This is not startDate above: that is the ISO span this version covers, which a cancellation makes shorter than the term. Null only when the version carries no policy data.

Show child attributes

policyEndDate

object | null

Policy term end date as the structured date object, read from the policy's own policyEndDate field — the source of truth, invariant across the whole term. This is not endDate above: that is the ISO span this version covers. Null only when the version carries no policy data.

Show child attributes

fullTermPricingInfo

object | null

The policy's full-term pricing contract, hoisted as a read-once convenience (also duplicated in every segment): pricingComponents (each {label, group, kind, value[, earningBasis]}) plus the five server-computed, read-only rollups (premium, taxes, fees, brokerCommission, programCommission — each the sum of its kind's components).

fullTermPolicyRatingResult

object | null

Derived canonical policy-level rating result for the full term, hoisted as a read-once convenience (also duplicated in every segment). Element-level rating output (crossSegmentRatingOutputs) stays inline at its host and is not hoisted.

⌘I

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

New Business Transaction

Authorizations

Path Parameters

Body

Response