\n\nUPDATED: This is our new version of our documentation if you are looking for MIO or tmConnect these are now hosted on a new seperate dedicated documentation site as listed below in the \"Other Useful API Documentation\" section.
\n
tmGroup Technology's REST API Collection provides you with a powerful, convenient, and simple suite of APIs. This documentation covers the the following functionality provided by the APIs:
\nAddress Lookup
\nAddress Lookup
\nSingle match by address string
\nSingle match by address lines
\nProperty Location Information
\nProperty Risks (Coming Soon)
\nLand Registry Searches
\nTitle Number Lookup
\nOfficial Copy OC1
\nAdditional API Documentation for other areas can be found with the links below:
\nTo register your interest in using our APIs please email technology@tmgroup.co.uk
\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 ammend 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.
\nCodes in the 2xx range indicate success.
\nCodes in the 4xx range indicate an error due to the information provided
\nCodes in the 5xx range indicate an error with our service
\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":"e0db6587-0d15-423b-afc1-1bb2570a4d12","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":"f3198c63-f344-41ad-9935-5beab9bf1900"}],"id":"8b906c95-0fde-4895-8f40-9505c060a951","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":{"id":"bca5738e-fb22-459e-8ee3-f17036b00624","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1f42e754-9365-409e-b2ba-60e7051a93c2","type":"text/javascript","exec":[""]}}],"_postman_id":"8b906c95-0fde-4895-8f40-9505c060a951"},{"name":"HelloWorld","item":[{"name":"HelloWorld v1","event":[{"listen":"test","script":{"id":"a5bf5e0a-2fe0-4d78-a55d-6dd71cf4fa22","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"91abfded-e064-4e8b-a48d-29cbfd05d0c8","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":"ab7b0008-eaa1-4793-9ea0-baca99b4441e","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":"91abfded-e064-4e8b-a48d-29cbfd05d0c8"},{"name":"HelloWorld v2","event":[{"listen":"test","script":{"id":"a5bf5e0a-2fe0-4d78-a55d-6dd71cf4fa22","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"07f05c46-bb37-4f8c-afee-abfd5b6141f8","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":"9d8cdb02-0b61-4bb8-9d66-efd71835100c","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":"07f05c46-bb37-4f8c-afee-abfd5b6141f8"},{"name":"HelloWorld - Authenticated","event":[{"listen":"test","script":{"id":"276122a5-d972-4c8c-b4e1-3881292a754a","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"c2366ec4-c093-44da-a86d-4e6080087788","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":"45dd0b16-65d0-4413-8ceb-9d5374d4311b","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":"c2366ec4-c093-44da-a86d-4e6080087788"}],"id":"6a902de5-8a75-4a5f-a27e-f0d66063b455","description":"Swagger URL
\nExample API to test your connection and authentication.
\n","event":[{"listen":"prerequest","script":{"id":"c452cfa1-8525-4bc4-a4a0-a5a3d151d08e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"606194bb-0993-4b13-b2a5-9722af14fa94","type":"text/javascript","exec":[""]}}],"_postman_id":"6a902de5-8a75-4a5f-a27e-f0d66063b455"},{"name":"Location Services","item":[{"name":"Address Find","event":[{"listen":"test","script":{"id":"7be23edd-cc60-4d5e-8f3a-b8c2c62eecb4","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","if (responseCode.code !== 200) return;","// continue with other tests","","// Store uprn","pm.collectionVariables.set(\"TMPRN\", pm.response.json().addressList[0].tMprn);"],"type":"text/javascript"}}],"id":"5b701c53-7ea8-45c3-a7b3-ed07b3a33c1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"addressString\": \"T M Group (UK) Limited 1 SN57XZ\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/locationservices/v1/address/find","description":"Our address lookup returns a matched list based on the input of an address string. Our advanced address algorithms means that you do not need to provide delimiters just an address string with as much data as you have or simply provide a post code.
\nThe API will return a list of matched addresses for you to choose from. Once your happy that you have found the correct address use out \"Select Address\" API to retrieve additional details of the property including the UPRN which you can then use with our other APIs.
\n","urlObject":{"protocol":"https","path":["locationservices","v1","address","find"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"eaddb689-e0a7-4918-9f92-7cd5c77a2512","name":"Address Find","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/xml","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressString\": \"sn57xz\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/locationservices/v1/address/find"},"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, 22 Oct 2021 09:27:52 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"addressList\": [\n {\n \"tMprn\": \"LasG5Bw5Q7HLXG5zwpRFug==\",\n \"displayString\": \"Apple UK Ltd Unit 1100 Delta Office Park Welton Road Swindon Wiltshire SN5 7XZ\"\n },\n {\n \"tMprn\": \"kMRjdd8TT2rVJGNp7QEn4A==\",\n \"displayString\": \"Sodexo Ltd Unit 1100 Delta Office Park Welton Road Swindon Wiltshire SN5 7XZ\"\n },\n {\n \"tMprn\": \"vxmXGK04Q9ajP8PeoNznhA==\",\n \"displayString\": \"C M S Supatrak Unit 1200 Delta Office Park Welton Road Swindon Wiltshire SN5 7XZ\"\n },\n {\n \"tMprn\": \"vAblrN63uddKj59fIy7nsA==\",\n \"displayString\": \"Cherwell Software Ltd Unit 1200 Delta Office Park Welton Road Swindon Wiltshire SN5 7XZ\"\n },\n {\n \"tMprn\": \"h4M4hCw3mm1RSiYJupsP4g==\",\n \"displayString\": \"T M Property Searches Ltd Unit 1200 Delta Office Park Welton Road Swindon Wiltshire SN5 7XZ\"\n },\n {\n \"tMprn\": \"YZtQgKgOH7U/2lYyb9EMHQ==\",\n \"displayString\": \"T M Group (UK) Limited 1 Unit 1200 Welton Road Westlea Swindon Wiltshire SN5 7XZ\"\n },\n {\n \"tMprn\": \"7RtRuRxKrroKw/GBMqm1wQ==\",\n \"displayString\": \"Cms Supatrak Limited 2 Unit 1200 Welton Road Westlea Swindon Wiltshire SN5 7XZ\"\n },\n {\n \"tMprn\": \"i915bzn1PE1UVczvuTYYsQ==\",\n \"displayString\": \"Cherwell Software Limited 3 Unit 1200 Welton Road Westlea Swindon Wiltshire SN5 7XZ\"\n },\n {\n \"tMprn\": \"5Qt3A5RTuVKieceXeTEKEA==\",\n \"displayString\": \"Ground Floor East Qa House Unit 1100 Welton Road Westlea Swindon Wiltshire SN5 7XZ\"\n },\n {\n \"tMprn\": \"pjpFfQcuMDQy+qFkyrZ5JQ==\",\n \"displayString\": \"First Floor Qa House Unit 1100 Welton Road Westlea Swindon Wiltshire SN5 7XZ\"\n },\n {\n \"tMprn\": \"F2QkvA3Rbqu2Hi9cXQImuQ==\",\n \"displayString\": \"Ground Floor West Qa House Unit 1100 Welton Road Westlea Swindon Wiltshire SN5 7XZ\"\n }\n ]\n}"}],"_postman_id":"5b701c53-7ea8-45c3-a7b3-ed07b3a33c1c"},{"name":"Select Address","event":[{"listen":"test","script":{"id":"2e87f3e0-8f48-4a21-b12b-05a57f2517c5","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","if (responseCode.code !== 200) return;","// continue with other tests","","// Store uprn","pm.collectionVariables.set(\"UPRN\", pm.response.json().uprn);"],"type":"text/javascript"}}],"id":"1630fff1-e0b3-4551-ab05-74acdcd56ac9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tmprn\": \"{{TMPRN}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/locationservices/v1/address/select/","description":"Our address lookup API provides back a match list of properties, this API is used to select the address using out tmprn and return more property details such as UPRN and PAF address.
\nYou now have the UPRN in which to use when placing orders or using our other APIs.
\n","urlObject":{"protocol":"https","path":["locationservices","v1","address","select",""],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"705c45bd-0196-4b77-8970-3df37726141f","name":"Select Address","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/xml","disabled":true}],"body":{"mode":"raw","raw":"{\n \"tmprn\": \"{{TMPRN}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/locationservices/v1/address/select/"},"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, 05 Nov 2021 13:53:59 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"pafAddress\": {\n \"organisationName\": \"T M GROUP (UK) LIMITED\",\n \"departmentName\": \"\",\n \"poBox\": null,\n \"buildingName\": \"UNIT 1200\",\n \"subBuildingName\": \"1\",\n \"subBuilding\": \"1\",\n \"buildingNumber\": \"\",\n \"thoroughfareName\": \"WELTON\",\n \"dependentThoroughfareName\": \"\",\n \"dependentLocality\": \"WESTLEA\",\n \"doubleDependentLocality\": \"\",\n \"postTown\": \"SWINDON\",\n \"postcode\": \"SN5 7XZ\",\n \"county\": \"WILTSHIRE\",\n \"onsCountryCode\": \"E\"\n },\n \"uprn\": 10093395927\n}"}],"_postman_id":"1630fff1-e0b3-4551-ab05-74acdcd56ac9"},{"name":"Select Address (TitleCase)","event":[{"listen":"test","script":{"id":"1c4994eb-dfd8-4a54-856d-ab7860c0f813","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","if (responseCode.code !== 200) return;","// continue with other tests","","// Store uprn","pm.collectionVariables.set(\"UPRN\", pm.response.json().uprn);"],"type":"text/javascript"}}],"id":"a85d2eca-e836-479f-b5f1-b6434a3ebff2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tmprn\": \"{{TMPRN}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/locationservices/v1/address/select?addressDisplayFormat=titleCase","description":"This API provides a more UI friendly version of the API response if you choose to display this in your UI.
\n","urlObject":{"protocol":"https","path":["locationservices","v1","address","select"],"host":["demo20","tmgroup","technology"],"query":[{"key":"addressDisplayFormat","value":"titleCase"}],"variable":[]}},"response":[{"id":"d424ad66-78d7-4393-b6f3-c75d4a32894c","name":"Select Address (TitleCase)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/xml","disabled":true}],"body":{"mode":"raw","raw":"{\n \"tmprn\": \"{{TMPRN}}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://demo20.tmgroup.technology/locationservices/v1/address/select?addressDisplayFormat=titleCase","protocol":"https","host":["demo20","tmgroup","technology"],"path":["locationservices","v1","address","select"],"query":[{"key":"addressDisplayFormat","value":"titleCase"}]}},"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":"Mon, 04 Dec 2023 10:19:43 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"pafAddress\": {\n \"organisationName\": \"T M PROPERTY SEARCHES LTD\",\n \"departmentName\": \"\",\n \"poBox\": null,\n \"buildingName\": \"Unit 1200\",\n \"subBuildingName\": \"\",\n \"subBuilding\": \"\",\n \"buildingNumber\": \"\",\n \"thoroughfareName\": \"Welton\",\n \"thoroughfareDescriptor\": \"Road\",\n \"dependentThoroughfareName\": \"Delta Office\",\n \"dependentLocality\": \"\",\n \"doubleDependentLocality\": \"\",\n \"postTown\": \"Swindon\",\n \"postcode\": \"SN5 7XZ\",\n \"county\": \"Wiltshire\",\n \"onsCountryCode\": \"E\"\n },\n \"uprn\": 10004841678\n}"}],"_postman_id":"a85d2eca-e836-479f-b5f1-b6434a3ebff2"},{"name":"UPRN Find - Address String","event":[{"listen":"test","script":{"id":"2352c5b8-8def-4227-bbcd-3963cba8fa36","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","if (responseCode.code !== 200) return;","// continue with other tests","","// Store uprn","pm.collectionVariables.set(\"UPRN\", pm.response.json().addressInformation.uprn);"],"type":"text/javascript"}}],"id":"f50cebf6-83d2-49f1-a4b4-d2d191113c4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"addressString\": \"5A, Market Square, MK18 3AB\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/locationservices/v1/uprn/find","description":"What is a UPRN?
\nUPRN stands for Unique Property Reference Number and was created by the Ordnance Survey (OS). It consists of numbers of up to 12 digits in length.
\nUPRN Lookup
\nWe provide 2 mechanisms to lookup UPRNS. You can either provide an \"address string\" or an address line formatted address. The lookup will only return an exact singluar match and if multiple properties are found we will be required to provide additional information to unique identify the property.
\nOur return message includeds the property UPRN and the PAF formatted address for the property.
\n","urlObject":{"protocol":"https","path":["locationservices","v1","uprn","find"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"5315c780-0243-4dcf-9c7c-6de9aad7e34e","name":"URPN Find - Address String","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/xml","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressString\": \"5A, Market Square, MK18 3AB\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/locationservices/v1/uprn/find"},"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":"Thu, 09 Jul 2020 12:12:42 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"addressInformation\": {\n \"uprn\": \"000766247285\",\n \"address\": {\n \"organisationName\": \"\",\n \"departmentName\": \"\",\n \"poBox\": \"\",\n \"buildingName\": \"5A\",\n \"subBuildingName\": \"\",\n \"subBuilding\": \"\",\n \"buildingNumber\": \"\",\n \"thoroughfareName\": \"Market Square\",\n \"dependentThoroughfareName\": \"\",\n \"dependentLocality\": \"Winslow\",\n \"doubleDependentLocality\": \"\",\n \"postTown\": \"Buckingham\",\n \"postcode\": \"MK18 3AB\",\n \"county\": \"Buckinghamshire\",\n \"onsCountryCode\": \"E\"\n }\n }\n}"}],"_postman_id":"f50cebf6-83d2-49f1-a4b4-d2d191113c4e"},{"name":"UPRN Find - Formatted Address","event":[{"listen":"test","script":{"id":"8cce3e3f-34c9-476d-9325-c623c22f8520","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","if (responseCode.code !== 200) return;","// continue with other tests","","// Store uprn","pm.collectionVariables.set(\"UPRN\", pm.response.json().addressInformation.uprn);"],"type":"text/javascript"}}],"id":"0cd5fdac-0b35-4b98-9f19-2ab99bd15c3e","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 \"formattedAddress\": {\r\n \"addressLine1\": \"5a\",\r\n \"addressLine2\": \"Market Square\",\r\n \"addressLine3\": \"\",\r\n \"addressLine4\": \"\",\r\n \"postcode\": \"mk183ab\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/locationservices/v1/uprn/find","urlObject":{"protocol":"https","path":["locationservices","v1","uprn","find"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"42660795-61b5-4e06-8bde-5f152bfa75a7","name":"URPN Find - Formatted Address","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/xml","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"formattedAddress\": {\r\n \"addressLine1\": \"5a\",\r\n \"addressLine2\": \"Market Square\",\r\n \"addressLine3\": \"\",\r\n \"addressLine4\": \"\",\r\n \"postcode\": \"mk183ab\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/locationservices/v1/uprn/find"},"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":"Thu, 09 Jul 2020 12:12:31 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"addressInformation\": {\n \"uprn\": \"000766247285\",\n \"address\": {\n \"organisationName\": \"\",\n \"departmentName\": \"\",\n \"poBox\": \"\",\n \"buildingName\": \"5A\",\n \"subBuildingName\": \"\",\n \"subBuilding\": \"\",\n \"buildingNumber\": \"\",\n \"thoroughfareName\": \"Market Square\",\n \"dependentThoroughfareName\": \"\",\n \"dependentLocality\": \"Winslow\",\n \"doubleDependentLocality\": \"\",\n \"postTown\": \"Buckingham\",\n \"postcode\": \"MK18 3AB\",\n \"county\": \"Buckinghamshire\",\n \"onsCountryCode\": \"E\"\n }\n }\n}"}],"_postman_id":"0cd5fdac-0b35-4b98-9f19-2ab99bd15c3e"},{"name":"Location Information by UPRN","event":[{"listen":"test","script":{"id":"fc86f188-30da-403b-9ed0-cc005a6dd5a4","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","if (responseCode.code !== 200) return;","// continue with other tests","",""],"type":"text/javascript"}}],"id":"9617efd9-bce2-4883-981a-d25f7d0d9534","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://demo20.tmgroup.technology/locationservices/v1/uprn/:100031060071","description":"Location Information provides details of a property based on the UPRN. This includes data such as:
\nThe above example responses are included as part of the Postman collection and can be seen on the right.
\n","urlObject":{"protocol":"https","path":["locationservices","v1","uprn",":100031060071"],"host":["demo20","tmgroup","technology"],"query":[],"variable":[{"id":"4855ef68-6dc2-4886-b790-2f9e5de7213d","type":"string","value":"010004841678","key":"100031060071"}]}},"response":[{"id":"5075cdad-4e9d-44f1-9aef-abc33a400b1f","name":"UPRN - 000766247285","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","type":"text","disabled":true}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://demo20.tmgroup.technology/locationservices/v1/uprn/:100031060071","protocol":"https","host":["demo20","tmgroup","technology"],"path":["locationservices","v1","uprn",":100031060071"],"variable":[{"key":"100031060071","value":"000766247285"}]}},"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, 03 Apr 2020 10:45:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"locationInformation\": {\n \"address\": {\n \"organisationName\": \"\",\n \"departmentName\": \"\",\n \"poBox\": \"\",\n \"buildingName\": \"5A\",\n \"subBuildingName\": \"\",\n \"subBuilding\": \"\",\n \"buildingNumber\": \"\",\n \"thoroughfareName\": \"MARKET SQUARE\",\n \"dependentThoroughfareName\": \"\",\n \"dependentLocality\": \"WINSLOW\",\n \"doubleDependentLocality\": \"\",\n \"postTown\": \"BUCKINGHAM\",\n \"postcode\": \"MK18 3AB\",\n \"county\": \"BUCKINGHAMSHIRE\",\n \"onsCountryCode\": \"E\"\n },\n \"displayAddress\": \"5A,Market Square,Winslow,Buckingham,Buckinghamshire,MK18 3AB\",\n \"titles\": [\n {\n \"class\": \"Absolute freehold title \",\n \"tenure\": \"Freehold\",\n \"titleNumber\": \"BM228060\"\n }\n ],\n \"pqi\": {\n \"number\": 1,\n \"description\": \"Based on Property\"\n },\n \"waterAuthorityList\": [\n {\n \"name\": \"Anglian Water\",\n \"code\": \"AnglianWater\"\n }\n ],\n \"localAuthority\": {\n \"onsGeographyCode\": \"E07000004\",\n \"onsGeographyName\": \"Aylesbury Vale\"\n },\n \"easting\": 476951,\n \"northing\": 227538,\n \"gasDistributionList\": [\n {\n \"name\": \"Southern Gas Networks - South\",\n \"code\": \"SouthernGasNetworksSouth\"\n }\n ],\n \"electricDistributionList\": [\n {\n \"name\": \"Western Power Distribution (East Midlands)\",\n \"code\": \"WesternPowerDistributionEastMidlands\"\n }\n ]\n }\n}"},{"id":"865af8e4-bd52-419e-8ed4-683f743494ac","name":"UPRN - 010004841678","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","type":"text","disabled":true}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://demo20.tmgroup.technology/locationservices/v1/uprn/:100031060071","protocol":"https","host":["demo20","tmgroup","technology"],"path":["locationservices","v1","uprn",":100031060071"],"variable":[{"key":"100031060071","value":"010004841678"}]}},"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, 24 Mar 2020 09:17:37 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"locationInformation\": {\n \"address\": {\n \"organisationName\": \"T M PROPERTY SEARCHES LTD\",\n \"departmentName\": \"\",\n \"poBox\": \"\",\n \"buildingName\": \"UNIT 1200\",\n \"subBuildingName\": \"\",\n \"subBuilding\": \"\",\n \"buildingNumber\": \"\",\n \"thoroughfareName\": \"WELTON ROAD\",\n \"dependentThoroughfareName\": \"DELTA OFFICE PARK\",\n \"dependentLocality\": \"\",\n \"doubleDependentLocality\": \"\",\n \"postTown\": \"SWINDON\",\n \"postcode\": \"SN5 7XZ\",\n \"county\": \"WILTSHIRE\",\n \"onsCountryCode\": \"E\"\n },\n \"displayAddress\": \"T M Property Searches Ltd,Unit 1200,Delta Office Park,Welton Road,Swindon,Wiltshire,SN5 7XZ\",\n \"titles\": [],\n \"pqi\": {\n \"number\": 1,\n \"description\": \"Based on Property\"\n },\n \"waterAuthorityList\": [\n {\n \"name\": \"Thames Water\",\n \"code\": \"ThamesWater\"\n }\n ],\n \"localAuthority\": {\n \"onsGeographyCode\": \"E06000030\",\n \"onsGeographyName\": \"Swindon\"\n },\n \"easting\": 412887,\n \"northing\": 184624,\n \"gasDistributionList\": [\n {\n \"name\": \"Wales and West Utilities Ltd - South West\",\n \"code\": \"WalesAndWestUtilitiesSouthWest\"\n }\n ],\n \"electricDistributionList\": [\n {\n \"name\": \"SSE Power Distribution\",\n \"code\": \"SSEPowerDistribution\"\n }\n ]\n }\n}"},{"id":"94373e11-4a3b-4fd8-ba3b-876ed488b870","name":"UPRN - 100061912559","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","type":"text","disabled":true}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://demo20.tmgroup.technology/locationservices/v1/uprn/:100031060071","protocol":"https","host":["demo20","tmgroup","technology"],"path":["locationservices","v1","uprn",":100031060071"],"variable":[{"key":"100031060071","value":"100061912559"}]}},"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, 03 Apr 2020 10:44:31 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"locationInformation\": {\n \"address\": {\n \"organisationName\": \"\",\n \"departmentName\": \"\",\n \"poBox\": \"\",\n \"buildingName\": \"ALASTAIR COURT\",\n \"subBuildingName\": \"FLAT 1\",\n \"subBuilding\": \"FLAT 1\",\n \"buildingNumber\": \"30\",\n \"thoroughfareName\": \"COMPTON STREET\",\n \"dependentThoroughfareName\": \"\",\n \"dependentLocality\": \"\",\n \"doubleDependentLocality\": \"\",\n \"postTown\": \"EASTBOURNE\",\n \"postcode\": \"BN21 4EL\",\n \"county\": \"EAST SUSSEX\",\n \"onsCountryCode\": \"E\"\n },\n \"displayAddress\": \"Flat 1,Alastair Court,30,Compton Street,Eastbourne,East Sussex,BN21 4EL\",\n \"titles\": [\n {\n \"class\": \"Absolute freehold title \",\n \"tenure\": \"Freehold\",\n \"titleNumber\": \"EB1021\"\n },\n {\n \"class\": \"Absolute leasehold title\",\n \"tenure\": \"Leasehold\",\n \"titleNumber\": \"ESX394705\"\n }\n ],\n \"pqi\": {\n \"number\": 1,\n \"description\": \"Based on Property\"\n },\n \"waterAuthorityList\": [\n {\n \"name\": \"Southern Water\",\n \"code\": \"SouthernWater\"\n }\n ],\n \"localAuthority\": {\n \"onsGeographyCode\": \"E07000061\",\n \"onsGeographyName\": \"Eastbourne\"\n },\n \"easting\": 561030,\n \"northing\": 98135,\n \"gasDistributionList\": [\n {\n \"name\": \"Southern Gas Networks - South East\",\n \"code\": \"SouthernGasNetworksSouthEast\"\n }\n ],\n \"electricDistributionList\": [\n {\n \"name\": \"EDF Energy Networks\",\n \"code\": \"EDFEnergyNetworks\"\n }\n ]\n }\n}"}],"_postman_id":"9617efd9-bce2-4883-981a-d25f7d0d9534"}],"id":"e774cca4-1a87-4cb5-887f-8999a4f04030","description":"Swagger URL
\n\n","event":[{"listen":"prerequest","script":{"id":"c370e141-e834-48bf-abee-3cf259ba6f6d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aa5fed60-a22f-4830-842e-1a64828a152a","type":"text/javascript","exec":[""]}}],"_postman_id":"e774cca4-1a87-4cb5-887f-8999a4f04030"},{"name":"Land Registry Searches","item":[{"name":"Title Number Lookup","event":[{"listen":"test","script":{"id":"25891956-23cf-4106-b3bd-f8bd3c8126a2","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","if (responseCode.code !== 200) return;","// continue with other tests","","// Store project Id","pm.collectionVariables.set(\"projectId\", pm.response.json().projectId);","","// Store project Id","pm.collectionVariables.set(\"orderItemId\", pm.response.json().orderItemId);",""],"type":"text/javascript"}}],"id":"97d3a713-636a-4a6c-8606-09f81fd97104","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Generated_Token"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"projectDetails\": {\n \"propertyDetails\": {\n \"address\": {\n \"organisationName\": \"\",\n \"departmentName\": \"\",\n \"poBox\": \"\",\n \"buildingName\": \"\",\n \"subBuilding\": \"\",\n \"buildingNumber\": \"1\",\n \"thoroughfareName\": \"Pickett Avenue\",\n \"doubleDependentLocality\": \"\",\n \"dependentLocality\": \"\",\n \"postTown\": \"Oxford\",\n \"postcode\": \"OX3 8RS\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://demo20.tmgroup.technology/propertysearches/v1/TitleNumberLookup","description":"We have created the ability to query the Land Registry to get the Tile Number information for a given property in a synchronous method – which under normal system load will take less than 20 seconds.
\nOn our test/demo systems the following postcodes will return different types of responses.
\nIn the returned response the TenureType (shown as \"Estate\" in the response object) can have the following types:
\nReturns a synchronous response when ordering an OC1, containing both data and result files.
\nUnder normal system load will take less than 20 seconds.
\n\n\nThis only allows the ordering of backdated Register and/or Plan Copy.\n\"Certificate in form CI\" and requesting an \"On Completion\" of pending registrations are not able to be returned Synchronously, if you require either of these please order by our asynchronous ordering API
\n
These APIs provide direct access to Land Registry searches to provide additional information about a property.
\n","_postman_id":"41776fe7-c270-41dc-a268-31d0e299d937"}],"event":[{"listen":"prerequest","script":{"id":"e7af3222-2e89-4c42-9fa9-a75f32afc49b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"efbc161f-6f82-4cf8-ae12-9e4d3cd7251a","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"}]}