# KeyNect

When the KeyNect integration is enabled within Keyfax any photos, videos or audio files captured during a KeyNect call will be available within the Keyfax results.

When integrated with KeyNect a URL is returned within the Keyfax results for each captured media file. These URLs are links to view the captured media file via the KeyNect Portal and will require you to login to your KeyNect account.

{% hint style="info" %}
**TIP** If you would like to download captured KeyNect media files programmatically (for example to store them within your housing management system or similar host system) you should use the KeyNect REST based Web API. The KeyNect REST based Web API provides an endpoint to programmatically obtain media files.
{% endhint %}

### Example Keyfax Results

#### Repair Diagnostics

The below examples show a repair returned from Keyfax via the [SOAP API](/integrations/apis/soap.md) and [REST API](/integrations/apis/rest-api.md) with KeyNect URLs returned within the `Uploads` element / property.

**XML Example**

```xml
<KeyfaxData xmlns:json="http://james.newtonking.com/projects/json">
    <Fault name="Fault1" type="RD" json:Array="true">
        <IsDeleted>False</IsDeleted>
        <IsDirty>False</IsDirty>
        <IsNew>True</IsNew>
        <Fault_Dialog>11542</Fault_Dialog>
        <Fault_Category>10794</Fault_Category>
        <CompanyCode />
        <ScriptSet>1</ScriptSet>
        <FaultText><![CDATA[Windows: Frame; damaged or rotten; loft; top hung; wood; fair wear and tear]]></FaultText>
        <LogDate>22/01/2026 12:56:00</LogDate>
        <Communal_Type />
        <Reason_Code />
        <Reason_Text />
        <Recharge>0</Recharge>
        <Recharge_Code>RREP</Recharge_Code>
        <Recharge_Cost>40.50</Recharge_Cost>
        <Repair_No />
        <Repair_Status>2</Repair_Status>
        <RTR />
        <RTR_Date />
        <Insurance />
        <Schedule_ID>operator\157</Schedule_ID>
        <Site_Visit><![CDATA[]]></Site_Visit>
        <Additional_Info><![CDATA[Window frame is peeling slightly]]></Additional_Info>
        <Special_Instructions><![CDATA[]]></Special_Instructions>
        <Tenancy_Type />
        <ClientID />
        <TenantID>9f9e014c-8582-ec11-8d21-0022481b4e5a</TenantID>
        <TenantText><![CDATA[Paul Ancill, 14 Heather View Road, Poole, BH12 4AQ]]></TenantText>
        <UserCode>operator</UserCode>
        <ScriptPath>
            <Question>Q1 = What is the problem with the window frame?: A1 = window frame - damaged or rotten</Question>
            <Question>Q2 = Which door or window is it?: A2 = loft</Question>
            <Question>Q3 = What type of window is it?: A3 = top hung</Question>
            <Question>Q4 = What type of frame is it?: A4 = wood</Question>
            <Question>Q5 = Is temporary boarding required?: A5 = No</Question>
            <Question>Q6 = How did it happen?: A6 = fair wear and tear</Question>
        </ScriptPath>
        <Contractor_Code />
        <Contractor_Email />
        <Expenditure_Code />
        <Nominal_Code />
        <Summary />
        <Job_Code />
        <Location />
        <HDIH />
        <RepairCount>1</RepairCount>
        <AdviceCount>0</AdviceCount>
        <CustomCount>0</CustomCount>
        <ActionCount>0</ActionCount>
        <SubActionCount>0</SubActionCount>
        <UpdateCount>0</UpdateCount>
        <Repair name="Repair1" json:Array="true">
            <CompleteBy>19/02/2026 12:56:00</CompleteBy>
            <ResponseDays>28</ResponseDays>
            <Priority>R</Priority>
            <PriorityId>2105</PriorityId>
            <RepairCode>BUI116</RepairCode>
            <RepairCodeEx>BUI116</RepairCodeEx>
            <RepairCodeDesc><![CDATA[WINDOW: OVERHAUL]]></RepairCodeDesc>
            <UnitOfMeasure>NO</UnitOfMeasure>
            <UnitOfMeasureQuantity>1</UnitOfMeasureQuantity>
            <Contractor />
            <IsDeleted>False</IsDeleted>
            <IsDirty>False</IsDirty>
            <IsNew>True</IsNew>
        </Repair>
        <Uploads>
            <File><![CDATA[https://keynect.biz/VideoCall/list-resources-for-all-calls?VCSId=666&amp;ResourceName=2026-01-22-125741_188.png]]></File>
            <File><![CDATA[https://keynect.biz/VideoCall/list-resources-for-all-calls?VCSId=666&amp;ResourceName=Video-00001]]></File>
        </Uploads>
    </Fault>
    <GUID>d18b8c3e-7ddc-48a3-bd6e-0da344565451</GUID>
    <Status>1</Status>
</KeyfaxData>
```

