tmGroup Technology's REST API Collection provides you with a powerful, convenient, and simple suite of APIs.
\nThis documentation is for tmConnect. This documentation covers the the following functionality provided by the APIs:
\nAdditional API Documentation for other areas can be found with the links below:
\n\nBy using the \"Run in Postman\" button located at the top right of this page it provides you with a quick and easy way to start using our APIs and testing your credentials.
\nOnce our collection is loaded into your local version simply update the body on the Authentication \"Generate Access Token\" with your details as found in the API Portal (to register for the portal please email us as above).
Our Postman collection is currently configured to point at our \"Demo\" environment. If you need to change this please edit the local collection variables and amend the variable \"BaseEnvironmentURL\" to the domain prefix provided.
Once this is done you will be ready to start using the APIs.
\nWe will always maintain the latest TWO versions of each endpoint. The version forms part of the URL.
\nAn example of how this works can be seen within our \"HelloWorld\" service.
\nOpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs and all out APIs are documented using this approach.
\nSwagger URLs:
\nWe use conventional HTTP response codes to indicate the success or failure of an API request.
\nOur Live Environment URLs is https://identity.tmgroup.technology/connect/token
\n","urlObject":{"protocol":"https","path":["connect","token"],"host":["demo20identity","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"c9bb2db2-5a43-4f2e-9b0c-712341f55590","name":"Generate Access Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"clientId","type":"text"},{"key":"client_secret","value":"secret","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://demo20identity.tmgroup.technology/connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 22 Jan 2020 15:54:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjZCN0FDQzUyMDMwNUJGREI0RjcyNTJEQUVCMjE3N0NDMDkxRkFBRTEiLCJ0eXAiOiJhdCtqd3QiLCJ4NXQiOiJhM3JNVWdNRnY5dFBjbExhNnlGM3pBa2ZxdUUifQ.eyJuYmYiOjE1Nzk3MDg0OTAsImV4cCI6MTU3OTcxMjA5MCwiaXNzIjoiaHR0cHM6Ly9kZXYyMC50bWdyb3VwLnRlY2hub2xvZ3kvaWRlbnRpdHkiLCJhdWQiOiJIZWxsb1dvcmxkQXBpIiwiY2xpZW50X2lkIjoiVGVjaFRyYWNrMSIsInNjb3BlIjpbIkhlbGxvV29ybGRBcGkiXX0.Bi0Nz7ySBnT1DW8zlv9vuikKDkhQzzcw03JSXa2H4iXkB1ATaRaI3Eaevp8N6oUJPqzkg5p4yowdiVHcGlPuZGBrNb_GFpK4VYSnLDvC7oSRrhGUFOrwdH7yxkJeRZYM1s7fMLoerh2c9WpPKdwsSBYoAm_7WBV2tDlHf_Rg_lQDwg27kL7cNUqlzotU8PnhnVb_F2DuFET69m1-WcXXvW7KWeIdgxI5URYVIYoDZYHzxImpMotjLKewvubUkeF7rlYJAsaA_-jL7NCwGiuLAJB5ipJoQJAt2GG-lYCmW1UDgu4VednGpbh3u0p2mAzxgIakol4YixvLFcJxCe-llA\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\",\n \"scope\": \"HelloWorldApi\"\n}"}],"_postman_id":"72f8d487-bc92-478a-945b-97cf0595c61d"}],"id":"e325bd20-1953-4ed0-82af-30622ff6b8c2","description":"All our secure APIs are secured using OpenID Connect which is a simple identity layer on top of the OAuth 2.0 protocol.
\nTo use our secure APIs you will need to obtain a token from our identity server using the your company client ID and client secret. Your client secret will be supplier at the point of registration and will have an expiry date of 1 year.
\n\n\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2c71334b-d49c-48c6-bdfb-73c0f2740eef"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ff881ae5-f55a-4795-a8c9-0634b1a9e8f4"}}],"_postman_id":"e325bd20-1953-4ed0-82af-30622ff6b8c2"},{"name":"HelloWorld","item":[{"name":"HelloWorld v1","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"ce5a2f42-4702-4baf-b49b-88ee9aa4d28d"}}],"id":"1fd9f7d4-e448-448c-94f8-16f07aae5d20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/HelloWorld/v1/HelloWorld","urlObject":{"protocol":"https","path":["HelloWorld","v1","HelloWorld"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"025d55ef-2305-4ea9-becd-2021f3dd26aa","name":"HelloWorld","originalRequest":{"method":"GET","header":[],"url":"https://{{environmentURL}}.tmgroup.technology/HelloWorld/v2/HelloWorld"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"2.0"},{"key":"api-deprecated-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 22 Jan 2020 15:55:20 GMT"}],"cookie":[],"responseTime":null,"body":"Hello World 'v1'!"}],"_postman_id":"1fd9f7d4-e448-448c-94f8-16f07aae5d20"},{"name":"HelloWorld v2","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"4cb871d2-91a2-4934-984e-350bcb22026b"}}],"id":"dc1bdfb7-68cd-47da-93be-be7674e16ab7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/HelloWorld/v2/HelloWorld","urlObject":{"protocol":"https","path":["HelloWorld","v2","HelloWorld"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"0cc40f02-fdab-48bc-b0f3-2a89144815f1","name":"HelloWorld","originalRequest":{"method":"GET","header":[],"url":"https://{{environmentURL}}.tmgroup.technology/HelloWorld/v2/HelloWorld"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"2.0"},{"key":"api-deprecated-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 22 Jan 2020 15:55:20 GMT"}],"cookie":[],"responseTime":null,"body":"Hello World 'v2'!"}],"_postman_id":"dc1bdfb7-68cd-47da-93be-be7674e16ab7"},{"name":"HelloWorld - Authenticated","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"704eee80-9eec-4cb3-b764-2495712c174a"}}],"id":"e897004e-475b-4b95-a330-d8f5fedce8de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Generated_Token","type":"text"}],"url":"https://demo20.tmgroup.technology/HelloWorld/v2/HelloWorldAuthenticated","description":"Ensure that you make a note of your secret as we are not able to provide this to you again after generation. If you lose it you will need to generate a new secret.\nWe provide the ability to run with two overlapping secrets at any one time.
\n
HelloWorld example to test your authentication token is working.
\n","urlObject":{"protocol":"https","path":["HelloWorld","v2","HelloWorldAuthenticated"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"4396d8c6-ee39-4036-86e6-e82a6b112d91","name":"HelloWorld - Authenticated","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Generated_Token","type":"text"}],"url":"https://{{environmentURL}}.tmgroup.technology/HelloWorld/v1/HelloWorldAuthenticated"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"2.0"},{"key":"api-deprecated-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 22 Jan 2020 15:55:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Hello World 'v1'!\",\n \"logId\": 64,\n \"customerId\": 261291,\n \"randomTaskDurationMs\": 907\n}"}],"_postman_id":"e897004e-475b-4b95-a330-d8f5fedce8de"}],"id":"3036f8ad-5647-40fd-bcd1-2c0ec1fce90d","description":"Swagger URL
\nExample API to test your connection and authentication.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"95928a19-9942-4f5e-aaa5-b11a6432d292"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f880db15-5f78-4435-99c9-518ba6c897ad"}}],"_postman_id":"3036f8ad-5647-40fd-bcd1-2c0ec1fce90d"},{"name":"Instructions","item":[{"name":"Create Instruction","id":"0783fc61-f344-48f9-bb30-e0d0e79ba6ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"panelName\": \"sample\",\r\n \"customerReference\": \"56778P\",\r\n \"parties\": {\r\n \"conveyancer\": \"436803\"\r\n },\r\n \"originator\": {\r\n \"branchName\": \"Norton\",\r\n \"sourceName\": \"Browns Estate Agency\",\r\n \"contactDetails\": {\r\n \"contactId\": \"87893\",\r\n \"firstName\": \"Ben\",\r\n \"lastName\": \"Ridgeway\", \r\n \"emailAddress\": \"test@test.co.uk\",\r\n \"phoneNumber\": \"0777777777\",\r\n \"title\": \"Mr\"\r\n },\r\n \"companyName\": \"The Conveyancing Partnership\"\r\n }, \r\n \"propertyDetails\": {\r\n \"pafAddress\": {\r\n \"buildingNumber\": \"1200\",\r\n \"postcode\": \"SN5 7XZ\"\r\n },\r\n \"evidenceOfTitle\": {\r\n \"tenureType\": \"Freehold\",\r\n \"titleNumber\": \"abc12345\"\r\n },\r\n \"propertyType\": \"House\",\r\n \"propertyStyle\": \"Detached\",\r\n \"validateAddress\":false\r\n },\r\n \"propertyValue\": 375000, \r\n \"sectorType\": \"Residential\",\r\n \"projectType\": \"Purchase\",\r\n \"clients\": [\r\n {\r\n \"lead\": true,\r\n \"title\": \"Master\",\r\n \"firstname\": \"Mark\",\r\n \"middlename\": \"string\",\r\n \"lastname\": \"Sehpherd\",\r\n \"homePhone\": \"string\",\r\n \"mobilePhone\": \"string\",\r\n \"businessPhone\": \"string\",\r\n \"otherPhone\": \"string\",\r\n \"emailAddress\": \"string@string.co.uk\",\r\n \"correspondenceAddress\": {\r\n \"Address\": {\r\n \"buildingNumber\": \"210000\",\r\n\t\t \"postcode\": \"DH6 4LN\"\r\n }\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/PanelServices/v1/Instructions","description":"To pass the address tm strongly suggests using UPRN (unique property reference number) such as 010004841678, as it significantly lowers any possibility of address location confusion.
\n \"propertyDetails\": {\n \"uprn\": \"010093397400\"\n }\n\ntm provides the functionality such that you may pass in an address manually. Tm will automatically use our existing datasets and machine learning algorithms to try to validate your address providing improved search results.
\nExample manual address entry:
\n \"projectType\": \"Remortgage\",\n \"sectorType\": \"Residential\",\n \"propertyDetails\": {\n \"address\": {\n \"buildingNumber\": \"29\",\n \"postCode\": \"EH10 6QL\"\n }\n }\n\nThe client is any individual associated with the instruction, typically this is anyone within the household 18 or over, however, this is ulitmately your decision. There must be a lead client with an address, if not we will take the alphabetically first client with an address The client must have an email address if you wish for them to have web access There must be at least one phone number per client.
\n \"clients\": [\n {\n \"title\": \"Master\",\n \"firstname\": \"Mark\",\n \"lastname\": \"Shepherd\",\n \"mobilePhone\": \"07403445657\",\n \"emailAddress\": \"string@string.co.uk\",\n \"correspondenceAddress\": {\n \"address\": {\n \"buildingNumber\": \"29\",\n \"postCode\": \"EH10 6QL\"\n }\n }\n }\n\nThese are additional fields which alter the behaviour of the instructions lifecycle, if you have been configured to use them. Such as OptOutOfOnlineDocuments, if you have setup a postal agreement with tm then this flag will post documents to customers. These items are updated very regularly so make sure to check frequently if there are items you would like to be set up with.
\n \"additionalItems\":\n {\n \"hasMortgage\": null,\n \"optOutOfOnlineDocuments\": null,\n \"mortgageBusinessUnitCase\": null,\n \"freeEPC\": null,\n \"buyToLet\" : null,\n \"guarantor\" : null,\n \"etridgeRequirement\" : null,\n \"debtConsolidating\" : null,\n \"elevatedCase\" : null,\n \"complaint\" : null,\n }\n\n {\n \"panelName\": \"demo\",\n \"customerReference\": \"reference\",\n \"parties\": {\n \"conveyancer\": \"uniqueRef123\"\n },\n \"propertyDetails\": {\n \"uprn\": \"010093397400\"\n },\n \"sectorType\": \"Residential\",\n \"projectType\": \"Purchase\",\n \"propertyValue\": 375000, \n \"clients\": [\n {\n \"title\": \"Master\",\n \"firstname\": \"Damien \",\n \"lastname\": \"Hirst\",\n \"mobilePhone\": \"0777777777\",\n \"emailAddress\": \"string@string.co.uk\",\n \"correspondenceAddress\": {\n \"address\": {\n \"buildingNumber\": \"1200\",\n \"postcode\": \"SN5 7XZ\"\n }\n }\n }\n ]\n }\n\nReturns a full list of all instructions for the given customer.
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","Instructions"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"4749f01b-1f29-494e-bb7e-0ad4d5b28f37","name":"Get Instructions","originalRequest":{"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/Instructions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 14 Jul 2023 12:31:54 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"instructions\": [\n {\n \"instructionId\": 1544830,\n \"instructionStatusName\": \"Allocated\",\n \"customerReference\": \"28767494\",\n \"dateCreated\": \"2023-06-22T16:51:14\",\n \"personFullNameList\": \"F21724751 S21724751\",\n \"projectPrimaryAddressString\": \"\",\n \"sectorType\": \"Residential\",\n \"projectType\": \"Sale\",\n \"panelShortName\": \"\"\n },\n {\n \"instructionId\": 1544829,\n \"instructionStatusName\": \"Allocated\",\n \"customerReference\": \"28767490\",\n \"dateCreated\": \"2023-06-22T16:51:07\",\n \"personFullNameList\": \"F21724749 S21724749\",\n \"projectPrimaryAddressString\": \"\",\n \"sectorType\": \"Residential\",\n \"projectType\": \"Purchase\",\n \"panelShortName\": \"\"\n }\n ]\n}"}],"_postman_id":"37dab96e-43f4-4c9a-9766-c83a11ad612d"},{"name":"Get Instruction","event":[{"listen":"test","script":{"id":"97198320-6bf7-463e-a868-d5f3483a5e1e","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;\r","if (responseCode.code !== 200) return;\r","// continue with other tests\r","\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"e9e62b86-8b79-4c3b-b4ee-54eff45b54fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/Instructions/","description":"Returns the full detail of a given instruction
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","Instructions",""],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"42e73456-46f5-420e-a8eb-8c2541842a68","name":"Get Instruction","originalRequest":{"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/Instructions/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 14 Jul 2023 12:31:54 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e9e62b86-8b79-4c3b-b4ee-54eff45b54fe"},{"name":"Get Instruction Filter by Customer Reference Copy","id":"26586d30-4f44-4441-8011-b2f7b9c3b460","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/Instructions?customerReference={{customerReference}}","description":"If you know the customer reference you can filter the list of instructions by passing in the \"CustomerReference\" as a filter.
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","Instructions"],"host":["demo20","tmgroup","technology"],"query":[{"key":"customerReference","value":"{{customerReference}}"}],"variable":[]}},"response":[{"id":"bb791ecc-c91a-4aac-aaf4-aea3637eb941","name":"Get Instruction Filtered","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://demo20.tmgroup.technology/PanelServices/v1/Instructions?customerReference=28767494","protocol":"https","host":["demo20","tmgroup","technology"],"path":["PanelServices","v1","Instructions"],"query":[{"key":"customerReference","value":"28767494"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 14 Jul 2023 12:30:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"instructions\": [\n {\n \"instructionId\": 1544830,\n \"instructionStatusName\": \"Allocated\",\n \"customerReference\": \"28767494\",\n \"dateCreated\": \"2023-06-22T16:51:14\",\n \"personFullNameList\": \"F21724751 S21724751\",\n \"projectPrimaryAddressString\": \"\",\n \"sectorType\": \"Residential\",\n \"projectType\": \"Sale\",\n \"panelShortName\": \"\"\n }\n ]\n}"}],"_postman_id":"26586d30-4f44-4441-8011-b2f7b9c3b460"},{"name":"Get Memorandum of Sale","event":[{"listen":"test","script":{"id":"97198320-6bf7-463e-a868-d5f3483a5e1e","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;\r","if (responseCode.code !== 200) return;\r","// continue with other tests\r","\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"33471804-8ffe-49d3-ab10-0deafe349442","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/Instructions/{instructionId}/mos","description":"Returns the data provided as part of the latest Memorandum of Sale
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","Instructions","{instructionId}","mos"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"f846cdaf-e2a1-415e-aeda-b19ee117fc62","name":"Get Memorandum of Sale","originalRequest":{"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/Instructions/{instructionId}/mos"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 16 Sep 2025 14:22:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"memorandumOfSale\": {\n \"date\": \"2025-09-01T00:00:00\",\n \"tmInstructionId\": 1000000,\n \"introducerReference\": \"int-ref-452\",\n \"conveyancerReference\": \"conv-ref-782\",\n \"originator\": {\n \"name\": \"Prime Home Conveyancing\",\n \"source\": \"Best Estates\",\n \"branch\": \"Best Estates - Cambridge\",\n \"contact\": [\n {\n \"name\": \"Sarah Thompson\",\n \"communications\": [\n {\n \"mode\": \"OtherPhone\",\n \"value\": \"020 7946 1234\"\n }\n ]\n }\n ]\n },\n \"subjectProperty\": {\n \"address\": {\n \"organisation\": \"\",\n \"department\": \"\",\n \"address1\": \"\",\n \"address2\": \"12\",\n \"street\": \"Maple Avenue\",\n \"locality\": \"Chesterton\",\n \"town\": \"Cambridge\",\n \"postTown\": \"Cambridge\",\n \"administrationArea\": \"Cambridgeshire\",\n \"postCode\": \"CB4 1XY\",\n \"uprn\": \"100023456789\"\n },\n \"agreedPrice\": \"325000\"\n },\n \"vendorDetails\": {\n \"conveyancerParty\": {\n \"name\": \"Green & Co Solicitors\",\n \"address\": {\n \"paf\": {\n \"thoroughfareName\": \"Station Road\",\n \"dependentLocality\": \"Central\",\n \"postTown\": \"Cambridge\",\n \"postCode\": \"CB1 2AB\"\n }\n },\n \"contact\": [\n {\n \"name\": \"Helen Carter\",\n \"communications\": [\n {\n \"mode\": \"OtherPhone\",\n \"value\": \"01223 555678\"\n },\n {\n \"mode\": \"Email\",\n \"value\": \"helen.carter@greenandco.co.uk\"\n }\n ]\n }\n ]\n },\n \"legalOwners\": [\n {\n \"name\": \"Mr James Miller\",\n \"address\": {\n \"paf\": {\n \"buildingNumber\": \"12\",\n \"thoroughfareName\": \"Maple Avenue\",\n \"dependentLocality\": \"Chesterton\",\n \"postTown\": \"Cambridge\",\n \"county\": \"Cambridgeshire\",\n \"postCode\": \"CB4 1XY\"\n }\n },\n \"communications\": [\n {\n \"mode\": \"MobilePhone\",\n \"value\": \"07700 900123\"\n }\n ]\n },\n {\n \"name\": \"Mrs Emily Miller\",\n \"address\": {\n \"paf\": {\n \"buildingNumber\": \"12\",\n \"thoroughfareName\": \"Maple Avenue\",\n \"dependentLocality\": \"Chesterton\",\n \"postTown\": \"Cambridge\",\n \"county\": \"Cambridgeshire\",\n \"postCode\": \"CB4 1XY\"\n }\n },\n \"communications\": [\n {\n \"mode\": \"MobilePhone\",\n \"value\": \"07700 900124\"\n },\n {\n \"mode\": \"Email\",\n \"value\": \"emily.miller@email.com\"\n }\n ]\n }\n ]\n },\n \"purchaserDetails\": {\n \"conveyancerParty\": {\n \"name\": \"Smith & Partners LLP\",\n \"address\": {\n \"paf\": {\n \"thoroughfareName\": \"King Street\",\n \"dependentLocality\": \"West End\",\n \"postTown\": \"Cambridge\",\n \"postCode\": \"CB2 3QF\"\n }\n },\n \"contact\": [\n {\n \"name\": \"David Lee\",\n \"communications\": [\n {\n \"mode\": \"OtherPhone\",\n \"value\": \"01223 888999\"\n },\n {\n \"mode\": \"DX\",\n \"value\": \"DX 123456 Cambridge 10\"\n },\n {\n \"mode\": \"Email\",\n \"value\": \"david.lee@smithpartners.com\"\n }\n ]\n }\n ]\n },\n \"purchasers\": [\n {\n \"name\": \"Ms Olivia Harris\",\n \"address\": {\n \"paf\": {\n \"buildingNumber\": \"47\",\n \"thoroughfareName\": \"Willow Road\",\n \"postTown\": \"Cambridge\",\n \"county\": \"Cambridgeshire\",\n \"postCode\": \"CB3 0FA\"\n }\n },\n \"communications\": [\n {\n \"mode\": \"MobilePhone\",\n \"value\": \"07700 900125\"\n },\n {\n \"mode\": \"Email\",\n \"value\": \"olivia.harris@email.com\"\n }\n ]\n },\n {\n \"name\": \"Mr Daniel Evans\",\n \"address\": {\n \"paf\": {\n \"buildingNumber\": \"28\",\n \"thoroughfareName\": \"Birch Lane\",\n \"postTown\": \"Cambridge\",\n \"county\": \"Cambridgeshire\",\n \"postCode\": \"CB2 1GH\"\n }\n },\n \"communications\": [\n {\n \"mode\": \"MobilePhone\",\n \"value\": \"07700 900126\"\n },\n {\n \"mode\": \"Email\",\n \"value\": \"daniel.evans@email.com\"\n }\n ]\n }\n ]\n },\n \"conditions\": [\n {\n \"type\": \"OfferAdditionalConditions\",\n \"value\": \"None Applicable.\"\n }\n ]\n }\n}\n"}],"_postman_id":"33471804-8ffe-49d3-ab10-0deafe349442"}],"id":"6db5e23e-1c4f-43b9-ad83-ef1361ece3c6","description":"An instruction is a collection of projects shared between several parties, duplicated to allow each party to have their own view. On creation all parties projects are created with the same information, except different customers. There are currently 2 parties allowed via API conveyancer and introducer, typically the introducer will be yourself acting as the instructor. The conveyancer will have the unique reference which you will have agreed with tm, however, if you are configured for auto allocation or plan on allocating manually via website then you leave this field out
\nYou should never see the project as a panel/tmconnect user, however, you should be aware of it's existence
\nSome data such as client information, sector and transaction are synced. However other items such as documents and messages have to be explicitly shared with other parties.
\nAn instruction will belong to a Panel, who's name you should have been provided,
\n \"panelName\": \"demo\",\n \"customerReference\": \"customerRef\",\n \"parties\": {\n \"conveyancer\": \"uniqueRef123\"\n },\n \"sectorType\": \"Residential\",\n \"projectType\": \"Purchase\",\n \"propertyValue\": 375000\n\nProviding address data for project creation:
\nA project is how tm associates metadata required to place an order, e.g sector (Commercial/Residential), transaction (Sale/Purchase/Remortgage) and address.
\nTo pass the address tm strongly suggests using UPRN (unique property reference number) such as 010004841678, as it significantly lowers any possibility of address location confusion.
\n\"propertyDetails\": {\n \"uprn\":\"010093397400\"\n }\n\ntm provides the functionality such that you may pass in an address manually. Tm will automatically use our existing datasets and machine learning algorithms to try to validate your address providing improved search results.
\nExample manual address entry:
\n \"projectType\": \"Remortgage\",\n \"sectorType\": \"Residential\",\n \"propertyDetails\": \n {\n \"address\": {\n \"buildingNumber\": \"29\",\n \"postCode\": \"EH10 6QL\"\n }\n }\n\nThe client is any individual associated with the instruction, typically this is anyone within the household 18 or over, however, this is ulitmately your decision. There must be a lead client with an address, if not we will take the alphabetically first client with an address The client must have an email address if you wish for them to have web access There must be at least one phone number per client
\n \"clients\": [\n {\n \"title\": \"Master\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"mobilePhone\": \"077766554433\",\n \"emailAddress\": \"string@string.co.uk\",\n \"correspondenceAddress\": {\n {\n \"address\": {\n \"buildingNumber\": \"29\",\n \"postCode\": \"EH10 6QL\"\n }\n }\n }\n\nThese are additional fields which alter the behaviour of the instructions lifecycle, if you have been configured to use them. Such as OptOutOfOnlineDocuments, if you have setup a postal agreement with tm then this flag will post documents to customers. These items are updated very regularly so make sure to check frequently if there are items you would like to be set up with.
\n \"AdditionalItems\":\n {\n \"HasMortgage\": null,\n \"OptOutOfOnlineDocuments\": null,\n \"MortgageBusinessUnitCase\": null,\n \"FreeEPC\": null\n } \n\nThis endpoint requires an access token.
\nIf a conversationId is supplied then it will send the message as a reply in that conversation, if a conversationId of 0 is given or is left out then a new conversation will be created.
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","instructions","{instructionId}","Messages"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"c1329e5c-d376-418c-86f7-c287d4b0884c","name":"Post Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"conversationId\": 0,\r\n \"subject\": \"string\",\r\n \"body\": \"string\",\r\n \"recipients\": [\r\n {\r\n \"identifier\": 0,\r\n \"messageParty\": \"Customer\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions/{instructionId}/Messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"messageId\": 0,\r\n \"conversationId\": 0,\r\n \"subject\": \"string\",\r\n \"body\": \"string\",\r\n \"sent\": \"2021-02-05T12:21:19.576Z\",\r\n \"recipients\": [\r\n {\r\n \"identifier\": 0,\r\n \"messageParty\": \"string\",\r\n \"name\": \"string\",\r\n \"partyTypeDescription\": \"string\"\r\n }\r\n ],\r\n \"sender\": {\r\n \"identifier\": 0,\r\n \"messageParty\": \"string\",\r\n \"name\": \"string\",\r\n \"partyTypeDescription\": \"string\"\r\n },\r\n \"read\": true,\r\n \"type\": \"Sent\"\r\n}"}],"_postman_id":"d6305993-ec29-45ff-bff9-fc8cf311842e"}],"id":"ad637b8a-560a-43da-a851-2bf7cca7b00a","_postman_id":"ad637b8a-560a-43da-a851-2bf7cca7b00a","description":""},{"name":"Milestones","item":[{"name":"Update Milestones by Shortname","item":[{"name":"Set Completion Date","id":"15c60f71-8ed8-436b-832a-a06ce7913ab0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shortname\": \"First Customer Call made\",\r\n \"completiondate\": \"2024-03-04T16:17:21.821Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions//Milestones/Update","description":"This Endpoint allows you to set the completion date of the milestone
\nIf you leave completion date empty / null then the completion date on the milestone will be unset.
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","instructions","","Milestones","Update"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[],"_postman_id":"15c60f71-8ed8-436b-832a-a06ce7913ab0"},{"name":"Unset Completion Date","id":"feaddeca-8a4e-4fd1-8da2-ba89eecef8b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shortname\": \"First Customer Call made\",\r\n \"completiondate\": \"null\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions//Milestones/Update","description":"This Endpoint allows you to set the completion date of the milestone
\nIf you leave completion date empty / null then the completion date on the milestone will be unset.
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","instructions","","Milestones","Update"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[],"_postman_id":"feaddeca-8a4e-4fd1-8da2-ba89eecef8b9"},{"name":"Delay Milestone","id":"a999aa0b-f25f-44b9-ba5e-e5b66d15b4d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shortname\": \"First Customer Call made\",\r\n \"delay\": {\r\n \"delayCode\": \"Other\",\r\n \"delayNote\": \"this is a delay note\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/PanelServices//v1/instructions//Milestones/{MilestoneId}/delay","description":"Delaying a milestone will inform relevant parties that the milestone has been delayed.
\n","urlObject":{"protocol":"https","path":["PanelServices","","v1","instructions","","Milestones","{MilestoneId}","delay"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[],"_postman_id":"a999aa0b-f25f-44b9-ba5e-e5b66d15b4d8"},{"name":"Undelay Milestone","id":"4bcea0e9-1839-449e-820a-843b90529c88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shortname\": \"First Customer Call made\",\r\n \"delay\": {\r\n \"delayCode\": \"string\",\r\n \"delayNote\": \"this is a delay note\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/PanelServices//v1/instructions//Milestones/{MilestoneId}/undelay","description":"Delaying a milestone will inform relevant parties that the milestone has been delayed.
\n","urlObject":{"protocol":"https","path":["PanelServices","","v1","instructions","","Milestones","{MilestoneId}","undelay"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[],"_postman_id":"4bcea0e9-1839-449e-820a-843b90529c88"}],"id":"9986abb0-9ac0-4fff-93a4-0535ed6ce969","description":"Provides the ability to update Milestones for an instruction using a \"short name\", this allows the update of the same milestone across multiple panels without the need to know the milestones specific ID.
\n\n\nNote: Not all panels support all Milestones, the list below covers the most common milestones for all panel, to get a specific list please contact your account manager and ask for a complete list prior to integration.
\n
This Endpoint allows you to set the completion date of the milestone
\nIf you leave completion date empty / null then the completion date on the milestone will be unset.
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","instructions","","Milestones","12"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"54986eb0-3177-49fd-8ad6-66ed1da67c40","name":"Set Milestone Completion Date","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"completionDate\": \"2021-02-05T12:32:40.206Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test20.tmgroup.technology/PanelServices//v1/instructions/{instructionId}/Milestones/{MilestoneId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"milestoneId\": 0,\r\n \"instructionId\": 0,\r\n \"description\": \"string\",\r\n \"canUpdate\": true,\r\n \"delay\": {\r\n \"delayCode\": \"string\",\r\n \"delayNote\": \"string\"\r\n },\r\n \"completionDate\": \"2021-02-05T12:32:40.227Z\",\r\n \"allowAllowPastDate\": true,\r\n \"allowFutureDate\": true\r\n}"}],"_postman_id":"3b28eea4-155c-4273-b8f0-e491e0c9c489"},{"name":"Unset Milestone Completion Date","id":"c3afc407-a001-40e1-9602-ca6b4bae1ca7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"completionDate\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions//Milestones/{MilestoneId}","description":"This Endpoint allows you to set the completion date of the milestone
\nIf you leave completion date empty / null then the completion date on the milestone will be unset.
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","instructions","","Milestones","{MilestoneId}"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"e34590fb-6bb8-4502-926b-c4981c7ab935","name":"Set Milestone Completion Date","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"completionDate\": \"2021-02-05T12:32:40.206Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/PanelServices//v1/instructions/{instructionId}/Milestones/{MilestoneId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"milestoneId\": 0,\r\n \"instructionId\": 0,\r\n \"description\": \"string\",\r\n \"canUpdate\": true,\r\n \"delay\": {\r\n \"delayCode\": \"string\",\r\n \"delayNote\": \"string\"\r\n },\r\n \"completionDate\": \"2021-02-05T12:32:40.227Z\",\r\n \"allowAllowPastDate\": true,\r\n \"allowFutureDate\": true\r\n}"}],"_postman_id":"c3afc407-a001-40e1-9602-ca6b4bae1ca7"},{"name":"Delay Milestone","id":"7ac6372a-59bd-47e4-b58c-dbc8507ab326","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"delay\": {\r\n \"delayCode\": \"Other\",\r\n \"delayNote\": \"this is a delay note\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/PanelServices//v1/instructions//Milestones/{MilestoneId}/delay","description":"Delaying a milestone will inform relevant parties that the milestone has been delayed.
\n","urlObject":{"protocol":"https","path":["PanelServices","","v1","instructions","","Milestones","{MilestoneId}","delay"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"e3368f65-88c2-414f-a68d-4f2168f9dbf7","name":"Delay Milestone","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"delay\": {\r\n \"delayCode\": \"duplicate\",\r\n \"delayNote\": \"this is a note\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test20.tmgroup.technology/PanelServices//v1/instructions/{instructionId}/Milestones/{MilestoneId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"milestoneId\": 0,\r\n \"instructionId\": 0,\r\n \"description\": \"string\",\r\n \"canUpdate\": true,\r\n \"delay\": {\r\n \"delayCode\": \"other\",\r\n \"delayNote\": \"string\"\r\n },\r\n \"completionDate\": \"2021-02-05T12:32:40.227Z\",\r\n \"allowAllowPastDate\": true,\r\n \"allowFutureDate\": true\r\n}"}],"_postman_id":"7ac6372a-59bd-47e4-b58c-dbc8507ab326"},{"name":"Undelay Milestone","id":"665a4806-fe67-4d60-9ac2-11756cdacf36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"delay\": {\r\n \"delayCode\": \"string\",\r\n \"delayNote\": \"this is a delay note\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/PanelServices//v1/instructions//Milestones/{MilestoneId}/undelay","description":"Delaying a milestone will inform relevant parties that the milestone has been delayed.
\n","urlObject":{"protocol":"https","path":["PanelServices","","v1","instructions","","Milestones","{MilestoneId}","undelay"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"d756bdcc-a84c-4be0-9bab-653feeac04e8","name":"Undelay Milestone","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://test20.tmgroup.technology/PanelServices//v1/instructions/{instructionId}/Milestones/{MilestoneId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"milestoneId\": 0,\r\n \"instructionId\": 0,\r\n \"description\": \"string\",\r\n \"canUpdate\": true,\r\n \"delay\": {\r\n \"delayCode\": \"string\",\r\n \"delayNote\": \"string\"\r\n },\r\n \"completionDate\": \"2021-02-05T12:32:40.227Z\",\r\n \"allowAllowPastDate\": true,\r\n \"allowFutureDate\": true\r\n}"}],"_postman_id":"665a4806-fe67-4d60-9ac2-11756cdacf36"}],"id":"e31eb3fa-d795-4cdc-b5f1-addbe2236211","description":"Provides the ability to update Milestones for an instruction using a the individual panels milestone ID.
\n\n\n","_postman_id":"e31eb3fa-d795-4cdc-b5f1-addbe2236211"},{"name":"Get Milestones","id":"522f9d26-7c28-4468-a454-4335736cef70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions//Milestones","description":"Note: Not all panels support all Milestones,to get a specific list please contact your account manager and ask for a complete list prior to integration.
\n
Get a list of milestones for an instruction
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","instructions","","Milestones"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"aae85ae5-5182-415d-b49b-4e8236dcc49e","name":"Get Milestones","originalRequest":{"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions/1544830/Milestones"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 14 Jul 2023 13:07:00 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"milestoneId\": 12,\n \"instructionId\": 1544830,\n \"description\": \"First Customer Call made\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": false,\n \"allowFutureDate\": false\n },\n {\n \"milestoneId\": 13,\n \"instructionId\": 1544830,\n \"description\": \"Customer Welcome Pack Sent\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": false,\n \"allowFutureDate\": false\n },\n {\n \"milestoneId\": 1,\n \"instructionId\": 1544830,\n \"description\": \"Instruction Confirmed\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": false,\n \"allowFutureDate\": false\n },\n {\n \"milestoneId\": 14,\n \"instructionId\": 1544830,\n \"description\": \"Memo of Sale received\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": false,\n \"allowFutureDate\": false\n },\n {\n \"milestoneId\": 15,\n \"instructionId\": 1544830,\n \"description\": \"Money on account received\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": false,\n \"allowFutureDate\": false\n },\n {\n \"milestoneId\": 16,\n \"instructionId\": 1544830,\n \"description\": \"Title Information ordered from HMLR\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": false,\n \"allowFutureDate\": false\n },\n {\n \"milestoneId\": 42,\n \"instructionId\": 1544830,\n \"description\": \"Contract Pack Issued\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": false,\n \"allowFutureDate\": false\n },\n {\n \"milestoneId\": 83,\n \"instructionId\": 1544830,\n \"description\": \"Management Co. pack ordered/paid (if req’d.)\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": false,\n \"allowFutureDate\": false\n },\n {\n \"milestoneId\": 18,\n \"instructionId\": 1544830,\n \"description\": \"ID verified\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": false,\n \"allowFutureDate\": false\n },\n {\n \"milestoneId\": 19,\n \"instructionId\": 1544830,\n \"description\": \"Ready to Exchange - Waiting for other Lawyer\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": false,\n \"allowFutureDate\": false\n },\n {\n \"milestoneId\": 20,\n \"instructionId\": 1544830,\n \"description\": \"Exchange of Contracts\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": true,\n \"allowFutureDate\": false\n },\n {\n \"milestoneId\": 112,\n \"instructionId\": 1544830,\n \"description\": \"Completion Date Due\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": false,\n \"allowFutureDate\": true\n },\n {\n \"milestoneId\": 21,\n \"instructionId\": 1544830,\n \"description\": \"Sale Completed On\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": true,\n \"allowFutureDate\": false\n }\n]"}],"_postman_id":"522f9d26-7c28-4468-a454-4335736cef70"},{"name":"Get Milestone by ID","id":"8906f8fb-2ab5-4ba0-93e6-b6d07d2e0c5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions//Milestones/{{milestoneID}}","description":"Get a specific milestones details
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","instructions","","Milestones","{{milestoneID}}"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"17062105-4aa8-4d91-8ac9-bd18bf7054a4","name":"Get Milestone by ID","originalRequest":{"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions/1544830/Milestones/12"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 14 Jul 2023 13:09:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"milestoneId\": 12,\n \"instructionId\": 1544830,\n \"description\": \"First Customer Call made\",\n \"canUpdate\": false,\n \"delay\": {\n \"delayCode\": \"\",\n \"delayNote\": \"\"\n },\n \"allowAllowPastDate\": false,\n \"allowFutureDate\": false\n}"}],"_postman_id":"8906f8fb-2ab5-4ba0-93e6-b6d07d2e0c5f"}],"id":"487d624c-8a80-4f24-bf6a-9432958554ff","_postman_id":"487d624c-8a80-4f24-bf6a-9432958554ff","description":""},{"name":"Documents","item":[{"name":"Get Document List","id":"4ceea733-68f5-4436-9226-794960e2b687","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions//Documents","description":"StartFragment
\nGiven a instruction Id this returns a list of documents associated with the Instruction.
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","instructions","","Documents"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"ea1b9ca9-2c75-4094-9c2f-f9a3dc4384f5","name":"Get Document List","originalRequest":{"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions/1460350/Documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 21 Feb 2023 11:38:27 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"documentId\": 6189197,\n \"documentType\": \"NextSteps\",\n \"documentName\": \"NextSteps\",\n \"documentFormat\": \"pdf\",\n \"dateCreated\": \"2017-04-11T14:51:03.953\",\n \"version\": 1,\n \"sharedParties\": [\n {\n \"partyType\": \"PanelManager\",\n \"permissions\": [\n \"List\",\n \"Read\"\n ]\n }, \n {\n \"partyType\": \"Client\",\n \"permissions\": [\n \"List\",\n \"Read\"\n ]\n },\n {\n \"partyType\": \"Conveyancer\",\n \"permissions\": [\n \"List\",\n \"Read\"\n ]\n }\n ]\n },\n {\n \"documentId\": 23703562,\n \"documentType\": \"OrigInstr\",\n \"documentName\": \"OriginalInstruction\",\n \"documentFormat\": \"pdf\",\n \"dateCreated\": \"2023-02-15T13:48:43.057\",\n \"version\": 1,\n \"sharedParties\": [\n {\n \"partyType\": \"Introducer\",\n \"permissions\": [\n \"List\",\n \"Read\"\n ]\n },\n {\n \"partyType\": \"PanelManager\",\n \"permissions\": [\n \"List\",\n \"Read\"\n ]\n },\n {\n \"partyType\": \"Conveyancer\",\n \"permissions\": [\n \"List\",\n \"Read\"\n ]\n }\n ]\n }\n]"}],"_postman_id":"4ceea733-68f5-4436-9226-794960e2b687"},{"name":"Get Document Details","id":"789fa1f5-bd56-4298-b48d-17f53472bcb6","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions//Documents/{{documentId}}","urlObject":{"protocol":"https","path":["PanelServices","v1","instructions","","Documents","{{documentId}}"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"d06b26e2-8210-4b25-8eb2-57037d7e399d","name":"Get Document Details","originalRequest":{"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions/1460350/Documents/23703562"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 21 Feb 2023 11:40:27 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"documentId\": 23703562,\n \"documentType\": \"OrigInstr\",\n \"documentName\": \"OriginalInstruction\",\n \"documentFormat\": \"pdf\",\n \"dateCreated\": \"2023-02-15T13:48:43.057\",\n \"version\": 1,\n \"sharedParties\": [\n {\n \"partyType\": \"Introducer\",\n \"permissions\": [\n \"List\",\n \"Read\"\n ]\n }, \n {\n \"partyType\": \"PanelManager\",\n \"permissions\": [\n \"List\",\n \"Read\"\n ]\n },\n {\n \"partyType\": \"Conveyancer\",\n \"permissions\": [\n \"List\",\n \"Read\"\n ]\n } \n ]\n}"}],"_postman_id":"789fa1f5-bd56-4298-b48d-17f53472bcb6"},{"name":"Get Document Details with Base64 file content","id":"342eccca-5e64-4c0f-95c8-64a9c349da86","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions//Documents/{{documentId}}?include=file","urlObject":{"protocol":"https","path":["PanelServices","v1","instructions","","Documents","{{documentId}}"],"host":["demo20","tmgroup","technology"],"query":[{"key":"include","value":"file"}],"variable":[]}},"response":[{"id":"b18addb3-1144-4716-b099-deb78f9cbbe7","name":"Get Document Details with Base64 file content","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://demo20.tmgroup.technology/PanelServices/v1/instructions/1460350/Documents/23703562?include=file","protocol":"https","host":["demo20","tmgroup","technology"],"path":["PanelServices","v1","instructions","1460350","Documents","23703562"],"query":[{"key":"include","value":"file"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 21 Feb 2023 11:41:31 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"documentId\": 23703562,\n \"documentType\": \"OrigInstr\",\n \"documentName\": \"OriginalInstruction\",\n \"documentFormat\": \"pdf\",\n \"dateCreated\": \"2023-02-15T13:48:43.057\",\n \"version\": 1,\n \"sharedParties\": [\n {\n \"partyType\": \"Introducer\",\n \"permissions\": [\n \"List\",\n \"Read\"\n ]\n },\n {\n \"partyType\": \"PanelManager\",\n \"permissions\": [\n \"List\",\n \"Read\"\n ]\n }, \n {\n \"partyType\": \"Conveyancer\",\n \"permissions\": [\n \"List\",\n \"Read\"\n ]\n }\n ],\n \"base64EncodedFile\": \"FILE CONTENT\"\n}"}],"_postman_id":"342eccca-5e64-4c0f-95c8-64a9c349da86"},{"name":"Get Document File Stream","id":"8cc6a4b8-e431-4137-aee6-69009a4410ba","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/octet-stream","type":"text"}],"url":"https://demo20.tmgroup.technology/PanelServices/v1/instructions//Documents/{{documentId}}","description":"Adding the the header value \"Accept\" = \"application/octet-stream\" will result in the file being streamed via the api.
\n","urlObject":{"protocol":"https","path":["PanelServices","v1","instructions","","Documents","{{documentId}}"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[],"_postman_id":"8cc6a4b8-e431-4137-aee6-69009a4410ba"}],"id":"6e607391-054f-4dc7-9379-8b5e56069527","description":"Get Documents for Instruction.
\n","_postman_id":"6e607391-054f-4dc7-9379-8b5e56069527"},{"name":"Webhooks","item":[{"name":"Orders","item":[{"name":"Order Created","id":"3277d3b1-210b-4347-a98e-58492922e469","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event\": \"order.created\",\r\n \"eventId\": \"cdd86698-9201-45bc-a660-0e74ed16e92e\",\r\n \"timeStamp\": \"2021-02-24T11:49:51\",\r\n \"data\": {\r\n \"product\": \"Dummy Search Report\",\r\n \"productType\": \"DMSRP\",\r\n \"status\": \"InProcess\",\r\n \"dateOrdered\": \"2021-02-24T11:47:18.983\",\r\n \"expectedDeliveryDate\": \"2021-03-24T11:47:18\",\r\n \"dateOrderCompleted\": \"\",\r\n \"vatable\": 0,\r\n \"nonVatable\": 0,\r\n \"vat\": 0,\r\n \"customerReference\": \"Test Notes\",\r\n \"orderItemId\": 11111111,\r\n \"propertyReference\": \"ABC123456\",\r\n \"instructionId\": 12345678,\r\n \"conveyancerReference\": \"Alt_Ref_When_Not_Conveyancer_Party\"\r\n },\r\n \"links\": [\r\n {\r\n \"href\": \"https://www.tmgroup.technology/PropertySearches/orders/11111111\",\r\n \"name\": \"GetOrdersDetails\",\r\n \"type\": \"GET\"\r\n },\r\n {\r\n \"href\": \"https://www.tmgroup.technology/PropertySearches/orders/11111111/Results\",\r\n \"name\": \"GetResults\",\r\n \"type\": \"GET\"\r\n },\r\n {\r\n \"href\": \"https://www.tmgroup.technology/PropertySearches/orders/11111111/Results/zip\",\r\n \"name\": \"GetResultsZipped\",\r\n \"type\": \"GET\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://CustomerEndpoint","urlObject":{"protocol":"https","host":["CustomerEndpoint"],"query":[],"variable":[]}},"response":[],"_postman_id":"3277d3b1-210b-4347-a98e-58492922e469"},{"name":"Order Received","id":"a10406f4-d381-4be9-a09d-c6134fb3e2fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event\": \"order.received\",\r\n \"eventId\": \"cdd86698-9201-45bc-a660-0e74ed16e92e\",\r\n \"timeStamp\": \"2021-02-24T11:49:51\",\r\n \"data\": {\r\n \"product\": \"Dummy Search Report\",\r\n \"productType\": \"DMSRP\",\r\n \"status\": \"SearchResponseReceived\",\r\n \"dateOrdered\": \"2021-02-24T11:47:18.983\",\r\n \"expectedDeliveryDate\": \"2021-03-24T11:47:18\",\r\n \"dateOrderCompleted\": \"2021-02-24T11:49:51\",\r\n \"vatable\": 0,\r\n \"nonVatable\": 0,\r\n \"vat\": 0,\r\n \"customerReference\": \"Test Notes\",\r\n \"orderItemId\": 11111111,\r\n \"propertyReference\": \"ABC123456\",\r\n \"instructionId\": 12345678,\r\n \"conveyancerReference\": \"Alt_Ref_When_Not_Conveyancer_Party\"\r\n },\r\n \"links\": [\r\n {\r\n \"href\": \"https://www.tmgroup.technology/PropertySearches/orders/11111111\",\r\n \"name\": \"GetOrdersDetails\",\r\n \"type\": \"GET\"\r\n },\r\n {\r\n \"href\": \"https://www.tmgroup.technology/PropertySearches/orders/11111111/Results\",\r\n \"name\": \"GetResults\",\r\n \"type\": \"GET\"\r\n },\r\n {\r\n \"href\": \"https://www.tmgroup.technology/PropertySearches/orders/11111111/Results/zip\",\r\n \"name\": \"GetResultsZipped\",\r\n \"type\": \"GET\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://CustomerEndpoint","urlObject":{"protocol":"https","host":["CustomerEndpoint"],"query":[],"variable":[]}},"response":[],"_postman_id":"a10406f4-d381-4be9-a09d-c6134fb3e2fa"},{"name":"Order Closed","id":"0269a0d8-e4e3-48c6-b681-e6fb3382b46b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event\": \"order.closed\",\r\n \"eventId\": \"cdd86698-9201-45bc-a660-0e74ed16e92e\",\r\n \"timeStamp\": \"2021-02-24T11:49:51\",\r\n \"data\": {\r\n \"product\": \"Dummy Search Report\",\r\n \"productType\": \"DMSRP\",\r\n \"status\": \"SearchClosed\",\r\n \"dateOrdered\": \"2021-02-24T11:47:18.983\",\r\n \"expectedDeliveryDate\": \"2021-03-24T11:47:18\",\r\n \"dateOrderCompleted\": \"\",\r\n \"vatable\": 0,\r\n \"nonVatable\": 0,\r\n \"vat\": 0,\r\n \"customerReference\": \"Test Notes\",\r\n \"orderItemId\": 11111111,\r\n \"propertyReference\": \"ABC123456\",\r\n \"instructionId\": 12345678,\r\n \"conveyancerReference\": \"Alt_Ref_When_Not_Conveyancer_Party\"\r\n },\r\n \"links\": [\r\n {\r\n \"href\": \"https://www.tmgroup.technology/PropertySearches/orders/11111111\",\r\n \"name\": \"GetOrdersDetails\",\r\n \"type\": \"GET\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://CustomerEndpoint","urlObject":{"protocol":"https","host":["CustomerEndpoint"],"query":[],"variable":[]}},"response":[],"_postman_id":"0269a0d8-e4e3-48c6-b681-e6fb3382b46b"},{"name":"Due Date Updated","id":"9c06d2f5-461f-47e0-887c-b4ac990e8b27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event\": \"order.expected_delivery.updated \",\r\n \"eventId\": \"cdd86698-9201-45bc-a660-0e74ed16e92e\",\r\n \"timeStamp\": \"2021-02-24T11:49:51\",\r\n \"data\": {\r\n \"product\": \"Dummy Search Report\",\r\n \"productType\": \"DMSRP\",\r\n \"status\": \"InProcess\",\r\n \"dateOrdered\": \"2021-02-24T11:47:18.983\",\r\n \"expectedDeliveryDate\": \"2021-03-24T11:47:18\",\r\n \"dateOrderCompleted\": \"\",\r\n \"vatable\": 0,\r\n \"nonVatable\": 0,\r\n \"vat\": 0,\r\n \"customerReference\": \"Test Notes\",\r\n \"orderItemId\": 11111111,\r\n \"propertyReference\": \"ABC123456\",\r\n \"instructionId\": 12345678,\r\n \"conveyancerReference\": \"Alt_Ref_When_Not_Conveyancer_Party\"\r\n },\r\n \"links\": [\r\n {\r\n \"href\": \"https://www.tmgroup.technology/PropertySearches/orders/11111111\",\r\n \"name\": \"GetOrdersDetails\",\r\n \"type\": \"GET\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://CustomerEndpoint","urlObject":{"protocol":"https","host":["CustomerEndpoint"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c06d2f5-461f-47e0-887c-b4ac990e8b27"},{"name":"Order Status Update - InQuery","id":"7f541ab2-d737-428c-9f41-cb623f8d5e01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event\": \"order.status.updated\",\r\n \"eventId\": \"3433c6c6-c8de-4ab0-b278-ee36a24f5c2f\",\r\n \"timeStamp\": \"2024-02-22T11:19:34\",\r\n \"data\": {\r\n \"product\": \"Regulated Personal Local Search\",\r\n \"productType\": \"PSReport12\",\r\n \"status\": \"InQuery\",\r\n \"dateOrdered\": \"2024-02-22T11:17:53.063\",\r\n \"expectedDeliveryDate\": \"2024-03-19T11:17:53\",\r\n \"dateOrderCompleted\": null,\r\n \"vatable\": 99.5,\r\n \"nonVatable\": 0.0,\r\n \"vat\": 19.9,\r\n \"customerReference\": \"dbfe887b-3a45-4302-b46a-937f011580c4\",\r\n \"orderItemId\": 25474364,\r\n \"propertyReference\": \"ABC123456\",\r\n \"instructionId\": 12345678,\r\n \"conveyancerReference\": \"Alt_Ref_When_Not_Conveyancer_Party\"\r\n },\r\n \"links\": [\r\n {\r\n \"href\": \"https://test20.tmgroup.technology/PropertySearches/orders/25474364\",\r\n \"name\": \"GetOrdersDetails\",\r\n \"type\": \"GET\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://CustomerEndpoint","urlObject":{"protocol":"https","host":["CustomerEndpoint"],"query":[],"variable":[]}},"response":[],"_postman_id":"7f541ab2-d737-428c-9f41-cb623f8d5e01"},{"name":"Order Status Update - InProcess","id":"27667bd2-4a20-43bf-bb2b-d2bfba42d519","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event\": \"order.status.updated\",\r\n \"eventId\": \"5b28f6bb-0f42-4c4a-a54f-388dbd236663\",\r\n \"timeStamp\": \"2024-02-22T11:21:51\",\r\n \"data\": {\r\n \"product\": \"Regulated Personal Local Search\",\r\n \"productType\": \"PSReport12\",\r\n \"status\": \"InProcess\",\r\n \"dateOrdered\": \"2024-02-22T11:17:53.063\",\r\n \"expectedDeliveryDate\": \"2024-03-19T11:17:53\",\r\n \"dateOrderCompleted\": null,\r\n \"vatable\": 99.5,\r\n \"nonVatable\": 0.0,\r\n \"vat\": 19.9,\r\n \"customerReference\": \"dbfe887b-3a45-4302-b46a-937f011580c4\",\r\n \"orderItemId\": 25474364,\r\n \"propertyReference\": \"ABC123456\",\r\n \"instructionId\": 12345678,\r\n \"conveyancerReference\": \"Alt_Ref_When_Not_Conveyancer_Party\"\r\n },\r\n \"links\": [\r\n {\r\n \"href\": \"https://test20.tmgroup.technology/PropertySearches/orders/25474364\",\r\n \"name\": \"GetOrdersDetails\",\r\n \"type\": \"GET\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://CustomerEndpoint","urlObject":{"protocol":"https","host":["CustomerEndpoint"],"query":[],"variable":[]}},"response":[],"_postman_id":"27667bd2-4a20-43bf-bb2b-d2bfba42d519"},{"name":"Order Status Update - SearchClosed","id":"626bd8c6-4441-40d8-af3b-fee0bddc0c96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event\": \"order.status.updated\",\r\n \"eventId\": \"632ac077-dca9-42bf-8f98-98f41d7a8129\",\r\n \"timeStamp\": \"2024-02-22T11:22:25\",\r\n \"data\": {\r\n \"product\": \"Regulated Personal Local Search\",\r\n \"productType\": \"PSReport12\",\r\n \"status\": \"SearchClosed\",\r\n \"dateOrdered\": \"2024-02-22T11:17:53.063\",\r\n \"expectedDeliveryDate\": \"2024-03-19T11:17:53\",\r\n \"dateOrderCompleted\": null,\r\n \"vatable\": 99.5,\r\n \"nonVatable\": 0.0,\r\n \"vat\": 19.9,\r\n \"customerReference\": \"dbfe887b-3a45-4302-b46a-937f011580c4\",\r\n \"orderItemId\": 25474364,\r\n \"propertyReference\": \"ABC123456\",\r\n \"instructionId\": 12345678,\r\n \"conveyancerReference\": \"Alt_Ref_When_Not_Conveyancer_Party\"\r\n },\r\n \"links\": [\r\n {\r\n \"href\": \"https://test20.tmgroup.technology/PropertySearches/orders/25474364\",\r\n \"name\": \"GetOrdersDetails\",\r\n \"type\": \"GET\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://CustomerEndpoint","urlObject":{"protocol":"https","host":["CustomerEndpoint"],"query":[],"variable":[]}},"response":[],"_postman_id":"626bd8c6-4441-40d8-af3b-fee0bddc0c96"},{"name":"Order Status Update - SearchResponseReceived","id":"d35b1d4c-c00f-4b98-b6ea-342d15d20ba9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event\": \"order.status.updated\",\r\n \"eventId\": \"11bd5835-2953-4bc2-ab6f-28d548f6e182\",\r\n \"timeStamp\": \"2024-02-22T11:24:55\",\r\n \"data\": {\r\n \"product\": \"Regulated Personal Local Search\",\r\n \"productType\": \"PSReport12\",\r\n \"status\": \"SearchResponseReceived\",\r\n \"dateOrdered\": \"2024-02-22T11:18:03.97\",\r\n \"expectedDeliveryDate\": \"2024-03-20T23:59:59\",\r\n \"dateOrderCompleted\": \"2024-02-22T11:24:55\",\r\n \"vatable\": 99.5,\r\n \"nonVatable\": 0.0,\r\n \"vat\": 19.9,\r\n \"customerReference\": \"dbfe887b-3a45-4302-b46a-937f011580c4\",\r\n \"orderItemId\": 25474365,\r\n \"propertyReference\": \"ABC123456\",\r\n \"instructionId\": 12345678,\r\n \"conveyancerReference\": \"Alt_Ref_When_Not_Conveyancer_Party\"\r\n },\r\n \"links\": [\r\n {\r\n \"href\": \"https://test20.tmgroup.technology/PropertySearches/orders/25474365\",\r\n \"name\": \"GetOrdersDetails\",\r\n \"type\": \"GET\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://CustomerEndpoint","urlObject":{"protocol":"https","host":["CustomerEndpoint"],"query":[],"variable":[]}},"response":[],"_postman_id":"d35b1d4c-c00f-4b98-b6ea-342d15d20ba9"}],"id":"35ffb27a-336b-4ac7-a68e-bf47d51af754","description":"# Orders Data Payload
\n\n\n","_postman_id":"35ffb27a-336b-4ac7-a68e-bf47d51af754"},{"name":"Document","item":[{"name":"Document Updated","id":"d0ae27b0-3a61-4e78-8db6-aab5e2ee50da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event\": \"instruction.document.updated\",\r\n \"eventId\": \"c4852adf-d58a-45c2-9e06-923795b67e52\",\r\n \"timeStamp\": \"2021-02-25T15:12:32\",\r\n \"data\": {\r\n \"documentId\": 1111111,\r\n \"instructionId\": 222222,\r\n \"documentType\": \"WelcomeLetter\",\r\n \"documentDescription\": \"Welcome Letter\",\r\n \"documentName\": \"WelcomeLetter.pdf\",\r\n \"documentFormat\": \"pdf\",\r\n \"dateCreated\": \"2021-02-25T15:12:31.08\",\r\n \"version\": 1\r\n },\r\n \"links\": [\r\n {\r\n \"href\": \"https://www.tmgroup.technology/panelservices/instructions/222222/documents/1111111\",\r\n \"name\": \"GetDocument\",\r\n \"type\": \"GET\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://CustomerEndpoint","urlObject":{"protocol":"https","host":["CustomerEndpoint"],"query":[],"variable":[]}},"response":[],"_postman_id":"d0ae27b0-3a61-4e78-8db6-aab5e2ee50da"},{"name":"Document Created","id":"bb999b75-3954-478e-a7dd-898d47738126","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event\": \"instruction.document.created\",\r\n \"eventId\": \"c4852adf-d58a-45c2-9e06-923795b67e52\",\r\n \"timeStamp\": \"2021-02-25T15:12:32\",\r\n \"data\": {\r\n \"documentId\": 1111111,\r\n \"instructionId\": 222222,\r\n \"documentType\": \"WelcomeLetter\",\r\n \"documentDescription\": \"Welcome Letter\",\r\n \"documentName\": \"WelcomeLetter.pdf\",\r\n \"documentFormat\": \"pdf\",\r\n \"dateCreated\": \"2021-02-25T15:12:31.08\",\r\n \"version\": 1\r\n },\r\n \"links\": [\r\n {\r\n \"href\": \"https://www.tmgroup.technology/panelservices/instructions/222222/documents/1111111\",\r\n \"name\": \"GetDocument\",\r\n \"type\": \"GET\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://CustomerEndpoint","urlObject":{"protocol":"https","host":["CustomerEndpoint"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb999b75-3954-478e-a7dd-898d47738126"}],"id":"1d35c901-3a2a-4555-831b-4f0fb40f4ead","description":"Please note that our \"Notifications\" are designed to be light weight so the \"order.received\" notification is a trigger for your system to call our API to download the results.
\n
Listen for events notifications from us so your integration can automatically trigger a reaction. Simply provide us with your web hook endpoint, choose which notifications your are interested in receiving and off you go.
\nOur notifications are designed to be light weight messages that provided your system with sufficient information to trigger an event in your system. Our notification format is made up of an event type, event payload URI and a data payload (the type of data depends on the event type).
\nExample Notification
\n{\n \"event\": \"event name\",\n \"eventId\": \"GUID\",\n \"timestamp\": \"2021-01-29T15:29:01.001\",\n \"data\": {}, \n \"links\": [\n {\n \"href\": \"url\",\n \"name\": \"name\",\n \"type\": \"GET\"\n }\n ] \n}\n\n\n\nBest-Effort Ordering:
\n
Occasionally, messages might be delivered in an order different from which they were created. It is good practice to handle the notifications in an idempotent manner.
This is a list of all the types we currently send. As consumer you can choose which of these events you subscribe too, the available events will also depend on which aspects of our system you are using e.g. Instructions, Milestones, Documents and Messages are only available for customer using the \"Panel Management\" features.
\nSearch Orders
\nInstructions
\nDocuments
\nMilestones
\nMessages
\nList of current events
\n\norder.created datais an Order
Occurs at the point of a order being placed.
\norder.expected_delivery.updated data is an Order
Occurs when the expected delivery date has been updated.
\norder.closed data is an Order
Occurs when an order has been closed, this happens when an order has been cancelled.
\norder.received data is an Order
Occurs when an order has been completed and the results are available to be downloaded.
\ninstruction.allocated data is a Instruction
Occurs when an instruction is allocated to a panel firm.
\ninstruction.document.created data is a Document
Occurs when a document has been created.
\ninstruction.document.updated data is a Document
Occurs when a document has been updated.
\ninstruction.milestone.delayed data is a Milestone
Occurs when a milestone is delayed.
\ninstruction.milestone.undelayed data is a Milestone
Occurs when a milestone is undelayed.
\ninstruction.milestone.completion_date.updated data is a Milestone
Occurs when a milestones completion date is updated.
\ninstruction.message.sent data is a Message
Occurs when a message is sent.
\ninstruction.message.received data is a Message
Occurs when a message is received.
\ninstruction.status.updated data is a Instruction
Occurs when the status of the instruction is updated.
\ninstruction.property_lawyer.updated data is a Instruction
Occurs when the fee earner for an instruction is added or updated.
\ninstruction.note.created data is a Instruction
Occurs when a note is added to an instruction.
\ninstruction.metadata.updated data is a Instruction
Occurs when metadata is added or updated on an instruction.
\ninstruction.abort.requested data is a Instruction
Used to communicate when an instruction abort is requested from a non-conveyancer party.
\ninstruction.client.status.updated data is a Instruction
Occurs when a client has changed their preference for web access.
\nThis step is optional but it is advised that you implement this step to ensure that the notifications you receive have originated from us.
\nWhen we send notifications to your endpoint we will include in the header of the notification a Hash-based Message Authentication Code (HMAC).
\nThis verifies that the sender of the message knows the secret key (we will provide you with a unique secret key).
\nThe HMAC is created with SHA256 algorithm, then encoded in base 64.
\nTo validate that a notification has come from us you will need to compute a SHA256 hash of the unformatted contents of the notification (raw JSON) with the x-timestamp (from the header) + '.' + hmac key (we will provide you a unique key) that the notification was sent to you, which you can obtain from the request headers.
\n\n\nNOTE: The x-timestamp and the key are separated by a full stop '.'
\n
We have provided a sample method utilising C# and the .Net runtime below:
\nprivate string GenerateSignature(string timestamp, string hmacKey, string body)\n{\n using var shaAlgorithm = new HMACSHA256(key);\n var key = Encoding.UTF8.GetBytes($\"{timestamp}.{hmacKey}\"); \n var signatureBytes = Encoding.UTF8.GetBytes(body);\n var signatureHashBytes = shaAlgorithm.ComputeHash(signatureBytes);\n var signatureHashHex = string.Concat(Array.ConvertAll(signatureHashBytes, b => b.ToString(\"X2\"))).ToLower();\nreturn signatureHashHex;\n}\n\nOnce the signature has been generated you can then compare it to the signature that was provided in the request header 'x-signature'.
\n\n\n","_postman_id":"d793e676-e069-4521-8f85-3e32b64f9fac"}],"event":[{"listen":"prerequest","script":{"id":"7a8d6456-f80d-411b-90d0-c8c86e8ecb1f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cdcc3959-7eb9-4deb-a478-bf12bb99684a","type":"text/javascript","exec":[""]}}],"variable":[{"key":"BaseEnvironmentURL","value":"demo20"},{"key":"bearerToken","value":"Generated_Token"},{"key":"projectId","value":"1000001"},{"key":"orderItemId","value":"1234567"},{"key":"UPRN","value":"100031060071"},{"key":"instructionId","value":"","type":"string"}]}We recommend that any requests received which have an ‘x-timestamp’ header value being older than 5 minutes or more at the time when you received the request is discarded as this can help to prevent a malicious replay requests from affecting your systems.
\n