Relativity6Platform Docs
POST/co-tenant

Co-tenant

Returns geocoding, building footprint, county, and co-tenant mix for a US street address. Use this when you need property-level occupancy context (for example multi-tenant buildings or shared office space) without running a full industry classification.

Base URLhttps://classification.relativity6.com

Authentication

Send your API key in the x-api-key header. Send your API key in this header on every request. Modern keys use the format r6-<keyId>.<secret>. Each successful call consumes one Marvin2 API quota unit.

Request body

FieldTypeRequiredDescription
addressstringRequiredStreet address line (for example `45 Prospect St`).
citystringRequiredCity name.
statestringRequiredUS state or region code (for example `MA`).
postalstringRequiredPostal or ZIP code.

Response

FieldTypeRequiredDescription
geocodeobjectOptionalCoordinates for the requested address when a match is found.
latnumberRequiredLatitude.
lngnumberRequiredLongitude.
structureobjectOptionalBuilding footprint metadata when available.
structure_polygonstringOptionalEncoded polygon for the matched structure.
tenantsarrayOptionalBusinesses identified at or near the address.
location_namestringOptionalTenant or location label.
brand_namestringOptionalBrand name when available.
naics_codestringOptionalNAICS code for the tenant when available.
top_categorystringOptionalHigh-level category label.
sub_categorystringOptionalMore specific category label.
street_addressstringOptionalTenant street address when distinct from the query address.
citystringOptionalTenant city.
regionstringOptionalTenant state or region.
postal_codestringOptionalTenant postal code.
latitudenumberOptionalTenant latitude.
longitudenumberOptionalTenant longitude.
county_namestringOptionalCounty for the matched address.
timestampstring (ISO 8601)RequiredWhen the response was generated.
traceIdstringOptionalCorrelation id for support requests.

Errors

StatusDescription
400Invalid JSON or missing required address fields.
401Missing or invalid API key.
403Quota exceeded or not authorized.
429Rate limit exceeded.
502Upstream property data provider returned an error.
503Service configuration error. Retry later.
504Timeout or communication error calling upstream property data.
500Unexpected server error.

Example request

Example response