openOM

Payload field reference

Generated from om-0.1.schema.json (openOM payload 0.1). marks required fields.

FieldTypeReqDescription
@contextarray<string>schema.org + the openOM namespace https://openom.app/ns/0.1 (vocabulary published at spec/context/openom-0.1.jsonld).
@typeany
specVersionany
currencystringISO 4217; default USD when absent ([OM-DD-002]).
assertedByobject
assertedBy.brokerstring
assertedBy.brokeragestring
assertedBy.licensestring
assertedBy.websitestringOPTIONAL (#118). The asserting party's website - the identity anchor §10 layer-3 origin verification binds to. Reserved for the registry-era license↔domain↔key cross-check.
assertedBy.licenseJurisdictionstringOPTIONAL (#118). ISO 3166-1/-2 code (e.g. US, US-CA) disambiguating the license number's authority space for worldwide use.
assertedBy.licenseAuthoritystringOPTIONAL (#118). Name of the issuing licensing authority.
assertedDatestring
propertyobject
property.propertyTypestringOPTIONAL (#114). Extensible discriminator: retail | office | industrial | multifamily | land | mixed-use | hospitality | self-storage | other. Open string in 0.1; 0.2 may formalize the enum.
property.addressobject
property.address.streetAddressstring
property.address.addressLocalitystring
property.address.addressRegionstring
property.address.postalCodestring
property.address.addressCountrystring
property.geoobject
property.geo.latitudenumber
property.geo.longitudenumber
property.apnstring
property.buildingSFnumber
property.lotAcresnumber
property.yearBuiltinteger
property.yearRenovatedinteger
property.unitsintegerOPTIONAL. Total rentable units (multifamily / mixed-use).
property.occupancynumberOPTIONAL. Occupancy as a decimal fraction (0.95 = 95%), matching the capRate fraction convention.
dealobject
deal.askingPricenumber
deal.capRatenumber
deal.noinumber
deal.noiTypeenum(in-place, pro-forma)
deal.noiAsOfDatestring
deal.pricePerSFnumber
deal.pricePerUnitnumberOPTIONAL. Asking price per unit (multifamily analog of pricePerSF).
deal.statusenum(active, under-contract, sold, withdrawn)
leaseobject
lease.tenantEntitystring
lease.guarantorobject
lease.guarantor.namestring
lease.guarantor.typeenum(corporate, franchisee, personal, none)
lease.landlordResponsibilitiesobject
lease.landlordResponsibilities.roofboolean
lease.landlordResponsibilities.structureboolean
lease.landlordResponsibilities.parkingboolean
lease.landlordResponsibilities.hvacboolean
lease.landlordResponsibilities.taxesboolean
lease.landlordResponsibilities.insuranceboolean
lease.landlordResponsibilities.camboolean
lease.leaseTypeAssertedenum(N, NN, NNN, absolute-net, gross, modified-gross)
lease.commencementstring
lease.expirationstring
lease.termMonthsnumberStated total lease term in months; cross-checked against expiration - commencement (OMW-W031).
lease.remainingTermMonthsnumberStated remaining term in months as of assertedDate; cross-checked against expiration - as_of (OMW-W030).
lease.rentSchedulearray<rentPeriod>
lease.optionsarray<object>
metaobject
meta.sourceDocHashsha256OrNull
meta.supersedessha256OrNull
meta.signatureanyReserved (#117, §11.1 layer-4). Either null/absent OR the {alg,keyId,value} envelope. 0.1 consumers MUST IGNORE a populated value (no trust weight); it is excluded from the integrity preimage ([OM-CANON-003]) so it stays additive. A value that is neither null nor the reserved shape is OMV-E003.
meta.imageRightsstring
extobjectOPTIONAL (#115). The ONLY place non-standard/vendor fields belong - namespaced by vendor (e.g. `"ext": { "acme": { ... } }`) so they never collide with future core terms. 0.1 tools preserve it and MUST NOT interpret it.