Skip to main content
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>'
{
  "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": null,
      "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": {
        "policyRating": {
          "premium": "1500.00",
          "previousPremium": "1200.00"
        }
      },
      "initiatedBy": "email|user-456"
    }
  ],
  "totalCount": 15
}

Authorizations

​
Authorization
string
header
required

Use format: ApiKey <your-api-key>

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[]
​
totalCount
integer

Total number of transactions across all pages