Insurance Products

Retrieve available insurance products. Insurance products are identified by their slug, which is also the value you send as productId when creating an order with productTypeId: 4.

List Insurance Products

text

GET /products/insurance

API key only, no signature required. This endpoint is not paginated; all active products are returned.

Example Request

GET/v2/partners/products/insurance

curl "https://api.vignetim.com/v2/partners/products/insurance" \
  -H "X-API-Key: $VIGNETIM_API_KEY"

Response

json

{
	"data": [
		{
			"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
			"slug": "green-card",
			"name": "Green Card Insurance",
			"description": "International motor insurance card for cross-border travel.",
			"isActive": true,
			"displayOrder": 1,
			"iconUrl": "https://cdn.vignetim.com/insurance/green-card.png",
			"metadata": {
				"requiredFields": ["vehiclePlate", "startAt"],
				"durations": [15, 30, 90],
				"currencies": ["EUR"]
			}
		}
	],
	"metadata": {
		"total": 3,
		"environment": "LIVE"
	}
}

Insurance Product Object

Field	Type	Description
`id`	UUID	Internal product ID
`slug`	string	Product slug (use as `productId` when ordering)
`name`	string	Product name
`description`	string	Product description (optional)
`isActive`	boolean	Whether the product is currently purchasable
`displayOrder`	integer	Suggested display ordering
`iconUrl`	string	Icon image URL (optional)
`metadata`	object	Product configuration: required fields, available durations, currencies (optional)

Get Insurance Product by Slug

text

GET /products/insurance/:slug

Path Parameters

Name	Type	Required	Description
`slug`	string	Yes	The insurance product slug (e.g., `green-card`)

Example Request

GET/v2/partners/products/insurance/green-card

curl "https://api.vignetim.com/v2/partners/products/insurance/green-card" \
  -H "X-API-Key: $VIGNETIM_API_KEY"

Response

Returns the product in the same data/metadata envelope:

json

{
	"data": {
		"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
		"slug": "green-card",
		"name": "Green Card Insurance",
		"description": "International motor insurance card for cross-border travel.",
		"isActive": true,
		"displayOrder": 1,
		"metadata": {
			"requiredFields": ["vehiclePlate", "startAt"],
			"durations": [15, 30, 90],
			"currencies": ["EUR"]
		}
	},
	"metadata": {
		"environment": "LIVE"
	}
}