Why are these endpoints deprecated?
The original V1 policy endpoints used a simple CRUD model — create a policy, update it directly, delete it. This worked for basic cases but didn’t capture the transactional nature of insurance policy changes (endorsements, cancellations, reinstatements, renewals). The transaction-based Policy API replaces these endpoints with a model that:- Records every change as a transaction — providing a full audit trail of policy modifications
- Supports the complete policy lifecycle — new business, endorsements, cancellations, reinstatements, and renewals
- Tracks policy versions — each transaction produces a new version, so you can retrieve the policy state at any point in time
- Manages earned premium — with built-in earned premium calculations and bordereau reporting
Deprecated Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/external/companies/{companyId}/policies | List policies |
| POST | /api/v1/external/companies/{companyId}/policies | Create a policy |
| GET | /api/v1/external/companies/{companyId}/policies/{policyId} | Get a policy |
| DELETE | /api/v1/external/companies/{companyId}/policies/{policyId} | Delete a policy |
Migrating to the Transaction-Based API
| Deprecated endpoint | Replacement |
|---|---|
POST /policies (create) | POST /policies/transaction/new-business |
GET /policies (list) | GET /policies/list |
GET /policies/{policyId} (get) | GET /policies//versions/ |
DELETE /policies/{policyId} | DELETE /policies//transactions/ (deletes a specific transaction) |
