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>",
  "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,
  "currentWebRate": 123,
  "leaseInfo": {
    "leaseDocumentUrl": "<string>",
    "leaseDocumentUuid": "<string>",
    "lastSentOn": "2023-11-07T05:31:56Z"
  },
  "organizationUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "unitRentalRecordUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "unitRentalRecordActive": true,
  "coverage": {
    "coverageUuid": "<string>",
    "premiumInPennies": 123,
    "coverageAmountInPennies": 123,
    "description": "<string>"
  },
  "isTaxExempt": true,
  "excludeFromEcri": true,
  "streetRate": 123,
  "pricingRule": "<string>",
  "facilitySegmentUuid": "<string>",
  "location": "<string>",
  "unitNumber": "<string>",
  "unitDimensions": "<string>",
  "unitArea": "<string>",
  "facility": "<string>",
  "rate": 123,
  "brandOrganizationUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenantType": "<string>",
  "reservationTenantType": "<string>",
  "reservationTenantName": "<string>",
  "reservationTenantId": "<string>",
  "sizeAndTypeUnitGroupUuid": "<string>",
  "tierName": "<string>",
  "moveOutRequest": {
    "moveOutRequestUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "moveOutReasonUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "requestedMoveOutDate": "2023-12-25",
    "moveOutReasonDescription": "<string>"
  },
  "isHiddenInRentalFlow": true,
  "floorDescription": "<string>",
  "nextRateChangeDate": "2023-12-25",
  "facilityFloorUuid": "<string>",
  "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>",
  "lockVendor": "NOKE",
  "paymentStatus": "<string>",
  "paymentProfile": {
    "autoPayEnabled": true,
    "lastFour": "<string>",
    "expDate": "<string>",
    "paymentType": "<string>",
    "paymentSource": "<string>",
    "autoPayOffset": 123
  },
  "timeUnitOccupied": "<string>",
  "leaseEffectiveDate": "<string>",
  "moveOutDate": "2023-12-25",
  "lastUnitRateWhenRentalRecordWasActive": 123,
  "moveOutPhotoFiles": [
    "<string>"
  ],
  "promotions": [
    {
      "promotionUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "promotionName": "<string>",
      "discountAmount": 123,
      "discountType": "<string>",
      "startPromotionDate": "2023-12-25",
      "durationMonths": 123,
      "endPromotionDate": "2023-12-25",
      "discountedServiceItemTypeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "discountedServiceItemTypeName": "<string>"
    }
  ],
  "overlockDate": "2023-11-07T05:31:56Z",
  "auctionDate": "2023-11-07T05:31:56Z",
  "taxExemptEffectiveDate": "2023-11-07T05:31:56Z",
  "vehicle": {
    "vehicleUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vehicleType": "<string>",
    "vehicleMake": "<string>",
    "vehicleModel": "<string>",
    "vehicleYear": "<string>",
    "vehicleColor": "<string>",
    "vinNumber": "<string>",
    "licensePlate": "<string>",
    "licensePlateState": "<string>",
    "haveVehicleLien": true,
    "vehicleLien": {
      "vehicleLienUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "holderName": "<string>",
      "holderAddress": "<string>"
    }
  },
  "currentRateChangeDate": "2023-11-07T05:31:56Z",
  "previousRate": 123,
  "previousRateChangeDate": "2023-11-07T05:31:56Z",
  "nextRate": 123,
  "unitGroupDescription": "<string>",
  "doorType": "<string>",
  "doorWidth": 123,
  "doorHeight": 123,
  "unitDetailedDimensions": {
    "depth": 123,
    "width": 123,
    "height": 123,
    "measurementUnit": "<string>"
  },
  "contentsDescription": "<string>",
  "tenant": "<string>",
  "tenantId": "<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,
PENDING_SIGNATURE
​
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
​
currentWebRate
number
required
​
leaseInfo
object
required
​
organizationUuid
string<uuid>
required
​
unitRentalRecordUuid
string<uuid>
required
​
unitRentalRecordActive
boolean
required
​
coverage
object
required
​
isTaxExempt
boolean
required
​
excludeFromEcri
boolean
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>
​
tenantType
string
​
reservationTenantType
string
​
reservationTenantName
string
​
reservationTenantId
string
​
sizeAndTypeUnitGroupUuid
string | null
​
tierName
string | null
​
moveOutRequest
object
​
isHiddenInRentalFlow
boolean
​
floorDescription
string | null
​
nextRateChangeDate
string<date> | null
​
facilityFloorUuid
string | null
​
tenantEmail
string
​
tenantPhone
string
​
tenantBusinessName
string
​
tenantActiveMilitaryStatus
boolean
​
reservationTenantEmail
string
​
reservationTenantPhone
string
​
reservationTenantBusinessName
string
​
billingInfo
object
​
gateCode
string
​
lockCode
string
​
lockVendor
enum<string> | null

Smart Lock provider for the unit

Available options:
NOKE
​
paymentStatus
string
​
paymentProfile
object
​
timeUnitOccupied
string
​
leaseEffectiveDate
string
​
moveOutDate
string<date> | null
​
lastUnitRateWhenRentalRecordWasActive
number | null
​
moveOutPhotoFiles
string[] | null
​
promotions
object[]
​
overlockDate
string<date-time> | null
​
auctionDate
string<date-time> | null
​
taxExemptEffectiveDate
string<date-time> | null
​
vehicle
object
​
currentRateChangeDate
string<date-time>
​
previousRate
number
​
previousRateChangeDate
string<date-time>
​
nextRate
number
​
unitGroupDescription
string
​
doorType
string
​
doorWidth
number
​
doorHeight
number
​
unitDetailedDimensions
object
​
contentsDescription
string
​
tenant
string
​
tenantId
string