Skip to main content
GET
/
shopping
/
{portfolio}
/
v1
/
units
/
{leadUuid}
/
{verifyCode}
Get Unit by Lead UUID and Verify Code
curl --request GET \
  --url https://public-api.prd.monument.io/shopping/{portfolio}/v1/units/{leadUuid}/{verifyCode} \
  --header 'x-api-key: <x-api-key>'
{
  "id": "<string>",
  "unitType": "<string>",
  "entityAttributeOrganizationUuid": "<string>",
  "occupancyStatus": "VACANT",
  "facilityUuid": "<string>",
  "lastModified": "2023-11-07T05:31:56Z",
  "amenities": [
    {
      "entityAttributeId": "<string>",
      "unitId": "<string>",
      "description": "<string>",
      "active": true
    }
  ],
  "unitGroupUuid": "<string>",
  "unitGroupName": "<string>",
  "unitGroupUnitType": "<string>",
  "unitGroupDimensions": "<string>",
  "unitCurrentRate": 123,
  "delinquencyStage": "OVERDUE",
  "organizationUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "unitRentalRecordUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "unitRentalRecordActive": true,
  "coverage": {
    "coverageUuid": "<string>",
    "premiumInPennies": 123,
    "coverageAmountInPennies": 123,
    "description": "<string>"
  },
  "streetRate": 123,
  "pricingRule": "<string>",
  "facilitySegmentUuid": "<string>",
  "location": "<string>",
  "unitNumber": "<string>",
  "unitDimensions": "<string>",
  "unitArea": "<string>",
  "facility": "<string>",
  "rate": 123,
  "brandOrganizationUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reservationTenantType": "<string>",
  "reservationTenantName": "<string>",
  "reservationTenantId": "<string>",
  "moveOutRequest": {
    "moveOutRequestUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "moveOutReasonUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "moveOutReasonDescription": "<string>",
    "requestedMoveOutDate": "2023-11-07T05:31:56Z"
  },
  "tenantEmail": "<string>",
  "tenantPhone": "<string>",
  "tenantBusinessName": "<string>",
  "tenantActiveMilitaryStatus": true,
  "reservationTenantEmail": "<string>",
  "reservationTenantPhone": "<string>",
  "reservationTenantBusinessName": "<string>",
  "billingInfo": {
    "outstandingBalance": {
      "taxes": "0.00",
      "total": "0.00"
    },
    "nextPaymentDue": {
      "taxes": "0.00",
      "total": "0.00"
    }
  },
  "gateCode": "<string>",
  "lockCode": "<string>",
  "paymentStatus": "<string>",
  "paymentProfile": {
    "autoPayEnabled": true,
    "lastFour": "<string>",
    "expDate": "<string>",
    "paymentType": "<string>",
    "paymentSource": "<string>"
  },
  "timeUnitOccupied": "<string>",
  "leaseEffectiveDate": "<string>",
  "moveOutPhotoFiles": [
    "<string>"
  ],
  "promotions": [
    "<array>"
  ],
  "overlockDate": "2023-11-07T05:31:56Z",
  "auctionDate": "2023-11-07T05:31:56Z",
  "currentRateChangeDate": "2023-11-07T05:31:56Z",
  "previousRate": 123,
  "previousRateChangeDate": "2023-11-07T05:31:56Z",
  "nextRate": 123,
  "nextRateChangeDate": "2023-11-07T05:31:56Z",
  "unitGroupDescription": "<string>",
  "doorType": "<string>",
  "doorWidth": 123,
  "doorHeight": 123,
  "unitDetailedDimensions": {
    "depth": 123,
    "width": 123,
    "height": 123,
    "measurementUnit": "<string>"
  },
  "tenant": "<string>",
  "tenantId": "<string>",
  "tenantType": "<string>"
}

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

​
leadUuid
string
required
​
verifyCode
string
required

Response

200 - application/json

The details of a leads unit once they have been signed their lease and been converted to a tenant

​
id
string
required
​
unitType
string | null
required
​
entityAttributeOrganizationUuid
string
required
​
occupancyStatus
enum<string>
required
Available options:
VACANT,
RESERVED,
OCCUPIED,
UNRENTABLE,
OWNER OCCUPIED
​
facilityUuid
string
required
​
lastModified
string<date-time>
required
​
amenities
object[]
required
​
unitGroupUuid
string | null
required
​
unitGroupName
string
required
​
unitGroupUnitType
string
required
​
unitGroupDimensions
string
required
​
unitCurrentRate
number
required
​
delinquencyStage
enum<string> | null
required
Available options:
OVERDUE,
OVERLOCK,
LIEN,
AUCTION,
PAID,
PAUSED,
WRITTEN_OFF
​
organizationUuid
string<uuid>
required
​
unitRentalRecordUuid
string<uuid>
required
​
unitRentalRecordActive
boolean
required
​
coverage
object
required
​
streetRate
number
required
​
pricingRule
string
required
​
facilitySegmentUuid
string
required
​
location
string
required
​
unitNumber
string
required
​
unitDimensions
string
required
​
unitArea
string
required
​
facility
string
required
​
rate
number
required
​
brandOrganizationUuid
string<uuid>
​
reservationTenantType
string
​
reservationTenantName
string
​
reservationTenantId
string
​
moveOutRequest
object
​
tenantEmail
string
​
tenantPhone
string
​
tenantBusinessName
string
​
tenantActiveMilitaryStatus
boolean
​
reservationTenantEmail
string
​
reservationTenantPhone
string
​
reservationTenantBusinessName
string
​
billingInfo
object
​
gateCode
string
​
lockCode
string
​
paymentStatus
string
​
paymentProfile
object
​
timeUnitOccupied
string
​
leaseEffectiveDate
string
​
moveOutPhotoFiles
string[] | null
​
promotions
array[] | null
​
overlockDate
string<date-time> | null
​
auctionDate
string<date-time> | null
​
currentRateChangeDate
string<date-time>
​
previousRate
number
​
previousRateChangeDate
string<date-time>
​
nextRate
number
​
nextRateChangeDate
string<date-time>
​
unitGroupDescription
string
​
doorType
string
​
doorWidth
number
​
doorHeight
number
​
unitDetailedDimensions
object
​
tenant
string
​
tenantId
string
​
tenantType
string