Skip to main content
GET
/
api
/
v1
/
external
/
companies
/
{companyId}
/
policies
/
bordereau
List Bordereau Rows
curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/bordereau \
  --header 'Authorization: <api-key>'
import requests

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

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/bordereau', 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/bordereau",
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/bordereau"

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/bordereau")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

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

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": [
    {
      "policyNumber": "POL-2025-001",
      "primaryInsuredName": "Mercy General Hospital",
      "transactionAction": "NEW_BUSINESS",
      "policyVersion": 1,
      "effectiveDate": "2025-01-01",
      "transactionTimestamp": "2025-01-15T10:30:00.000Z",
      "policyStartDate": "2025-01-01",
      "policyEndDate": "2026-01-01",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "createdBy": "api-key|abc123",
      "policyPremium": 85000,
      "policyPremiumChange": 85000,
      "additionalColumns": {}
    },
    {
      "policyNumber": "POL-2025-001",
      "primaryInsuredName": "Mercy General Hospital",
      "transactionAction": "ENDORSE",
      "policyVersion": 2,
      "effectiveDate": "2025-06-01",
      "transactionTimestamp": "2025-06-01T14:00:00.000Z",
      "policyStartDate": "2025-01-01",
      "policyEndDate": "2026-01-01",
      "createdAt": "2025-06-01T14:00:00.000Z",
      "createdBy": "api-key|abc123",
      "policyPremium": 102000,
      "policyPremiumChange": 17000,
      "additionalColumns": {}
    }
  ],
  "totalCount": 2
}

Authorizations

Authorization
string
header
required

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

Path Parameters

companyId
string<uuid>
required

Company identifier

Query Parameters

periodStart
string<date-time>

Inclusive lower bound on transactionTimestamp. Only transactions at or after this timestamp are included.

periodEnd
string<date-time>

Exclusive upper bound on transactionTimestamp. Only transactions before this timestamp are included.

actions
string

Comma-separated list of transaction actions to include. Valid values: NEW_BUSINESS, ENDORSE, CANCEL, REINSTATE, RENEW. Omit to include all actions.

Note: Unrecognized action values are not rejected — they silently match zero rows. Double-check spelling if results are unexpectedly empty.

additionalColumns
string

JSON-encoded array of additional column definitions. Each element is an object with path (dot-separated path into the segment's policy data) and columnHeader (display name for the column).

sortBy
enum<string>

Field to sort results by. Default transactionTimestamp.

Available options:
policyNumber,
primaryInsuredName,
effectiveDate,
transactionTimestamp,
createdAt
sortDirection
enum<string>
default:desc

Sort direction (default desc).

Available options:
asc,
desc
limit
integer
default:50

Maximum number of rows to return per request. Default 50, maximum 1000.

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of rows to skip before returning results. Default 0.

Required range: x >= 0

Response

Paginated list of bordereau rows

Paginated bordereau response containing transaction-level premium rows.

items
object[]
required

Bordereau rows for the current page.

totalCount
integer
required

Total number of matching rows across all pages.