**JSON Example**

```json
{
    "KeyfaxData": {
        "Fault": [
            {
                "@name": "Fault1",
                "@type": "RD",
                "IsDeleted": "False",
                "IsDirty": "False",
                "IsNew": "True",
                "Fault_Dialog": "11542",
                "Fault_Category": "10794",
                "CompanyCode": null,
                "ScriptSet": "1",
                "FaultText": {
                    "#cdata-section": "Windows: Frame; damaged or rotten; loft; top hung; wood; fair wear and tear"
                },
                "LogDate": "22/01/2026 12:56:00",
                "Communal_Type": null,
                "Reason_Code": null,
                "Reason_Text": null,
                "Recharge": "0",
                "Recharge_Code": "RREP",
                "Recharge_Cost": "40.50",
                "Repair_No": null,
                "Repair_Status": "2",
                "RTR": null,
                "RTR_Date": null,
                "Insurance": null,
                "Schedule_ID": "operator\\157",
                "Site_Visit": {
                    "#cdata-section": ""
                },
                "Additional_Info": {
                    "#cdata-section": "Window frame is peeling slightly\r\n\r\n"
                },
                "Special_Instructions": {
                    "#cdata-section": ""
                },
                "Tenancy_Type": null,
                "ClientID": null,
                "TenantID": "9f9e014c-8582-ec11-8d21-0022481b4e5a",
                "TenantText": {
                    "#cdata-section": "Paul Ancill, 14 Heather View Road, Poole, BH12 4AQ"
                },
                "UserCode": "operator",
                "ScriptPath": {
                    "Question": [
                        "Q1 = What is the problem with the window frame?: A1 = window frame - damaged or rotten",
                        "Q2 = Which door or window is it?: A2 = loft",
                        "Q3 = What type of window is it?: A3 = top hung",
                        "Q4 = What type of frame is it?: A4 = wood",
                        "Q5 = Is temporary boarding required?: A5 = No",
                        "Q6 = How did it happen?: A6 = fair wear and tear"
                    ]
                },
                "Contractor_Code": null,
                "Contractor_Email": null,
                "Expenditure_Code": null,
                "Nominal_Code": null,
                "Summary": null,
                "Job_Code": null,
                "Location": null,
                "HDIH": null,
                "RepairCount": "1",
                "AdviceCount": "0",
                "CustomCount": "0",
                "ActionCount": "0",
                "SubActionCount": "0",
                "UpdateCount": "0",
                "Repair": [
                    {
                        "@name": "Repair1",
                        "CompleteBy": "19/02/2026 12:56:00",
                        "ResponseDays": "28",
                        "Priority": "R",
                        "PriorityId": "2105",
                        "RepairCode": "BUI116",
                        "RepairCodeEx": "BUI116",
                        "RepairCodeDesc": {
                            "#cdata-section": "WINDOW: OVERHAUL"
                        },
                        "UnitOfMeasure": "NO",
                        "UnitOfMeasureQuantity": "1",
                        "Contractor": null,
                        "IsDeleted": "False",
                        "IsDirty": "False",
                        "IsNew": "True"
                    }
                ],
                "Uploads": {
                    "File": [
                        {
                            "#cdata-section": "https://keynect.biz/VideoCall/list-resources-for-all-calls?VCSId=666&ResourceName=2026-01-22-125741_188.png"
                        },
                        {
                            "#cdata-section": "https://keynect.biz/VideoCall/list-resources-for-all-calls?VCSId=666&ResourceName=Video-00001"
                        }
                    ]
                }
            }
        ],
        "GUID": "d18b8c3e-7ddc-48a3-bd6e-0da344565451",
        "Status": "1"
    }
}
```

#### General Enquiries

The below examples show an enquiry returned from Keyfax via the [SOAP API](/integrations/apis/soap.md) and [REST API](/integrations/apis/rest-api.md) with KeyNect URLs returned within the `Uploads` element / property.

**XML Example**

