Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
coverageOptions
Create coverage option
curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/coverageOptions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "premiumInPennies": 2500,
  "coverageAmountInPennies": 10000000,
  "providerTermsUrl": "https://partner.com/terms/coverage-123",
  "providerCoverageId": "COVERAGE_PARTNER_123",
  "description": "Premium tenant protection insurance with up to $100,000 coverage"
}
'
{
  "itemTypeUuid": "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
  "coverageUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Documentation Index

Fetch the complete documentation index at: https://api.monument.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-api-key
any
required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

Body

application/json
​
premiumInPennies
number
required

Value paid monthly by the person that uses this coverage

Example:

2500

​
coverageAmountInPennies
number
required

Value paid by the insurance company in case of a claim

Example:

10000000

​
providerTermsUrl
string
required

Url to the acceptance terms for the partner's coverage

Example:

"https://partner.com/terms/coverage-123"

​
providerCoverageId
string
required

This id represents the coverage item in the partner's database

Example:

"COVERAGE_PARTNER_123"

​
description
string
required

Value for the coverage description and new itemType name and description

Example:

"Premium tenant protection insurance with up to $100,000 coverage"

Response

200 - application/json

Successfully created coverage option

​
itemTypeUuid
string<uuid>
required

UUID of the created item type

Example:

"4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e"

​
coverageUuid
string<uuid>
required

UUID of the created coverage

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"