API is a secure, digital bridge that allows your external software applications (like your CRM, accounting software, or custom website) to "talk" directly to your Mortgage Automator account. Instead of having a human manually type data or click buttons, the API allows your systems to securely sync data back and forth automatically.
What is the Intention of the API?
The API is built to make daily operations easier and reduce manual steps. It is primarily used for:
Data Transparency: Feeding live loan and investor data into your custom reporting dashboards (like Power BI) so you can run deep analytics
Zero-Touch Origination: Connecting your website's lead intake forms so that new applications automatically create draft loans in MA.
Accounting Synchronization: Pushing data to or receiving payment updates from external accounting platforms (like Xero or QuickBooks) to keep your General Ledger perfectly balanced.
Bulk Processing: Updating statuses of fields on hundreds of loans in seconds without manual data entry.
Core Capabilities
Retrieve Data: Pull detailed live information regarding your loans, borrowers, investors and properties.
Update and Create: Create new borrower profiles, generate new loan files, update specific fields or loan sub statuses.
Execute Servicing Logic: Your developers can programmatically trigger complex financial actions, such as recording partial paydowns, adding a payment, or executing a loan renewal. The API will automatically handle the ledger math.
Download Documents: Securely retrieve and download any files (like Appraisals or IDs) that are stored within a loan's Document Categories.
How to Enable the API Integration Package and Documentation
Before your company can use the API, three things must be set up in MA:
The Integration Package: Your company must have the API integration package enabled on your subscription. You can check this by navigating to Settings (gear icon) > Company Settings > Third Party.
User Permissions: To view the API documentation, your specific user account must have the "API" permission enabled. An account Admin (someone with the Master/Admin role) can enable this for you by going to Settings > User Settings.
Authentication Token: Your developers will need an authentication token (the MA Key) to connect. This alphanumeric key is securely located in Settings > Company Settings > Third Party.
Note: If you do not have the API integration package and are interested in adding it to your subscription, please reach out to your Customer Success Representative or Customer Support.
Limitations of the API
The "Funding" Safety Rail: The API can automate 99% of your workflow, but it cannot physically push the final "Fund" button. This is an intentional compliance feature to ensure a human reviews the file.
Communications are Separate: Updating a loan status via the API will not automatically trigger Mortgage Automator's internal UI email/SMS pop-ups. The API strictly updates the data record. External communications should be handled by your connected CRM.
Global Access: API Keys are generated at the Company level, not the User level. This means an API key acts as a "Master Key" for the account and cannot be restricted to only view specific loans.
Siloed Updates: The API is highly structured to prevent accidental data overwrites. For example, you cannot update a Borrower's home address and the Loan's interest rate in the exact same command. They must be updated precisely in their respective "silos."
Network / Cloudflare Blocks: If your developers are testing the API heavily from a local office or residential network, they may encounter an HTTP 403 (Error 1010). This is our Cloudflare security system protecting against bot traffic. It is highly recommended to run production API calls from verified cloud servers (like AWS or GCP) rather than local networks.
FAQ
Q: Can the API be used to replace manual work completely?
A: Almost. The API can automate most workflows, but some actions (like funding and certain reviews) still require manual steps for accuracy and compliance.
Q: What happens if an API request fails or is incomplete?
A: The system will reject the request and return an error message. No partial updates will be applied, helping prevent inconsistent data.
Q: Does the API make changes instantly in Mortgage Automator?
A: Yes. Most API actions update the system in real-time, but how quickly you see the changes may depend on your integration setup or reporting tools.