Get private coverage information - Monument Public API

GET

shopping

{portfolio}

coverages

private

Get private coverage information

curl --request GET \
  --url https://public-api.prd.monument.io/shopping/{portfolio}/v1/coverages/private \
  --header 'x-api-key: <x-api-key>'

{
  "provider": "SAFE_LEASE",
  "providerWebsiteUrl": "<string>",
  "description": "<string>"
}

x-api-key

any

required

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

Example:

"monument-2230012-2312321"

200 - application/json

Successfully retrieved private coverage information

provider

enum<string>

required

The coverage provider type

Available options:

SAFE_LEASE,

SECURE_LEASE,

OTHER

providerWebsiteUrl

string

required

The website URL of the coverage provider

description

string

required

The description of the coverage provider

⌘I

Get private coverage information

curl --request GET \
  --url https://public-api.prd.monument.io/shopping/{portfolio}/v1/coverages/private \
  --header 'x-api-key: <x-api-key>'

{
  "provider": "SAFE_LEASE",
  "providerWebsiteUrl": "<string>",
  "description": "<string>"
}