```xml
<KeyfaxData xmlns:json="http://james.newtonking.com/projects/json">
    <Enquiry name="Enquiry1" type="FL" json:Array="true">
      <IsDeleted>False</IsDeleted>
      <IsDirty>False</IsDirty>
      <IsNew>True</IsNew>
      <EnquiryDialog>41106</EnquiryDialog>
      <EnquiryText><![CDATA[Estate management: Grass cutting/hedge trimming; hedge trimming; sightline obstruction; rear of garden; overgrown hedging]]></EnquiryText>
      <LogDate>22/01/2026 13:58:15</LogDate>
      <EnquiryCatRef>41105</EnquiryCatRef>
      <ScriptSet>1</ScriptSet>
      <ClientID />
      <TenantID />
      <TenantText><![CDATA[Paul Ancill, 14 Heather View Road, Poole, BH12 4AQ]]></TenantText>
      <UserCode>operator</UserCode>
      <FirstTimeResolution />
      <ScriptPath>
        <Question no="1">
          <Request>What is this regarding?</Request>
          <Response>hedge trimming</Response>
        </Question>
        <Question no="2">
          <Request>What is the problem?</Request>
          <Response>sightline obstruction</Response>
        </Question>
        <Question no="3">
          <Request>Where is the problem?</Request>
          <Response>rear of garden</Response>
        </Question>
        <Question no="4">
          <Request>Describe the problem</Request>
          <Response>overgrown hedging</Response>
        </Question>
      </ScriptPath>
      <ActionCount>1</ActionCount>
      <SubActionCount>0</SubActionCount>
      <AdviceCount>1</AdviceCount>
      <CustomCount>0</CustomCount>
      <Summary />
      <Action name="Action1" type="KF_FL_TASK" json:Array="true">
        <ActionCode>REF024</ActionCode>
        <ActionCodeEx>REF024</ActionCodeEx>
        <ActionCodeDesc>Email Maintenance - Estate Management</ActionCodeDesc>
        <HasSubActions>False</HasSubActions>
        <Priority>3</Priority>
        <PriorityID>5187</PriorityID>
        <IsDeleted>False</IsDeleted>
        <IsDirty>False</IsDirty>
        <IsNew>True</IsNew>
        <TaskTemplate ID="REF024" AutoClose="False">
          <Name>Email Maintenance - Estate Management</Name>
          <Notifications />
          <Reassignments />
        </TaskTemplate>
      </Action>
      <Advice name="Advice1" json:Array="true">
        <AdviceCode>ADV101</AdviceCode>
        <AdviceCodeEx>ADV101</AdviceCodeEx>
        <AdviceCodeDesc><![CDATA[Grass, Hedges and Weeds]]></AdviceCodeDesc>
        <AdvicePlainText><![CDATA[MSG: Grass cutting Most general open space is cut eight times a year from early April to the end of October. Rough grass areas such as the verges on ring roads, are cut six times a year. 

This is dependent on the weather and ground conditions, some cutting may not run to schedule. For example, during hot and dry summers the grass grows ,ore slowly and requires fewer cuts. 

For health and safety reasons, grass cutting to banks may not be carried out if the ground is wet. Areas that have been cut during wet weather may appear to be churned up afterwards, the grass will normally recover within 48 hours. 

We do not cut grass that is:  privately owned on properties/estates not owned by the council outside of our boundary
Most grass in residential areas and adjacent to the highway is cut by a ride-on mower. Some areas of grass are cut by pedestrian hand mower and these will sometimes be cut separately. Hedges Are generally cut back once a year during the winter months. At all other times of the year a response team is available to deal with overgrown footpaths and sight line problems. 

Hedge cutting doesn&amp;#39;t take place from the end of March until autumn due to nesting birds, unless there are health and safety reasons such as:  Impeded sight lines Public right of way Risk of harm to pedestrians or motorists
A risk assessment will take place where hedges need to be cut back in these instances to make sure that wildlife is not adversely affected. Weed control We use non-residual herbicide and mulching techniques to control weeds in soft landscape areas. We arrange the chemical control of weeds to highway surfaces with two applications applied per year. The chemical used is Roundup Pro, the active ingredient of which is Glyphosate. This is a non-toxic product that does not harm pets or wildlife. 

All our operatives and contractors are qualified to National Proficiency Testing standards.
]]></AdvicePlainText>
        <IsDeleted>False</IsDeleted>
        <IsDirty>False</IsDirty>
        <IsNew>True</IsNew>
      </Advice>
      <Uploads>
        <File><![CDATA[https://dev.keynect.biz/VideoCall/list-resources-for-all-calls?VCSId=668&amp;ResourceName=2026-01-22-135949_333.png]]></File>
        <File><![CDATA[https://dev.keynect.biz/VideoCall/list-resources-for-all-calls?VCSId=668&amp;ResourceName=Video-00001]]></File>
      </Uploads>
    </Enquiry>
    <GUID>07c0bb27-a388-4036-84b7-358eb7a6a46e</GUID>
    <Status>1</Status>
  </KeyfaxData>
```

**JSON Example**

