Skip to main content
GET
Download Bordereau CSV

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). These columns are appended after the fixed columns.

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:50000

Maximum number of rows to include. Default and maximum 50,000.

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

Number of rows to skip before starting the export. Default 0.

Required range: x >= 0

Response

CSV file download

The response is of type string.