List Policy Transactions

curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/policies/{policyId}/transactions \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.aiinsurance.io/api/external/companies/{companyId}/policies/{policyId}/transactions"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.aiinsurance.io/api/external/companies/{companyId}/policies/{policyId}/transactions', 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://app.aiinsurance.io/api/external/companies/{companyId}/policies/{policyId}/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.aiinsurance.io/api/external/companies/{companyId}/policies/{policyId}/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/policies/{policyId}/transactions")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "items": [
    {
      "transactionId": "61b8357e-f92c-404e-825c-63432974c8a1",
      "policyId": "84f9b186-08fc-408a-8f8c-d739e161c423",
      "type": "bind",
      "processedAt": "2024-01-15T10:30:00.000Z",
      "effectiveDate": "2024-01-15",
      "description": "Initial Bind",
      "delta": {
        "after": {
          "policyRating": {
            "premium": "1200.00"
          }
        },
        "change": {
          "policyRating": {
            "premium": "1200.00"
          }
        }
      },
      "initiatedBy": "email|user-123"
    },
    {
      "transactionId": "72c9468f-a03d-515f-936d-74543085d9b2",
      "policyId": "84f9b186-08fc-408a-8f8c-d739e161c423",
      "type": "endorsement",
      "processedAt": "2024-02-01T14:20:00.000Z",
      "effectiveDate": "2024-02-15",
      "description": "Endorsement 1: Coverage Increase",
      "delta": {
        "after": {
          "policyRating": {
            "premium": "1500.00"
          }
        },
        "change": {
          "policyRating": {
            "premium": "300.00"
          }
        }
      },
      "initiatedBy": "email|user-456"
    }
  ],
  "totalCount": 15
}

Policies

List Policy Transactions

Returns a paginated list of policy transactions (change sets) for a specific policy. Transactions represent the activity log/audit trail of changes made to the policy, including binds, endorsements, cancellations, reinstatements, and renewals.

Filtering:

type - Filter by transaction type (bind, endorsement, cancellation, reinstatement, renewal)

Sorting:

processedAt (default), effectiveDate, type

Required permission: company.policy:read

GET

api

external

companies

{companyId}

policies

{policyId}

transactions

List Policy Transactions

curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/policies/{policyId}/transactions \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.aiinsurance.io/api/external/companies/{companyId}/policies/{policyId}/transactions"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.aiinsurance.io/api/external/companies/{companyId}/policies/{policyId}/transactions', 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://app.aiinsurance.io/api/external/companies/{companyId}/policies/{policyId}/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.aiinsurance.io/api/external/companies/{companyId}/policies/{policyId}/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/policies/{policyId}/transactions")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "items": [
    {
      "transactionId": "61b8357e-f92c-404e-825c-63432974c8a1",
      "policyId": "84f9b186-08fc-408a-8f8c-d739e161c423",
      "type": "bind",
      "processedAt": "2024-01-15T10:30:00.000Z",
      "effectiveDate": "2024-01-15",
      "description": "Initial Bind",
      "delta": {
        "after": {
          "policyRating": {
            "premium": "1200.00"
          }
        },
        "change": {
          "policyRating": {
            "premium": "1200.00"
          }
        }
      },
      "initiatedBy": "email|user-123"
    },
    {
      "transactionId": "72c9468f-a03d-515f-936d-74543085d9b2",
      "policyId": "84f9b186-08fc-408a-8f8c-d739e161c423",
      "type": "endorsement",
      "processedAt": "2024-02-01T14:20:00.000Z",
      "effectiveDate": "2024-02-15",
      "description": "Endorsement 1: Coverage Increase",
      "delta": {
        "after": {
          "policyRating": {
            "premium": "1500.00"
          }
        },
        "change": {
          "policyRating": {
            "premium": "300.00"
          }
        }
      },
      "initiatedBy": "email|user-456"
    }
  ],
  "totalCount": 15
}

Authorizations

Authorization

string

header

required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId

string<uuid>

required

Company identifier

policyId

string<uuid>

required

Policy identifier

Query Parameters

page

integer

default:1

Page number (1-based, default 1, page size 50)

Required range: x >= 1

sortBy

enum<string>

default:processedAt

Field to sort by (default processedAt)

Available options:

processedAt,

effectiveDate,

type

sortDirection

enum<string>

default:desc

Sort direction (default desc)

Available options:

asc,

desc

type

enum<string>

Filter by transaction type (bind, endorsement, cancellation, reinstatement, renewal) Type of policy transaction (change set)

Available options:

bind,

endorsement,

cancellation,

reinstatement,

renewal

Response

Paginated list of policy transactions

items

object[]

Show child attributes

totalCount

integer

Total number of transactions across all pages

Getting Started

Submissions

Quotes

Assignees

Notes

Events

Brokerages

Brokers

Payees

Transaction Categories

Event Financials

Policies

Exposures

Attorneys

Lawsuits

Defendants

Configuration Fields

Configuration Rating Fields

Configuration Rating Outputs

Configuration Rating Presets

Configuration Rating Form Logic

Configuration Presets

Exposure Types

Coverage Types

Smart Tags

Address

Reference

List Policy Transactions

Authorizations

Path Parameters

Query Parameters

Response