{"info":{"_postman_id":"86fca170-78db-47f6-ace3-3c61c6578208","name":"Postcodex.io - RESTful API Documentation","description":"<html><head></head><body><p>Professional Address Verification &amp; Lookup APIs for developers</p>\n<p>We provide professional APIs for address verification and discovery for developers and online retailers. For more info visit <a href=\"https://postcodex.io\">https://postcodex.io</a></p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1517985","collectionId":"86fca170-78db-47f6-ace3-3c61c6578208","publishedId":"2sBXqFLhAu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-04-21T10:36:58.000Z"},"item":[{"name":"uk-paf-postcodes","item":[{"name":"UK Address Lookup","id":"8eb7b79e-09a8-43ad-b030-73b6e784eb2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"{{key}}"},{"key":"value","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.postcodex.io/public/postcode/lookups?postcode=hr74qj&key=ptnUioRedyj1yuoPRq5eZ","description":"<p>This endpoint searches the Royal Mail PAF database of over 30m+ address and returns all matching addresses for the provided postcode. This database is updated daily.</p>\n","urlObject":{"path":["public","postcode","lookups"],"host":["https://api.postcodex.io"],"query":[{"description":{"content":"<p>(Required) The target postcode to lookup</p>\n","type":"text/plain"},"key":"postcode","value":"hr74qj"},{"key":"key","value":"ptnUioRedyj1yuoPRq5eZ"}],"variable":[]}},"response":[{"id":"18e7e69a-e46c-419c-9eaf-476e3048198d","name":"The collection of matching addresses for the provided postcode","originalRequest":{"method":"GET","header":[{"description":"API token from https://console.postcodex.io","key":"X-AUTH-TOKEN","value":"<API Key>"}],"url":{"raw":"https://api.postcodex.io/public/postcode/lookups?postcode=hr7 4qj","host":["https://api.postcodex.io"],"path":["public","postcode","lookups"],"query":[{"key":"postcode","value":"hr7 4qj"},{"key":"token","value":" 2hUpdUJyFr65GVOKFMM6Wj ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n  \"postcode\": \"HR7 4QJ\",\n  \"postTown\": \"LEOMINSTER\",\n  \"dependentLocality\": \"\",\n  \"doubleDependentLocality\": \"\",\n  \"thoroughfare\": \"Broad Street\",\n  \"dependentThoroughfare\": \"\",\n  \"buildingNumber\": \"14\",\n  \"buildingName\": \"\",\n  \"subBuildingName\": \"\",\n  \"poBox\": \"\",\n  \"departmentName\": \"\",\n  \"organisationName\": \"\",\n  \"udprn\": \"12345678\",\n  \"postcodeType\": \"S\",\n  \"suOrganisationIdentifier\": \"\",\n  \"deliveryPointSuffix\": \"1A\",\n  \"addressLine1\": \"14 Broad Street\",\n  \"addressLine2\": \"LEOMINSTER\",\n  \"addressLine3\": \"Herefordshire\",\n  \"addressLine4\": \"\",\n  \"addressDescription\": \"14 Broad Street, LEOMINSTER, HR7 4QJ\"\n },\n {\n  \"postcode\": \"HR7 4QJ\",\n  \"postTown\": \"LEOMINSTER\",\n  \"dependentLocality\": \"\",\n  \"doubleDependentLocality\": \"\",\n  \"thoroughfare\": \"Broad Street\",\n  \"dependentThoroughfare\": \"\",\n  \"buildingNumber\": \"16\",\n  \"buildingName\": \"\",\n  \"subBuildingName\": \"Flat 1\",\n  \"poBox\": \"\",\n  \"departmentName\": \"\",\n  \"organisationName\": \"Broad Street Dental Practice\",\n  \"udprn\": \"12345679\",\n  \"postcodeType\": \"S\",\n  \"suOrganisationIdentifier\": \"\",\n  \"deliveryPointSuffix\": \"2B\",\n  \"addressLine1\": \"Flat 1, 16 Broad Street\",\n  \"addressLine2\": \"LEOMINSTER\",\n  \"addressLine3\": \"Herefordshire\",\n  \"addressLine4\": \"\",\n  \"addressDescription\": \"Flat 1, 16 Broad Street, LEOMINSTER, HR7 4QJ\"\n }\n]"}],"_postman_id":"8eb7b79e-09a8-43ad-b030-73b6e784eb2c"},{"name":"Local Authority lookup","id":"dcc07696-dc69-40b7-9523-6c62da6d327c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-AUTH-TOKEN"},{"key":"value","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.postcodex.io/public/postcode/localauthority?postcode=HR7 4QJ","description":"<p>This endpoint will leverage the data from the new OS Codepoint data set to provide information on local authority, ward, county, area for a UK postcode. This endpoint take postcode as its only parameter and will return details from the codepoint dataset.</p>\n","urlObject":{"path":["public","postcode","localauthority"],"host":["https://api.postcodex.io"],"query":[{"description":{"content":"<p>(Required) The target postcode to lookup</p>\n","type":"text/plain"},"key":"postcode","value":"HR7 4QJ"}],"variable":[]}},"response":[{"id":"6a99ef37-a506-4c01-95a4-232b924d91cd","name":"Searching Local authority  details based on searched postcode","originalRequest":{"method":"GET","header":[{"description":"API token from https://console.postcodex.io","key":"X-AUTH-TOKEN","value":"<API Key>"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://dev-api.postcodex.io/public/postcode/localauthority?postcode=AL9 7DY","protocol":"https","host":["dev-api","postcodex","io"],"path":["public","postcode","localauthority"],"query":[{"key":"postcode","value":"AL9 7DY"},{"key":"token","value":" 2hUpdUJyFr65GVOKFMM6Wj ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"postcode\": \"AL9 7DY\",\n    \"positionQualityIndicator\": \"10\",\n    \"eastings\": \"523113\",\n    \"northings\": \"205496\",\n    \"countryCode\": \"E92000001\",\n    \"nhsRegionHaCode\": \"E19000001\",\n    \"nhsHaCode\": \"E18000006\",\n    \"adminCountyCode\": \"E10000015\",\n    \"adminDistrictCode\": \"E07000241\",\n    \"adminWardCode\": \"E05011071\",\n    \"countryName\": null,\n    \"nhsRegionHaName\": \"North, Midlands and the East Programme for IT (NMEPFiT)\",\n    \"nhsHaName\": \"East of England\",\n    \"adminCountyName\": \"Hertfordshire County\",\n    \"adminDistrictName\": \"Welwyn Hatfield District (B)\",\n    \"adminWardName\": \"Welham Green & Hatfield South Ward\"\n}"}],"_postman_id":"dcc07696-dc69-40b7-9523-6c62da6d327c"},{"name":"Quick postcode verification","id":"60e97c1f-bb50-4ac9-aa3d-c44be0d0dc82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-AUTH-TOKEN"},{"key":"value","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.postcodex.io/public/postcode/exists?postcode=HR7 4QJ","description":"<p>Check if the provided postcode is present in the database</p>\n","urlObject":{"path":["public","postcode","exists"],"host":["https://api.postcodex.io"],"query":[{"description":{"content":"<p>(Required) The target postcode to check</p>\n","type":"text/plain"},"key":"postcode","value":"HR7 4QJ"}],"variable":[]}},"response":[{"id":"d3e3811c-faff-4be2-a60e-abc03a6040a0","name":"A boolean field indicating if the postcode was found or not","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-AUTH-TOKEN","value":"<API Key>"}],"url":{"raw":"https://api.postcodex.io/public/postcode/exists?postcode=","host":["https://api.postcodex.io"],"path":["public","postcode","exists"],"query":[{"key":"postcode","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"exists\": true\n}"}],"_postman_id":"60e97c1f-bb50-4ac9-aa3d-c44be0d0dc82"},{"name":"Quick API token verification","id":"8675865d-e83a-42fe-b30c-11b09c262352","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-AUTH-TOKEN"},{"key":"value","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.postcodex.io/public/postcode/ready","description":"<p>This endpoint allows you to verify your API token is valid, useful if you have any scheduled commands in your application that check 3rd party API connectivity.</p>\n","urlObject":{"path":["public","postcode","ready"],"host":["https://api.postcodex.io"],"query":[],"variable":[]}},"response":[{"id":"6dbae182-1d37-45da-97ec-c0ffce2948e1","name":"A boolean field indicating if the token is valid","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-AUTH-TOKEN","value":"<API Key>"}],"url":"https://api.postcodex.io/public/postcode/ready"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ready\": false\n}"}],"_postman_id":"8675865d-e83a-42fe-b30c-11b09c262352"}],"id":"6bf92232-e2b2-466e-9114-81385f0b4f4c","_postman_id":"6bf92232-e2b2-466e-9114-81385f0b4f4c","description":""},{"name":"ireland-eircode","item":[{"name":"Eircode to DED Area","id":"760129ee-2bb6-48fe-beb6-59530c83472a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-AUTH-TOKEN"},{"key":"value","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.postcodex.io/public/eircode/ded?eircode=X91 RK75","description":"<p>This endpoint searches the Eircode official data set cross-refereced with with open government data to return the DED area that a given Eircode exists in.</p>\n","urlObject":{"path":["public","eircode","ded"],"host":["https://api.postcodex.io"],"query":[{"key":"eircode","value":"X91 RK75"}],"variable":[]}},"response":[],"_postman_id":"760129ee-2bb6-48fe-beb6-59530c83472a"},{"name":"Eircode Geocoding","id":"e54f4837-bc90-4c26-a391-3fe30008ef55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-AUTH-TOKEN"},{"key":"value","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.postcodex.io/public/eircode/geocodes?eircode=X91 RK75","description":"<p>This endpoint searches the Eircode official data set cross-refereced with with open government data to return the DED area that a given Eircode exists in.</p>\n","urlObject":{"path":["public","eircode","geocodes"],"host":["https://api.postcodex.io"],"query":[{"key":"eircode","value":"X91 RK75"}],"variable":[]}},"response":[],"_postman_id":"e54f4837-bc90-4c26-a391-3fe30008ef55"},{"name":"Eircode Exists","id":"0c7e374e-b1d0-4a03-818f-ef2b23182997","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-AUTH-TOKEN"},{"key":"value","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.postcodex.io/public/eircode/exists?eircode=P81 DC93","description":"<p>Verify that a given Eircode exists and is valid.</p>\n","urlObject":{"path":["public","eircode","exists"],"host":["https://api.postcodex.io"],"query":[{"key":"eircode","value":"P81 DC93"}],"variable":[]}},"response":[],"_postman_id":"0c7e374e-b1d0-4a03-818f-ef2b23182997"},{"name":"ROI Address Lookup","id":"7c4a2bac-690c-450f-adfd-433dee1143fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"{{key}}"},{"key":"value","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.postcodex.io/public/eircode/lookups?eircode=X91 RK75","description":"<p>This endpoint searches the Royal Mail PAF database of over 30m+ address and returns all matching addresses for the provided postcode. This database is updated daily.</p>\n","urlObject":{"path":["public","eircode","lookups"],"host":["https://api.postcodex.io"],"query":[{"key":"eircode","value":"X91 RK75"}],"variable":[]}},"response":[{"id":"e300bd5d-3d44-442b-818f-a909ae8c7e4e","name":"ROI Address Lookup","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.postcodex.io/public/eircode/lookups?eircode=X91 RK75","host":["https://api.postcodex.io"],"path":["public","eircode","lookups"],"query":[{"key":"eircode","value":"X91 RK75"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Nov 2022 14:55:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=O9zi8tMA5uZSoy%2F%2B9UNU3VkaZZtU9T1XEzxqMKQJ1nzSoNJFonQ1VuimylmCUsiQkNwZm1ETsFb9%2Fu3H5wLJvtsw0ESJueVxSHqJSquffsFxqSDYLN7MNYtDlbk0ify5s3N2GxVPnA%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"76b1119bdeda5da4-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n    \"eircode\": \"X91RK75\",\n    \"eircode_display\": \"X91 RK75\",\n    \"address_line_1\": \"THE GOLDEN FRY\",\n    \"address_line_2\": \"1 LOWER GRANGE\",\n    \"address_line_3\": \"WATERFORD\",\n    \"address_line_4\": \"X91 RK75\",\n    \"address_line_5\": \"\",\n    \"address_line_6\": \"\",\n    \"address_line_7\": \"\",\n    \"address_line_8\": \"\",\n    \"address_line_9\": \"\"\n}"}],"_postman_id":"7c4a2bac-690c-450f-adfd-433dee1143fe"}],"id":"1f53849a-6728-4e25-a26d-b51677e87128","_postman_id":"1f53849a-6728-4e25-a26d-b51677e87128","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"39dc0f84-2a93-413e-9110-6a4ed14b634e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"61ee5ebb-48cb-4e17-996a-04074fca32a7"}}],"variable":[{"key":"baseUrl","value":"https://api.postcodex.io"}]}