Get coverage history details by UUIDs

POST

api

{portfolio}

portfolios

facilities

{facilityUuid}

coverageHistory

get_by_uuids

Get coverage history details by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "coverageHistoryUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids"

payload = { "coverageHistoryUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    coverageHistoryUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '3fa85f64-5717-4562-b3fc-2c963f66afa7']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'coverageHistoryUuids' => [
        '3fa85f64-5717-4562-b3fc-2c963f66afa6',
        '3fa85f64-5717-4562-b3fc-2c963f66afa7'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids"

	payload := strings.NewReader("{\n  \"coverageHistoryUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"coverageHistoryUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"coverageHistoryUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "monumentCoverageEnrollmentUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "unitRentalRecordUuid": "2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
    "coverageStartDate": "2024-01-15T00:00:00.000Z",
    "unitNumber": "A101",
    "coverageUuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "coveragePremium": 2500,
    "coverageAmount": 500000,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T15:45:00.000Z",
    "isPrivate": false,
    "status": "ACTIVE",
    "coverageProvider": "SAFE_LEASE",
    "facilityUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "unitUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "facilityDescription": "Main Street Storage",
    "primaryContact": {
      "firstName": "Jane",
      "lastName": "Doe",
      "address1": "123 Main St",
      "address2": "Apt 4B",
      "city": "Anytown",
      "state": "CA",
      "zipcode": "90210",
      "email": "jane.doe@example.com",
      "phone": "+15551234567",
      "optedIntoSms": true,
      "dateOfBirth": "2024-01-01"
    },
    "alternateContacts": [
      {
        "firstName": "Jane",
        "lastName": "Doe",
        "address1": "123 Main St",
        "address2": "Apt 4B",
        "city": "Anytown",
        "state": "CA",
        "zipcode": "90210",
        "email": "jane.doe@example.com",
        "phone": "+15551234567",
        "optedIntoSms": true,
        "dateOfBirth": "2024-01-01"
      }
    ],
    "tenantPrivatePolicy": {
      "providerName": "State Farm",
      "policyHolderName": "Jane Doe",
      "policyNumber": "POL-123456",
      "expirationDate": "2027-04-15",
      "submittedBy": "TENANT",
      "dateCreated": "2026-04-01T12:00:00.000Z"
    },
    "coverageEndDate": "2024-12-31T23:59:59.999Z",
    "partnerCoverageId": "COVERAGE_PARTNER_123"
  }
]

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

facilityUuid

string

required

Body

application/json

coverageHistoryUuids

string<uuid>[]

required

Array of coverage history UUIDs to retrieve

Example:

[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "3fa85f64-5717-4562-b3fc-2c963f66afa7"
]

Response

200 - application/json

Coverage history details retrieved successfully

monumentCoverageEnrollmentUuid

string<uuid>

required

UUID of the monument coverage enrollment

Example:

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

unitRentalRecordUuid

string<uuid>

required

UUID of the unit rental record

Example:

"2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d"

coverageStartDate

string<date-time>

required

Coverage start date

Example:

"2024-01-15T00:00:00.000Z"

unitNumber

string

required

Unit number

Example:

"A101"

coverageUuid

string<uuid>

required

UUID of the coverage. For private coverage, this will be the private coverage UUID: 11111111-1111-1111-1111-111111111111

Example:

"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

coveragePremium

number

required

Coverage premium amount in pennies

Example:

2500

coverageAmount

number

required

Coverage amount in pennies

Example:

500000

createdAt

string<date-time>

required

Creation timestamp

Example:

"2024-01-15T10:30:00.000Z"

updatedAt

string<date-time>

required

Last update timestamp

Example:

"2024-01-20T15:45:00.000Z"

isPrivate

boolean

required

Whether this is a private (self-managed) coverage enrollment

Example:

false

status

enum<string>

required

Enrollment status derived from endDate

Available options:

ACTIVE,

INACTIVE

Example:

"ACTIVE"

coverageProvider

enum<string> | null

required

Coverage provider. Null for private coverage.

Available options:

SAFE_LEASE,

SECURE_LEASE,

STORAGE_SHIELD,

RV_PARK_N_PROTECT,

OTHER

Example:

"SAFE_LEASE"

facilityUuid

string<uuid>

required

UUID of the facility

unitUuid

string<uuid>

required

UUID of the unit

facilityDescription

string

required

Denormalized facility name (max 25 chars)

Example:

"Main Street Storage"

primaryContact

object | null

required

Primary contact for the account linked to this enrollment

Show child attributes

alternateContacts

object[]

required

Alternate contacts for the account. Contains at most one entry.

Show child attributes

tenantPrivatePolicy

object | null

required

Current private-policy submission for this enrollment. Populated only for private (self-managed) coverage with a current submission; null otherwise.

Show child attributes

coverageEndDate

string<date-time> | null

Coverage end date

Example:

"2024-12-31T23:59:59.999Z"

partnerCoverageId

string | null

Partner coverage ID

Example:

"COVERAGE_PARTNER_123"

Get coverage options for a facilityRetrieves all non-archived coverage plans configured for the specified facility.

Get coverage history details by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "coverageHistoryUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids"

payload = { "coverageHistoryUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    coverageHistoryUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '3fa85f64-5717-4562-b3fc-2c963f66afa7']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'coverageHistoryUuids' => [
        '3fa85f64-5717-4562-b3fc-2c963f66afa6',
        '3fa85f64-5717-4562-b3fc-2c963f66afa7'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids"

	payload := strings.NewReader("{\n  \"coverageHistoryUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"coverageHistoryUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/coverageHistory/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"coverageHistoryUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "monumentCoverageEnrollmentUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "unitRentalRecordUuid": "2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
    "coverageStartDate": "2024-01-15T00:00:00.000Z",
    "unitNumber": "A101",
    "coverageUuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "coveragePremium": 2500,
    "coverageAmount": 500000,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T15:45:00.000Z",
    "isPrivate": false,
    "status": "ACTIVE",
    "coverageProvider": "SAFE_LEASE",
    "facilityUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "unitUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "facilityDescription": "Main Street Storage",
    "primaryContact": {
      "firstName": "Jane",
      "lastName": "Doe",
      "address1": "123 Main St",
      "address2": "Apt 4B",
      "city": "Anytown",
      "state": "CA",
      "zipcode": "90210",
      "email": "jane.doe@example.com",
      "phone": "+15551234567",
      "optedIntoSms": true,
      "dateOfBirth": "2024-01-01"
    },
    "alternateContacts": [
      {
        "firstName": "Jane",
        "lastName": "Doe",
        "address1": "123 Main St",
        "address2": "Apt 4B",
        "city": "Anytown",
        "state": "CA",
        "zipcode": "90210",
        "email": "jane.doe@example.com",
        "phone": "+15551234567",
        "optedIntoSms": true,
        "dateOfBirth": "2024-01-01"
      }
    ],
    "tenantPrivatePolicy": {
      "providerName": "State Farm",
      "policyHolderName": "Jane Doe",
      "policyNumber": "POL-123456",
      "expirationDate": "2027-04-15",
      "submittedBy": "TENANT",
      "dateCreated": "2026-04-01T12:00:00.000Z"
    },
    "coverageEndDate": "2024-12-31T23:59:59.999Z",
    "partnerCoverageId": "COVERAGE_PARTNER_123"
  }
]