Skip to main content
GET
/
api
/
v1
/
external
/
companies
/
{companyId}
/
policies
/
{policyId}
/
transactions
/
{transactionId}
Get Policy Transaction
curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/transactions/{transactionId} \
  --header 'Authorization: <api-key>'
{
  "id": "550e8400-e29b-41d4-a716-446655440020",
  "policyId": "550e8400-e29b-41d4-a716-446655440001",
  "policyVersion": 2,
  "action": "ENDORSE",
  "effectiveDate": "2025-06-01",
  "transactionTimestamp": "2025-05-28T14:30:00.000Z",
  "createdAt": "2025-05-28T14:30:00.000Z",
  "createdBy": "550e8400-e29b-41d4-a716-446655440090",
  "deltas": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440030",
      "transactionId": "550e8400-e29b-41d4-a716-446655440020",
      "startDate": "2025-06-01",
      "endDate": "2026-01-01",
      "path": "policy.annualPremium",
      "action": "Overwrite",
      "value": 95000
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440031",
      "transactionId": "550e8400-e29b-41d4-a716-446655440020",
      "startDate": "2025-01-01",
      "endDate": "2026-01-01",
      "path": "policy.fullTermPolicyBillingInfo",
      "action": "Overwrite",
      "value": {
        "policyPremium": 95000,
        "policyTaxes": 0,
        "policyFees": 500,
        "policyGrandTotal": 95500
      }
    }
  ]
}

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

​
policyId
string<uuid>
required

Policy identifier

​
transactionId
string<uuid>
required

Transaction identifier

Response

Transaction with deltas

A policy transaction in the transaction-based policy model. Each transaction represents an immutable change set (new business, endorsement, cancellation, reinstatement, or renewal) that produces a new policy version.

​
id
string<uuid>
required

Transaction identifier

​
policyId
string<uuid>
required

Policy identifier

​
policyVersion
integer
required

Sequential version number produced by this transaction

​
action
enum<string>
required

Type of transaction

Available options:
NEW_BUSINESS,
ENDORSE,
CANCEL,
REINSTATE,
RENEW
​
effectiveDate
string<date>
required

When the transaction takes effect (ISO 8601)

​
transactionTimestamp
string<date-time>
required

When the business decision was made (ISO 8601)

​
createdAt
string<date-time>
required

When the transaction record was created (ISO 8601)

​
createdBy
string | null
required

User ID who created the transaction (null if system-created)

​
deltas
object[]

Per-field deltas that make up this transaction. Only present on the get-single-transaction endpoint.