MortgageGuidelines API

Sources

Inspect available agency, tenant, and shared sources.

Sources

Use GET /v1/sources to discover which source filters are available to the authenticated API key.

cURL
curl -X GET "https://api.mortgageguidelines.com/v1/sources" \
  -H "X-API-Key: mgapi_live_your_key_here"
Example response
{
  "request_id": "req_9b8f0b5fcb5b4eaa",
  "agency_source_types": [
    "fannie_mae",
    "fha"
  ],
  "enabled_sources": [
    "fannie_mae",
    "fha"
  ],
  "base_sources": [
    "mortgage_guidelines"
  ],
  "tenant_source_sidebar_mode": "flat",
  "tenant_sources": [
    {
      "key": "product-guides",
      "label": "Product Guides",
      "description": "Internal product guidance",
      "defaultOn": true
    }
  ],
  "tenant_source_keys": [
    "product-guides"
  ],
  "secondary_sources": [
    {
      "type": "tenant_bucket",
      "key": "product-guides",
      "label": "Product Guides",
      "defaultOn": true
    },
    {
      "type": "shared_source",
      "sourceType": "mortgage_guidelines",
      "label": "Mortgage Guidelines",
      "defaultOn": false
    }
  ],
  "default_tenant_source_keys": [
    "product-guides"
  ],
  "default_shared_source_types": [
    "mortgage_guidelines"
  ],
  "assigned_shared_source_types": [
    "mortgage_guidelines"
  ]
}

Selection rules

  • agency_source_types must be a subset of enabled agency sources
  • tenant_source_keys must match assigned tenant buckets
  • shared_source_types must match assigned shared sources
  • At least one source selection must remain after validation