Skip to main content
GET
Get coverage options for the portfolio

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

Response

200 - application/json

Array of coverage options for the portfolio, with their assigned facilities

coverageUuid
string<uuid>
required

UUID of the coverage

Example:

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

premiumInPennies
number
required

Coverage premium amount in pennies

Example:

2500

coverageAmountInPennies
number
required

Coverage amount in pennies

Example:

10000000

facilities
object[]
required

Facilities associated with this coverage

partnerCoverageId
string | null

Partner coverage ID

Example:

"COVERAGE_PARTNER_123"

description
string | null

Partner provided description of the coverage

Example:

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

providerTermsUrl
string | null

Partner provided url with terms

Example:

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