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>'
import requests

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

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/v1/external/companies/{companyId}/policies/{policyId}/transactions/{transactionId}', 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/v1/external/companies/{companyId}/policies/{policyId}/transactions/{transactionId}",
  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/v1/external/companies/{companyId}/policies/{policyId}/transactions/{transactionId}"

	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))

}
HttpResponse<String> response = Unirest.get("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/transactions/{transactionId}")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

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

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
{
  "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-06-01",
      "endDate": "2026-01-01",
      "path": "policy.fullTermPolicyBilling.policyPremium",
      "action": "Overwrite",
      "value": 95000
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440032",
      "transactionId": "550e8400-e29b-41d4-a716-446655440020",
      "startDate": "2025-06-01",
      "endDate": "2026-01-01",
      "path": "policy.fullTermPolicyBilling.policyGrandTotal",
      "action": "Overwrite",
      "value": 95500
    }
  ]
}

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

​
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.