MLS profiles and compliance
Use source-qualified MLS branding, attribution, rules, and refresh requirements safely
MLS profiles combine licensed dataset inventory with reviewed compliance content. The endpoint returns only approved profiles available to the caller.
Interactive reference
Inspect the endpoint schema and test an authenticated request.
Account resources
Discover which MLS datasets and products the current key can access.
Where profiles come from
| Input | Authority | Supplies |
|---|---|---|
| Dataset inventory | Governed resource and OSN inventory | dataset_id, OriginatingSystemName, and available resource names |
| Reviewed compliance registry | Customer-facing names and legal presentation | Logo, disclaimer, rules link, and required update frequency |
| Signed entitlement | Which datasets the caller may discover | Products, geography, dataset access, and channel policy |
Never use OSN as the durable identity
Use dataset_id in every cache and database key. Two licensed datasets may
share an OriginatingSystemName while carrying different fields, cadence, and
attribution requirements.
Response example
{
"data": [
{
"dataset_id": "1d3d9be4-2a37-4ea7-bd49-214f224b8157",
"originating_system_name": "ExampleMLS",
"originating_system_full_name": "Example Multiple Listing Service",
"resources": [
{ "name": "Property", "key": "ListingKey", "collection": "/reso/odata/Property" },
{ "name": "Member", "key": "MemberKey", "collection": "/reso/odata/Member" },
{ "name": "Office", "key": "OfficeKey", "collection": "/reso/odata/Office" },
{ "name": "OpenHouse", "key": "OpenHouseKey", "collection": "/reso/odata/OpenHouse" }
],
"compliance": {
"disclaimer": "Display the current reviewed MLS attribution…",
"logo_url": "https://assets.example.invalid/mls/example.svg",
"rules_url": "https://rules.example.invalid/example",
"required_update_frequency_hours": 12
}
}
],
"meta": { "count": 1 }
}Presentation rules
- Render the disclaimer as reviewed text. Do not rewrite or concatenate it with another MLS disclaimer.
- Fetch logos from the returned HTTPS URL and retain accessible alternate text using the full MLS name.
- Treat
rules_urlas the current human-readable compliance reference, not as a machine authorization signal. - Use
required_update_frequency_hoursto set a maximum staleness target. Faster refresh is allowed; slower refresh requires explicit approval. - A missing optional value means the compliance registry has no reviewed value. It does not mean the requirement is waived.
Operational changes
Automated inventory can propose a new OSN, but it cannot approve a dataset or author legal content. New profiles remain unavailable until control-plane review is complete. Suspended or terminated datasets disappear from the response and are removed from serving entitlements.