```json
{
    "KeyfaxData": {
        "Enquiry": [
            {
                "@name": "Enquiry1",
                "@type": "FL",
                "IsDeleted": "False",
                "IsDirty": "False",
                "IsNew": "True",
                "EnquiryDialog": "41106",
                "EnquiryText": {
                    "#cdata-section": "Estate management: Grass cutting/hedge trimming; hedge trimming; sightline obstruction; rear of garden; overgrown hedging"
                },
                "LogDate": "22/01/2026 13:58:15",
                "EnquiryCatRef": "41105",
                "ScriptSet": "1",
                "ClientID": null,
                "TenantID": null,
                "TenantText": {
                    "#cdata-section": "Paul Ancill, 14 Heather View Road, Poole, BH12 4AQ"
                },
                "UserCode": "operator",
                "FirstTimeResolution": null,
                "ScriptPath": {
                    "Question": [
                        {
                            "@no": "1",
                            "Request": "What is this regarding?",
                            "Response": "hedge trimming"
                        },
                        {
                            "@no": "2",
                            "Request": "What is the problem?",
                            "Response": "sightline obstruction"
                        },
                        {
                            "@no": "3",
                            "Request": "Where is the problem?",
                            "Response": "rear of garden"
                        },
                        {
                            "@no": "4",
                            "Request": "Describe the problem",
                            "Response": "overgrown hedging"
                        }
                    ]
                },
                "ActionCount": "1",
                "SubActionCount": "0",
                "AdviceCount": "1",
                "CustomCount": "0",
                "Summary": null,
                "Action": [
                    {
                        "@name": "Action1",
                        "@type": "KF_FL_TASK",
                        "ActionCode": "REF024",
                        "ActionCodeEx": "REF024",
                        "ActionCodeDesc": "Email Maintenance - Estate Management",
                        "HasSubActions": "False",
                        "Priority": "3",
                        "PriorityID": "5187",
                        "IsDeleted": "False",
                        "IsDirty": "False",
                        "IsNew": "True",
                        "TaskTemplate": {
                            "@ID": "REF024",
                            "@AutoClose": "False",
                            "Name": "Email Maintenance - Estate Management",
                            "Notifications": null,
                            "Reassignments": null
                        }
                    }
                ],
                "Advice": [
                    {
                        "@name": "Advice1",
                        "AdviceCode": "ADV101",
                        "AdviceCodeEx": "ADV101",
                        "AdviceCodeDesc": {
                            "#cdata-section": "Grass, Hedges and Weeds"
                        },
                        "AdvicePlainText": {
                            "#cdata-section": "MSG: Grass cutting Most general open space is cut eight times a year from early April to the end of October. Rough grass areas such as the verges on ring roads, are cut six times a year. \r\n \r\nThis is dependent on the weather and ground conditions, some cutting may not run to schedule. For example, during hot and dry summers the grass grows ,ore slowly and requires fewer cuts. \r\n \r\nFor health and safety reasons, grass cutting to banks may not be carried out if the ground is wet. Areas that have been cut during wet weather may appear to be churned up afterwards, the grass will normally recover within 48 hours. \r\n \r\nWe do not cut grass that is:  privately owned on properties/estates not owned by the council outside of our boundary\r\n Most grass in residential areas and adjacent to the highway is cut by a ride-on mower. Some areas of grass are cut by pedestrian hand mower and these will sometimes be cut separately. Hedges Are generally cut back once a year during the winter months. At all other times of the year a response team is available to deal with overgrown footpaths and sight line problems. \r\n \r\nHedge cutting doesn&#39;t take place from the end of March until autumn due to nesting birds, unless there are health and safety reasons such as:  Impeded sight lines Public right of way Risk of harm to pedestrians or motorists\r\n A risk assessment will take place where hedges need to be cut back in these instances to make sure that wildlife is not adversely affected. Weed control We use non-residual herbicide and mulching techniques to control weeds in soft landscape areas. We arrange the chemical control of weeds to highway surfaces with two applications applied per year. The chemical used is Roundup Pro, the active ingredient of which is Glyphosate. This is a non-toxic product that does not harm pets or wildlife. \r\n \r\nAll our operatives and contractors are qualified to National Proficiency Testing standards.\r\n"
                        },
                        "IsDeleted": "False",
                        "IsDirty": "False",
                        "IsNew": "True"
                    }
                ],
                "Uploads": {
                    "File": [
                        {
                            "#cdata-section": "https://dev.keynect.biz/VideoCall/list-resources-for-all-calls?VCSId=668&ResourceName=2026-01-22-135949_333.png"
                        },
                        {
                            "#cdata-section": "https://dev.keynect.biz/VideoCall/list-resources-for-all-calls?VCSId=668&ResourceName=Video-00001"
                        }
                    ]
                }
            }
        ],
        "GUID": "07c0bb27-a388-4036-84b7-358eb7a6a46e",
        "Status": "1"
    }
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.keyfax.biz/integrations/host-systems/keynect.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.