Skip to main content

List policies of an order

Lists the policies produced by an emitted order — the way to discover the policy_keys of an order, since the order retrieval does not return policies. Returns summaries; for the full detail, use the policy retrieval.

Request

ENDPOINT
/v1/insurance/policies
METHOD
GET

Query params

ParameterTypeRequiredDescription
order_keystringrequiredKey of the order whose policies will be listed.
Example call
GET /v1/insurance/policies?order_key=5e2b3f60-7c4b-4c8e-9f1a-6d2e8b4a7c90

Response

STATUS
200
Response Body
{
"order_key": "5e2b3f60-7c4b-4c8e-9f1a-6d2e8b4a7c90",
"policies": [
{
"policy_key": "0b6e7c1a-9a4e-4c1e-b1d4-2f5a8c9e0d31",
"provider_product_key": "9d1f8c7a-3b21-4e60-8a2f-1c5d7e9b0a44",
"provider_key": "c4a2e8b0-1f6d-4e3a-9c7b-5d0a2e8f4b61",
"status": "issued",
"external_policy_number": "APL-2026-000123",
"gross_premium_amount": 617.28,
"term": {
"start_date": "2026-07-16",
"end_date": "2027-07-15"
},
"created_at": "2026-07-16T14:03:25.481Z"
}
]
}

Response attributes

FieldTypeDescription
order_keystringKey of the queried order.
policiesarraySummary of each policy of the order. Fields are a subset of the policy retrieval.
Eventual consistency after emission

Policies are created asynchronously right after the order's emitted webhook. Immediately after emission, this list may come back empty or shorter than the webhook's product_count while the policies are being materialized. Wait for the policy webhooks or query again shortly.

An order_key that is unknown, not yet processed or belonging to another integration returns 200 with an empty list — the cases are indistinguishable.

Possible errors

Every error (non-2xx) returns the standard body { "title", "description", "translation", "code" } — programmatically handle only the code field.

StatusCodeDescription
400QIT000001Missing order_key parameter.
401 / 403Authentication or authorization failure.
429Request limit exceeded — retry with backoff.
500QIT000500Internal error — safe to retry the call.
503POL000030Service unavailable — safe to retry the call.