We have multiple integration options to connect your system to ours, to make this process as seamless as possible, including API, FTP Upload, Email, and CSV Upload. The most commonly used method is API, which is explained briefly below.

Our API is RESTful. It has resource-oriented URLs, uses basic authentication and HTTPS, at all times. Pre-registration is required to obtain authentication credentials and all data objects are represented via the JSON format.

The following methods are supported:

• HTTP POST: For Create operations
• HTTP GET – For Read operations
• HTTP PUT – For Update operations

Additionally, Our API now supports CORS. For a third-party domain to be allowed to make a CORS request, the domain must be whitelisted by our API. The whitelisting of domains enforces additional security.

Partner Services

Retrieves services available for the Partner

Sample Request:

Output:

                    
                    [
                    {
                    "ServiceId": "1",
                    "ServiceName": "Electricity"
                    },
                    {
                    "ServiceId": "2"
                    "ServiceName": "Gas"
                    },
                    {
                    "ServiceId": "3",
                    "ServiceName": "Water"
                    }
                    ]
                    
                

Create Quick Lead

Enables the submission of a Quick Application from the Partner

Example Request:

                        
                        {
                        "PartnerCode":"utc",
                        "Lead":{
                        "FirstName":"John",
                        "LastName":"Doe",
                        "Email":"testjohn@mail.com",
                        "PrimaryPhone":"0123456789",
                        "MoveInDate":"12-31-2024"
                                 },
                        "SelectedServices":"1,2,3",
                        "AgentReferred":"developer@example.com"
                        }
                        
                    
                

Output:

                        
                        {
                        "PartnerCode":"utc",
                        "Lead":{
                        "FirstName":"John",
                        "LastName":"Doe",
                        "Email":"testjohn@mail.com",
                        "PrimaryPhone":"0123456789",
                        "MoveInDate":"12-31-2024"
                                 },
                        "SelectedServices":"1,2,3",
                        "AgentReferred":"developer@example.com"
                        }
                        
                    
                

Application Status

Enables the Partners to query the status of submitted applications

Sample Request:

Output:

                    [
                    {
                    "ReferenceCode": "mhb-8SP31540",
                    "ApplicationStatus": "Quick",
                    "ApplicationTag": null,
                    "DateAdded": "22-06-2017 13:30:24",
                    "DateUpdated": "22-06-2017 13:30:24",
                    "DateActioned": null,
                    "DateCompleted": null
                    }
                    ]
                

Application Bounce

Enables the Partners to correct an error in any application.

Sample Request:

{
                    "ReferenceCode":"mhb-8SP31540",
                    "Lead":{
                    "PrimaryPhone":"0123456789"
                    },
                    "Metacomment":"Contacted client. Reachable now."
                    }
                    

Output:

{
                    "ReferenceCode":"mhb-8SP31540",
                    "ApplicationStatus":"Partial"
                    }