global-intuitive.postman_collection.json

{
	"info": {
		"_postman_id": "c3bd545d-8990-41d5-a61c-d53601762a2f",
		"name": "Global Intuitive",
		"description": "Fast and efficient global REST API for capturing validated addresses. Allows users to search and format their address in just a few keystrokes. ",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Search",
			"request": {
				"method": "GET",
				"header": [
					{
						"key": "Auth-Token",
						"value": "{{Auth-Token}}"
					}
				],
				"body": {
					"mode": "raw",
					"raw": ""
				},
				"url": {
					"raw": "https://api.edq.com/capture/address/v2/search?Auth-Token=<authentication token>&query=<search query>&country=<3 letter country ISO code>&take=<number of results>&location=<{latitude},{longitude}>&dataset=<dataset name>",
					"protocol": "https",
					"host": [
						"api",
						"edq",
						"com"
					],
					"path": [
						"capture",
						"address",
						"v2",
						"search"
					],
					"query": [
						{
							"key": "Auth-Token",
							"value": "<authentication token>",
							"description": "Your authentication token, which validates requests sent to the API."
						},
						{
							"key": "query",
							"value": "<search query>",
							"description": "Address to search on - the input from the user so far"
						},
						{
							"key": "country",
							"value": "<3 letter country ISO code>",
							"description": "Must be a licensed country. See documentation for full list of supported ISO codes."
						},
						{
							"key": "take",
							"value": "<number of results>",
							"description": "Optional parameter, default is 7."
						},
						{
							"key": "location",
							"value": "<{latitude},{longitude}>",
							"description": "Optional parameter. The latitude and longitude of the location where the address is situated."
						},
						{
							"key": "dataset",
							"value": "<dataset name>",
							"description": "Optional parameter. The name of the dataset to be used."
						}
					]
				},
				"description": "Search for an address. Returns an object containing suggested addresses based on the included parameters."
			},
			"response": [
				{
					"name": "Example Search",
					"originalRequest": {
						"method": "GET",
						"header": [
							{
								"key": "Auth-Token",
								"value": "a1b234c5-a1bc-1234-a1bc-123a4567891bc"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "https://api.edq.com/capture/address/v2/search?query=2-3 clapham common north side&country=gbr&take=7",
							"protocol": "https",
							"host": [
								"api",
								"edq",
								"com"
							],
							"path": [
								"capture",
								"address",
								"v2",
								"search"
							],
							"query": [
								{
									"key": "query",
									"value": "2-3 clapham common north side",
									"description": "Address to search on - the input from the user so far"
								},
								{
									"key": "country",
									"value": "gbr",
									"description": "Must be a licensed country. See documentation for full list of supported ISO codes."
								},
								{
									"key": "take",
									"value": "7",
									"description": "Optional parameter, default is 7."
								}
							]
						}
					},
					"status": "OK",
					"code": 200,
					"_postman_previewlanguage": "json",
					"header": [],
					"cookie": [],
					"body": "{\n    \"count\": 1,\n    \"results\": [\n        {\n            \"suggestion\": \"Experian Data Quality, George West House, 2-3 Clapham Common North Side, London, SW4 ...\",\n            \"matched\": [\n                [\n                    67,\n                    71\n                ],\n                [\n                    46,\n                    66\n                ],\n                [\n                    42,\n                    45\n                ]\n            ],\n            \"format\": \"https://api.edq.com/capture/address/v2/format?country=GBR&id=AVzAG9qw2CTc2aQaIiu4\"\n        }\n    ]\n}"
				}
			]
		},
		{
			"name": "Format",
			"request": {
				"method": "GET",
				"header": [
					{
						"key": "Auth-Token",
						"value": "{{Auth-Token}}"
					}
				],
				"body": {
					"mode": "raw",
					"raw": ""
				},
				"url": {
					"raw": "https://api.edq.com/capture/address/v2/format?country=<3 letter ISO country code>&id=<format ID>",
					"protocol": "https",
					"host": [
						"api",
						"edq",
						"com"
					],
					"path": [
						"capture",
						"address",
						"v2",
						"format"
					],
					"query": [
						{
							"key": "country",
							"value": "<3 letter ISO country code>",
							"description": "Must be a licensed country. See documentation for full list of supported ISO codes."
						},
						{
							"key": "id",
							"value": "<format ID>",
							"description": "ID is returned in the payload of the Search request. The full Format URL is returned, not just the ID."
						}
					]
				},
				"description": "Returns the full address and component breakdown for the chosen address."
			},
			"response": [
				{
					"name": "Format Example",
					"originalRequest": {
						"method": "GET",
						"header": [
							{
								"key": "Auth-Token",
								"value": "a1b234c5-a1bc-1234-a1bc-123a4567891bc"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "https://api.edq.com/capture/address/v2/format?country=gbr&id=AVzAG9qw2CTc2aQaIiu4",
							"protocol": "https",
							"host": [
								"api",
								"edq",
								"com"
							],
							"path": [
								"capture",
								"address",
								"v2",
								"format"
							],
							"query": [
								{
									"key": "country",
									"value": "gbr",
									"description": "Must be a licensed country. See documentation for full list of supported ISO codes."
								},
								{
									"key": "id",
									"value": "AVzAG9qw2CTc2aQaIiu4",
									"description": "ID is returned in the payload of the Search request. The full Format URL is returned, not just the ID."
								}
							]
						}
					},
					"status": "OK",
					"code": 200,
					"_postman_previewlanguage": "json",
					"header": [],
					"cookie": [],
					"body": "{\n    \"address\": [\n        {\n            \"addressLine1\": \"Experian Data Quality\"\n        },\n        {\n            \"addressLine2\": \"George West House\"\n        },\n        {\n            \"addressLine3\": \"2-3 Clapham Common North Side\"\n        },\n        {\n            \"locality\": \"LONDON\"\n        },\n        {\n            \"province\": \"\"\n        },\n        {\n            \"postalCode\": \"SW4 0QL\"\n        },\n        {\n            \"country\": \"UNITED KINGDOM\"\n        }\n    ],\n    \"components\": [\n        {\n            \"building1\": \"George West House\"\n        },\n        {\n            \"organisation1\": \"Experian Data Quality\"\n        },\n        {\n            \"streetNumber1\": \"2-3\"\n        },\n        {\n            \"street1\": \"Clapham Common North Side\"\n        },\n        {\n            \"locality1\": \"LONDON\"\n        },\n        {\n            \"postalCode1\": \"SW4 0QL\"\n        },\n        {\n            \"country1\": \"UNITED KINGDOM\"\n        },\n        {\n            \"countryISO1\": \"GBR\"\n        }\n    ]\n}"
				}
			]
		}
	]
}