DHL Autocomplete 2.0 Virtual Sandbox

Address completion and validation service for logistics and shipping applications.

Autocomplete 2.0 provides real-time address completion and validation services. It supports searching for buildings, cities, postal codes, and streets across multiple countries. Developers can integrate this to improve data accuracy in shipping forms and logistics workflows.

Use this hosted sandbox to simulate DHL Autocomplete 2.0 APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready. This keeps your integration code consistent across local development, QA, demos, and production.

Use cases:

Use this sandbox to verify address lookup logic, autocomplete response structures, multi-country search parameters, and error handling for invalid or partial address inputs before integrating with live DHL address services.

DHL Autocomplete 2.0 virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate DHL Autocomplete 2.0 responses instantly.

`https://dhl-autocomplete.mock.beeceptor.com`

Health

GET

/health-check

Returns statusCode 200 and a status message, if the application is up.

Request Payload

Response Payload

ad veniam

ATAddressData(6 operations)

GET

/search/at/buildings

This endpoint returns all the matching AT buildings for the given postal code/city/street/houseNumberShort/combined part.

Query Parameter Name	Example
`postal_code`	`cupidatat laboris`
`city`	`qui nostrud culpa`
`street`	`nulla nostrud`
`house_number_short`	`qui sunt`
`combined`	`sunt`

Request Payload

Response Payload

{
  "atBuildings": [
    {
      "city": "New Orleans",
      "district": "Crawford County",
      "houseNumber": "392",
      "houseNumberShort": "7",
      "postalCode": "67485",
      "state": "Nevada",
      "street": "Madonna Ranch",
      "streetShort": "RhePF",
      "uuid": "8a7cd450-8b42-4ca8-9aa6-28f5a38e888c"
    },
    {
      "city": "Apex",
      "district": "Crawford County",
      "houseNumber": "87736",
      "houseNumberShort": "0",
      "postalCode": "41062-3257",
      "state": "New Mexico",
      "street": "Sabryna Valleys",
      "streetShort": "nFGOq",
      "uuid": "07e6e451-4886-4ddb-9a45-211f88bda3fd"
    },
    {
      "city": "North Jenningston",
      "district": "Leicestershire",
      "houseNumber": "734",
      "houseNumberShort": "0",
      "postalCode": "05881-8546",
      "state": "California",
      "street": "Ash Road",
      "streetShort": "ISQHm",
      "uuid": "c3b7dd3a-c6f4-4541-aa65-627764edf760"
    },
    {
      "city": "Walterbury",
      "district": "Merseyside",
      "houseNumber": "46816",
      "houseNumberShort": "6",
      "postalCode": "03822",
      "state": "New Jersey",
      "street": "S Main Avenue",
      "streetShort": "VVEOa",
      "uuid": "2470534a-3320-46d8-8a6d-a899564ae4c2"
    },
    {
      "city": "Isabelside",
      "district": "Marshall County",
      "houseNumber": "3770",
      "houseNumberShort": "4",
      "postalCode": "67233-2726",
      "state": "Missouri",
      "street": "Roob Groves",
      "streetShort": "eSSlz",
      "uuid": "491185cf-9d53-4511-a40d-093e1a1d590b"
    }
  ],
  "numFound": 102
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 407
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 503
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 506
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 507
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 418
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 411
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 507
}

GET

/search/at/cities

This endpoint returns all the matching AT cities for the given city part.

Query Parameter Name	Example
`city`*	`proident tempor quis velit`

Request Payload

Response Payload

{
  "atStreetcodes": [
    {
      "city": "Daveland",
      "district": "Warren County",
      "postalCode": "36505",
      "state": "Idaho",
      "street": "Albion Street",
      "streetShort": "qquuN",
      "uuid": "11170690-8980-4d0e-884e-b4ebd97de22c"
    }
  ],
  "numFound": 223
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 504
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 424
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 504
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 504
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 421
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 506
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 506
}

GET

/search/at/postalcodes

This endpoint returns all the matching AT postal codes for the given postal code part.

Query Parameter Name	Example
`postal_code`*	`nisi in Lorem`

Request Payload

Response Payload

{
  "atStreetcodes": [
    {
      "city": "Port Freda",
      "district": "Warren County",
      "postalCode": "12039-0441",
      "state": "North Carolina",
      "street": "Cremin Trail",
      "streetShort": "uDaay",
      "uuid": "0dcbe841-9c16-42f5-99e1-4ab67df07d5d"
    }
  ],
  "numFound": 477
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 405
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 510
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 501
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 431
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 429
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 504
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 429
}

GET

/search/at/postalcodes_cities

This endpoint returns all the matching AT postal code and city combinations for the given postal code/city/combined part.

Query Parameter Name	Example
`postal_code`	`adipisicing anim aute`
`city`	`velit proident amet officia`
`combined`	`pariatur`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "Fort Paulinefurt",
      "district": "County Tyrone",
      "postalCode": "20984-1102",
      "street": "Watery Lane",
      "uuid": "366cf1d3-27e2-4020-943b-0ac7fe688020"
    },
    {
      "addressType": "Office",
      "city": "New Estherton",
      "district": "Carroll County",
      "postalCode": "94816-8904",
      "street": "Wehner Bypass",
      "uuid": "8a2b21e7-ea84-4e84-a999-18efc3b9f241"
    },
    {
      "addressType": "Office",
      "city": "North Germaineshire",
      "district": "Wiltshire",
      "postalCode": "42263-1910",
      "street": "Brook Lane",
      "uuid": "82daa080-8c24-4076-abb0-319ef9e20d4a"
    },
    {
      "addressType": "Commercial",
      "city": "Loriberg",
      "district": "Oxfordshire",
      "postalCode": "88804",
      "street": "Ada Burgs",
      "uuid": "73dac0dc-2b83-4ba6-afed-a03bbf4e6aa6"
    },
    {
      "addressType": "Residential",
      "city": "Kuhnfurt",
      "district": "Cleveland",
      "postalCode": "28862-0974",
      "street": "Russel Tunnel",
      "uuid": "2b64e867-fab3-458b-a6a5-5d08da58e982"
    }
  ],
  "numFound": 987
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 505
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 507
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 406
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 507
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 508
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 403
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 428
}

GET

/search/at/postalcodes_cities_streets

This endpoint returns all the matching AT postal code, city and street combinations for the given postal code/city/street/combined part.

Query Parameter Name	Example
`postal_code`	`eiusmod sint`
`city`	`irure officia`
`street`	`exercitation non dolore`
`combined`	`ut`

Request Payload

Response Payload

{
  "atStreetcodes": [
    {
      "city": "Pleasanton",
      "district": "East Sussex",
      "postalCode": "55701-8302",
      "state": "Maryland",
      "street": "Gloucester Road",
      "streetShort": "Lguvl",
      "uuid": "c00225f0-f9c1-45d1-afd6-e884441ac808"
    }
  ],
  "numFound": 600
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 400
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 502
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 405
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 414
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 411
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 505
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 510
}

GET

/search/at/streets

This endpoint returns all the matching AT streets for the given street part.

Query Parameter Name	Example
`street`*	`culpa mollit dolor voluptate aliquip`

Request Payload

Response Payload

{
  "atStreetcodes": [
    {
      "city": "Padbergshire",
      "district": "Lancashire",
      "postalCode": "76338-0673",
      "state": "Missouri",
      "street": "Schuster Cliff",
      "streetShort": "mleof",
      "uuid": "c1ee60e2-9ac3-4fcc-ba03-ef46cc5f749a"
    },
    {
      "city": "Fort Shannonshire",
      "district": "Jefferson County",
      "postalCode": "48778-2764",
      "state": "South Dakota",
      "street": "St Mary's Close",
      "streetShort": "OYyWg",
      "uuid": "833b0c93-8a2f-4ddd-b23b-fcc699140e44"
    }
  ],
  "numFound": 580
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 505
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 410
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 412
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 401
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 421
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 500
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 409
}

CHAddressData(12 operations)

GET

/search/ch/buildings

This endpoint returns all the matching CH buildings for the given postal code/city/street/houseNumber/combined part.

Query Parameter Name	Example
`postal_code`	`quis dolor proident`
`city`	`incididunt pariatur`
`street`	`nulla consectetur commodo Excepteur sit`
`house_number`	`pariatur culpa esse cupidatat Ut`
`combined`	`nisi`

Request Payload

Response Payload

{
  "chBuildings": [
    {
      "canton": "BE",
      "city": "Mayerland",
      "houseKey": "kRw8riEJ",
      "houseNumber": "707",
      "languageCode": "rm",
      "municipality": "Greenfeldertown",
      "postalCode": "60421-3387",
      "street": "Oren Cove",
      "uuid": "0cccfaa8-5202-49a8-b62b-7760814b394b"
    },
    {
      "canton": "ZH",
      "city": "Pinellas Park",
      "houseKey": "AlBg03Zs",
      "houseNumber": "9870",
      "languageCode": "rm",
      "municipality": "Karlstead",
      "postalCode": "15934",
      "street": "Karlee Shoals",
      "uuid": "80d3cae4-dd1b-445b-aab3-95f4b8eedd2c"
    },
    {
      "canton": "BE",
      "city": "North Johnnystad",
      "houseKey": "SEz2y9L0",
      "houseNumber": "969",
      "languageCode": "fr",
      "municipality": "Lake Kayleystead",
      "postalCode": "77051-7486",
      "street": "Gustave Well",
      "uuid": "6ea37eea-4cf5-4f50-b019-0e696155f00b"
    },
    {
      "canton": "GE",
      "city": "Javonmouth",
      "houseKey": "guAmOLO7",
      "houseNumber": "632",
      "languageCode": "fr",
      "municipality": "Kristinaburgh",
      "postalCode": "56771",
      "street": "Meadow Lane",
      "uuid": "4f8255ca-a142-4a76-bf87-50c69ce555dc"
    },
    {
      "canton": "SG",
      "city": "Port Donavonburgh",
      "houseKey": "4SJrV9EQ",
      "houseNumber": "58313",
      "languageCode": "rm",
      "municipality": "East Clarissa",
      "postalCode": "29821-2178",
      "street": "Rohan Ridge",
      "uuid": "1f38c80a-4751-4d93-9f3d-e68284804493"
    }
  ],
  "numFound": 903
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 411
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 408
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 400
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 502
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 508
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 402
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 405
}

GET

/search/ch/cities

This endpoint returns all the matching CH cities for the given city part.

Query Parameter Name	Example
`city`*	`in amet`

Request Payload

Response Payload

{
  "chStreetcodes": [
    {
      "canton": "VD",
      "city": "Battle Creek",
      "languageCode": "de",
      "municipality": "Weissnatport",
      "postalCode": "89960",
      "street": "Union Avenue",
      "uuid": "82e361b9-5147-43b0-8e28-0e80266e844b"
    },
    {
      "canton": "ZH",
      "city": "West Nevaville",
      "languageCode": "fr",
      "municipality": "Lake Madelynnshire",
      "postalCode": "50122-9768",
      "street": "Quigley Trafficway",
      "uuid": "ba9408e8-7713-4937-97a2-602415206b0a"
    }
  ],
  "numFound": 279
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 401
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 423
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 415
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 501
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 502
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 502
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 507
}

GET

/search/ch/postalcodes

This endpoint returns all the matching CH postal codes for the given postal code part.

Query Parameter Name	Example
`postal_code`*	`pariatur`

Request Payload

Response Payload

{
  "chStreetcodes": [
    {
      "canton": "SG",
      "city": "Loycester",
      "languageCode": "it",
      "municipality": "Hilpertchester",
      "postalCode": "38898-5810",
      "street": "Purdy Expressway",
      "uuid": "c18f1f96-7bc2-4862-8962-f26b31d445ef"
    },
    {
      "canton": "ZH",
      "city": "Lowellboro",
      "languageCode": "rm",
      "municipality": "Fort Chasestead",
      "postalCode": "05916-8536",
      "street": "Chestnut Drive",
      "uuid": "71e7a115-af4a-415d-9616-fb6f56564842"
    }
  ],
  "numFound": 668
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 428
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 501
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 413
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 406
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 401
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 404
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 508
}

GET

/search/ch/postalcodes_cities

This endpoint returns all the matching CH postal code and city combinations for the given postal code/city/combined part.

Query Parameter Name	Example
`postal_code`	`Excepteur mollit aliqua in`
`city`	`irure pariatur ipsum`
`combined`	`nisi est eiusmod`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "Pfannerstillfurt",
      "district": "Hancock County",
      "postalCode": "96425",
      "street": "Kovacek Via",
      "uuid": "9f031f18-29b2-46d2-b3e7-cc0244ef7321"
    },
    {
      "addressType": "Office",
      "city": "Goyetteboro",
      "district": "East Sussex",
      "postalCode": "30003",
      "street": "Batz Spring",
      "uuid": "9fcab0ea-1c0d-4ab0-b0b5-58dd2525c630"
    },
    {
      "addressType": "Commercial",
      "city": "Jakubowskihaven",
      "district": "Kent",
      "postalCode": "93381-2874",
      "street": "Mill Close",
      "uuid": "798e419b-b672-4bf4-9209-c9b9a84d2265"
    },
    {
      "addressType": "Residential",
      "city": "South Frederiqueton",
      "district": "Lee County",
      "postalCode": "32803",
      "street": "Beech Grove",
      "uuid": "f27ad252-1bb3-4eed-978f-6a972f1874f8"
    },
    {
      "addressType": "Residential",
      "city": "Aaronstead",
      "district": "Union County",
      "postalCode": "26818-4248",
      "street": "Wintheiser Knoll",
      "uuid": "83949e58-b7d7-4c07-970e-5ab2e2c4c9fd"
    }
  ],
  "numFound": 315
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 508
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 422
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 506
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 410
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 504
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 503
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 506
}

GET

/search/ch/postalcodes_cities_streets

This endpoint returns all the matching CH postal code, city and street combinations for the given postal code/city/street/combined part.

Query Parameter Name	Example
`postal_code`	`minim anim`
`city`	`sed aliqua incididunt cillum`
`street`	`ut`
`combined`	`consectetur velit ullamco`

Request Payload

Response Payload

{
  "chStreetcodes": [
    {
      "canton": "ZH",
      "city": "Aaronhaven",
      "languageCode": "de",
      "municipality": "Chico",
      "postalCode": "99718-7106",
      "street": "E Jackson Street",
      "uuid": "a36e2c59-da6f-4011-a842-0ff414fced10"
    },
    {
      "canton": "ZH",
      "city": "Markshaven",
      "languageCode": "it",
      "municipality": "Keaganshire",
      "postalCode": "07388",
      "street": "Oscar Terrace",
      "uuid": "681ca2c8-0e1c-4e6c-95d0-221a9c3310ca"
    }
  ],
  "numFound": 954
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "errorStatusCode": 409
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 412
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 418
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 418
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 504
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 506
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 416
}

GET

/search/ch/streets

This endpoint returns all the matching CH streets for the given street part.

Query Parameter Name	Example
`street`*	`aute est pariatur velit`

Request Payload

Response Payload

{
  "chStreetcodes": [
    {
      "canton": "GE",
      "city": "Princeberg",
      "languageCode": "de",
      "municipality": "East Keenanfield",
      "postalCode": "18180-4752",
      "street": "Bogisich Divide",
      "uuid": "244c544d-86fd-465c-9678-7fd185c959dd"
    },
    {
      "canton": "VD",
      "city": "Adelemouth",
      "languageCode": "rm",
      "municipality": "South Joanieburgh",
      "postalCode": "85554",
      "street": "Freddy Summit",
      "uuid": "d13a7a2f-6191-4024-a338-e71e21d37bef"
    },
    {
      "canton": "ZH",
      "city": "Pawtucket",
      "languageCode": "it",
      "municipality": "Flatleyboro",
      "postalCode": "77300",
      "street": "Lincoln Highway",
      "uuid": "e6007dbf-af01-4ec2-b85e-7af21576fe54"
    }
  ],
  "numFound": 572
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 502
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 507
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 506
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 412
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 511
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 510
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 504
}

GET

/select/ch/buildings

This endpoint logs the selected CH building for the given uuid.

Query Parameter Name	Example
`uuid`*	`ut sed eu`
`postal_code`	`aute eiusmod`
`city`	`est reprehenderit eiusmod pariatur`
`street`	`adipisicing sit cupidatat`
`house_number`	`sint anim laborum magna do`
`combined`	`cillum dolore sed dolor`

Request Payload

Response Payload

enim sit

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 406
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 505
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 407
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 412
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 418
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 414
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 408
}

GET

/select/ch/cities

This endpoint logs the selected CH city for the given uuid.

Query Parameter Name	Example
`uuid`*	`minim id in ut`
`city`	`laborum`

Request Payload

Response Payload

cillum aliqua nisi enim

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 508
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 423
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 506
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 506
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 423
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 501
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 409
}

GET

/select/ch/postalcodes

This endpoint logs the selected CH postal code for the given uuid.

Query Parameter Name	Example
`uuid`*	`irure deserunt ex`
`postal_code`	`non in voluptate`

Request Payload

Response Payload

et

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 410
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 412
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 502
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 425
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 510
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "errorStatusCode": 408
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "errorStatusCode": 503
}

GET

/select/ch/postalcodes_cities

This endpoint logs the selected CH postal code/city for the given uuid.

Query Parameter Name	Example
`uuid`*	`deserunt qui amet`
`postal_code`	`consectetur esse`
`city`	`anim`
`combined`	`id`

Request Payload

Response Payload

velit

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 407
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 506
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 503
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 502
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 428
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 412
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 418
}

GET

/select/ch/postalcodes_cities_streets

This endpoint logs the selected CH postal code, city and street for the given uuid.

Query Parameter Name	Example
`uuid`*	`minim`
`postal_code`	`dolor aliquip`
`city`	`in`
`street`	`aute fugiat do quis`
`combined`	`tempor`

Request Payload

Response Payload

sit et do

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 424
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 500
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 504
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 426
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 409
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "errorStatusCode": 501
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 508
}

GET

/select/ch/streets

This endpoint logs the selected CH street for the given uuid.

Query Parameter Name	Example
`uuid`*	`sit sed dolore`
`street`	`tempor`

Request Payload

Response Payload

ut

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 413
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 505
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 422
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 511
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 451
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 506
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 511
}

Buildings(2 operations)

GET

/search/de/buildings

This endpoint returns all the matching buildings for the given postal code/city/district/street/houseNumber/distributionCode/combined part.

Query Parameter Name	Example
`postal_code`	`voluptate`
`city`	`proident anim`
`district`	`amet voluptate non`
`street`	`ea nostrud et cupidatat labore`
`house_number`	`aute sed do ea`
`distribution_code`	`irure incididunt`
`combined`	`eu nulla`

Request Payload

Response Payload

{
  "buildings": [
    {
      "city": "New Linda",
      "distributionCode": "2710",
      "district": "Wayne County",
      "houseNumber": "449",
      "postalCode": "55814-2763",
      "street": "Howell Cove",
      "uuid": "e88677d2-c3b2-40be-8949-b9fb8b28b7be"
    }
  ],
  "numFound": 251
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 407
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 510
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 404
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 407
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 503
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 406
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 424
}

GET

/select/de/buildings

This endpoint logs the selected building for the given uuid.

Query Parameter Name	Example
`uuid`*	`proident aliqua`
`postal_code`	`aliquip consequat anim reprehenderit`
`city`	`magna reprehenderit`
`district`	`Excepteur amet commodo`
`street`	`ad proident officia`
`house_number`	`velit sint dolor`
`distribution_code`	`in pariatur commodo`
`combined`	`fugiat cupidatat officia`

Request Payload

Response Payload

dolor

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 418
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 502
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 503
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "errorStatusCode": 402
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 424
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 508
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 511
}

Bulk Recipients(2 operations)

GET

/search/de/bulkrecipients

This endpoint returns all the matching bulk recipients for the given bulk recipient name/postal code/city part.

Query Parameter Name	Example
`bulk_recipient_name`	`magna ipsum`
`postal_code`	`ullamco occaecat nulla exercitation ad`
`city`	`aliqua esse ullamco`

Request Payload

Response Payload

{
  "bulkrecipients": [
    {
      "bulkRecipientName": "DuBuque, Davis and Mosciski",
      "city": "Lake Desiree",
      "postalCode": "66908",
      "street": "Kihn Lights",
      "uuid": "655e1eac-a76e-4214-a8fe-2c7698da3acf"
    },
    {
      "bulkRecipientName": "Wuckert Group",
      "city": "Lewisville",
      "postalCode": "71470",
      "street": "N Main Avenue",
      "uuid": "484ea5ea-f89c-43c1-8f4e-6b367ffedd94"
    }
  ],
  "numFound": 613
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 422
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 417
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 510
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "errorStatusCode": 503
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 429
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 503
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 506
}

GET

/select/de/bulkrecipients

This endpoint logs the selected bulk recipient for the given uuid.

Query Parameter Name	Example
`uuid`*	`dolore veniam ullamco eu`
`bulk_recipient_name`	`Ut id elit`
`postal_code`	`fugiat laborum`
`city`	`do veniam officia commodo`
`street`	`nisi`

Request Payload

Response Payload

mollit

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 511
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 405
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 426
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 501
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 511
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 412
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 401
}

Streetcodes(16 operations)

GET

/search/de/cities

This endpoint returns all the matching cities for the given city part.

Query Parameter Name	Example
`city`*	`laborum labore do laboris`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "Port Lazaro",
      "district": "Polk County",
      "postalCode": "02395-9447",
      "street": "Josiane Bridge",
      "uuid": "f0f5bbc6-56af-4d77-b2be-7685ee24c0e9"
    },
    {
      "addressType": "Residential",
      "city": "Dustintown",
      "district": "Suffolk",
      "postalCode": "33814",
      "street": "Railroad Avenue",
      "uuid": "c85cbce7-32e5-4f97-8b45-6b9bd7f90f16"
    },
    {
      "addressType": "Residential",
      "city": "Port Karianeboro",
      "district": "Fayette County",
      "postalCode": "69670-9771",
      "street": "Hettinger Throughway",
      "uuid": "d77c25b9-922f-4fce-a137-bbb1c6ba6b27"
    },
    {
      "addressType": "Office",
      "city": "New Andreannemouth",
      "district": "Franklin County",
      "postalCode": "62358-5948",
      "street": "Washington Street",
      "uuid": "255ad8f3-258d-49aa-afe1-f582ec1be79b"
    },
    {
      "addressType": "Commercial",
      "city": "Maeganstead",
      "district": "Lancashire",
      "postalCode": "09411",
      "street": "Judah Prairie",
      "uuid": "6f7e5278-28b1-4c36-8ee1-d3ab2ae62dcb"
    }
  ],
  "numFound": 741
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 508
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 451
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 511
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 507
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "errorStatusCode": 505
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 424
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 409
}

GET

/search/de/districts

This endpoint returns all the matching districts for the given district part.

Query Parameter Name	Example
`district`*	`proident`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Residential",
      "city": "Hartmannworth",
      "district": "Lincoln County",
      "postalCode": "08066",
      "street": "Wilderman Freeway",
      "uuid": "ad0080f3-0f7a-4b6c-ad8b-6da579c59eac"
    },
    {
      "addressType": "Office",
      "city": "Jacquesboro",
      "district": "County Londonderry",
      "postalCode": "70093-3289",
      "street": "Lake Road",
      "uuid": "0981c963-5cb0-46e5-a261-84be254b1298"
    },
    {
      "addressType": "Residential",
      "city": "Mayerhaven",
      "district": "West Midlands",
      "postalCode": "77831",
      "street": "Nolan Ports",
      "uuid": "7d1740a3-3741-488d-b787-ba761de6873c"
    },
    {
      "addressType": "Office",
      "city": "Port Janaland",
      "district": "County Antrim",
      "postalCode": "29509-7365",
      "street": "Russell Street",
      "uuid": "e497a0ff-8cbf-4c88-8ddc-dd029df1a887"
    },
    {
      "addressType": "Residential",
      "city": "Cedar Park",
      "district": "East Sussex",
      "postalCode": "70147-9371",
      "street": "Gibson Locks",
      "uuid": "554a59a0-56dc-470e-8a29-c6f8c507b015"
    }
  ],
  "numFound": 319
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 511
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 400
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 428
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 405
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 501
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 510
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 410
}

GET

/search/de/postalcodes

This endpoint returns all the matching postal codes for the given postal code part.

Query Parameter Name	Example
`postal_code`*	`adipisicing Ut veniam`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "South Aldenfurt",
      "district": "West Midlands",
      "postalCode": "89324",
      "street": "Pearl Street",
      "uuid": "d4f26581-7299-4bbd-8479-2b19a151f927"
    },
    {
      "addressType": "Commercial",
      "city": "Codyfield",
      "district": "Surrey",
      "postalCode": "07758-9148",
      "street": "Veterans Memorial Drive",
      "uuid": "680e67d1-05ed-49ec-a7ea-afebc3b0b616"
    },
    {
      "addressType": "Residential",
      "city": "Dawsonworth",
      "district": "Carroll County",
      "postalCode": "03712-2338",
      "street": "N Front Street",
      "uuid": "db5d4e5c-d474-4a1a-acd2-fc866825ec37"
    },
    {
      "addressType": "Residential",
      "city": "Ricestad",
      "district": "Northamptonshire",
      "postalCode": "97286",
      "street": "Altenwerth Run",
      "uuid": "7fb03c25-6365-42e6-8bc5-c5ee033d4d65"
    }
  ],
  "numFound": 661
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 426
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 504
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 416
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 417
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 508
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 401
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 409
}

GET

/search/de/postalcodes_cities

This endpoint returns all the matching postal code and city combinations for the given postal code/city/combined part.

Query Parameter Name	Example
`postal_code`	`aliqua adipisicing Ut quis do`
`city`	`laboris tempor cillum`
`combined`	`veniam dolore exercitation eu in`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "New Ansley",
      "district": "Clay County",
      "postalCode": "55972",
      "street": "3rd Street",
      "uuid": "951bff83-c251-42b9-821d-599dfe60bd44"
    },
    {
      "addressType": "Commercial",
      "city": "Mertzshire",
      "district": "Grampian",
      "postalCode": "76550",
      "street": "Ullrich Dale",
      "uuid": "3d5341b6-5bdf-4395-b800-a0955f589d9f"
    }
  ],
  "numFound": 184
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 501
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 429
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 409
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 429
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 505
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 508
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 506
}

GET

/search/de/postalcodes_cities_districts

This endpoint returns all the matching postal code, city and district combinations for the given postal code/city/district/combined part.

Query Parameter Name	Example
`postal_code`	`nulla aute cupidatat nostrud non`
`city`	`sunt Excepteur nisi sit ut`
`district`	`aute ex eu occaecat proident`
`combined`	`in`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Residential",
      "city": "Cathedral City",
      "district": "Rutland",
      "postalCode": "80422-9674",
      "street": "S Franklin Street",
      "uuid": "acae5113-d85b-4338-8148-c3b27dd90efb"
    },
    {
      "addressType": "Commercial",
      "city": "Fort Rasheedborough",
      "district": "Polk County",
      "postalCode": "34794-9290",
      "street": "Victor Gardens",
      "uuid": "34354465-4a1b-497f-be52-0c6e249a5f65"
    },
    {
      "addressType": "Residential",
      "city": "Council Bluffs",
      "district": "Gwent",
      "postalCode": "27693-9257",
      "street": "N Maple Street",
      "uuid": "1f36909c-31e3-46ff-884c-fc1824e6b15e"
    },
    {
      "addressType": "Office",
      "city": "West Jovanhaven",
      "district": "County Londonderry",
      "postalCode": "69504-4546",
      "street": "Brigitte Crossing",
      "uuid": "dcd82c9b-01d8-4ef5-bd0c-ebbe4651928c"
    }
  ],
  "numFound": 849
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 429
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 428
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 415
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 418
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 407
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 505
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 507
}

GET

/search/de/postalcodes_cities_districts_streets

This endpoint returns all the matching postal code, city, district and street combinations for the given postal code/city/district/street/combined part.

Query Parameter Name	Example
`postal_code`	`do est sit deserunt laboris`
`city`	`amet`
`district`	`et in eu`
`street`	`enim Ut sint`
`address_type`	`qui dolore`
`combined`	`velit veniam aliquip minim laboris`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "Long Beach",
      "district": "Grampian",
      "postalCode": "26362",
      "street": "Heidenreich Village",
      "uuid": "57c33617-c750-496b-a46b-3b1a376e2107"
    },
    {
      "addressType": "Commercial",
      "city": "Ethelynworth",
      "district": "Leicestershire",
      "postalCode": "98916",
      "street": "Rubie Lights",
      "uuid": "2f7be6a4-5ea3-4d45-a8fb-ba542b882745"
    },
    {
      "addressType": "Office",
      "city": "West Valerie",
      "district": "West Sussex",
      "postalCode": "20996-7202",
      "street": "Watsica Harbor",
      "uuid": "4cc17146-512b-492c-9909-32de40821b4c"
    }
  ],
  "numFound": 539
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 500
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 510
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 503
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 504
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 421
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 506
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 428
}

GET

/search/de/postalcodes_cities_streets

This endpoint returns all the matching postal code, city and street combinations for the given postal code/city/street/combined part.

Query Parameter Name	Example
`postal_code`	`Lorem mollit consequat`
`city`	`laborum ex esse id dolor`
`street`	`exercitation officia`
`address_type`	`ipsum in ullamco Excepteur mollit`
`combined`	`dolor ut`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Commercial",
      "city": "Cape Coral",
      "district": "East Sussex",
      "postalCode": "95850",
      "street": "Garden Close",
      "uuid": "6c120ae8-20e4-4688-8e86-00c134e942a3"
    },
    {
      "addressType": "Residential",
      "city": "North Graham",
      "district": "County Tyrone",
      "postalCode": "52817",
      "street": "Luisa Groves",
      "uuid": "4391f6dd-d9c8-47c5-a6e2-cd65da46d75b"
    },
    {
      "addressType": "Residential",
      "city": "Tyler",
      "district": "Union County",
      "postalCode": "81291",
      "street": "Eleonore Hills",
      "uuid": "f4897593-7078-4963-a1bd-166771fc2a61"
    },
    {
      "addressType": "Office",
      "city": "Compton",
      "district": "Borders",
      "postalCode": "40175-0435",
      "street": "Keeling Ways",
      "uuid": "8cbe3b43-c566-442c-b558-67c1add59d0b"
    },
    {
      "addressType": "Commercial",
      "city": "Fort Amie",
      "district": "Leicestershire",
      "postalCode": "40094",
      "street": "Cale Extensions",
      "uuid": "e73b978d-6a16-4abf-a671-b9ec981dd9d4"
    }
  ],
  "numFound": 533
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 510
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 503
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 423
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 501
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 510
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 505
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 407
}

GET

/search/de/streets

This endpoint returns all the matching streets for the given street part.

Query Parameter Name	Example
`street`*	`consequat dolor elit cillum`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "South Ashleighburgh",
      "district": "Oxfordshire",
      "postalCode": "62568-2345",
      "street": "Kale Mills",
      "uuid": "8b94a863-7fe7-4f6a-bb4f-42c1be646e82"
    },
    {
      "addressType": "Commercial",
      "city": "North Else",
      "district": "Borders",
      "postalCode": "58198",
      "street": "Barton River",
      "uuid": "1d5f8ebc-f7c1-4a61-a8b2-71f3572870f4"
    },
    {
      "addressType": "Office",
      "city": "Lake Havasu City",
      "district": "Powys",
      "postalCode": "77810",
      "street": "Orchard Drive",
      "uuid": "6e17a5ae-9137-468a-a70f-4d538058703c"
    },
    {
      "addressType": "Office",
      "city": "Columbuston",
      "district": "Leicestershire",
      "postalCode": "43552-5056",
      "street": "The Mount",
      "uuid": "64dcaad6-32e4-4227-9bab-28606463f208"
    },
    {
      "addressType": "Residential",
      "city": "Newport News",
      "district": "Warren County",
      "postalCode": "59622",
      "street": "E Maple Street",
      "uuid": "91579cce-e497-4ec4-85e8-3b80f9340e6d"
    }
  ],
  "numFound": 995
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 507
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 504
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 424
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 503
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 424
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 410
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 510
}

GET

/select/de/cities

This endpoint logs the selected city for the given uuid.

Query Parameter Name	Example
`uuid`*	`eu`
`city`	`exercitation id consectetur sint`

Request Payload

Response Payload

consequat in

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 425
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 506
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 508
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 500
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 505
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 416
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 431
}

GET

/select/de/districts

This endpoint logs the selected district for the given uuid.

Query Parameter Name	Example
`uuid`*	`Duis sunt sed`
`district`	`sit culpa`

Request Payload

Response Payload

aute minim

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 410
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 414
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 506
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 415
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 410
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 411
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 424
}

GET

/select/de/postalcodes

This endpoint logs the selected postal code for the given uuid.

Query Parameter Name	Example
`uuid`*	`qui sint laboris cupidatat aliqua`
`postal_code`	`et velit eu dolor`

Request Payload

Response Payload

do cupidatat consectetur ea

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 503
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 451
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 503
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 506
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 505
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 502
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 501
}

GET

/select/de/postalcodes_cities

This endpoint logs the selected postal code/city for the given uuid.

Query Parameter Name	Example
`uuid`*	`adipisicing qui enim cillum`
`postal_code`	`cupidatat`
`city`	`veniam dolore voluptate in deserunt`
`combined`	`sint cupidatat ad`

Request Payload

Response Payload

veniam

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 404
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 507
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 505
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 508
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 403
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 431
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 506
}

GET

/select/de/postalcodes_cities_districts

This endpoint logs the selected postal code, city and district for the given uuid.

Query Parameter Name	Example
`uuid`*	`ea adipisicing anim aliquip`
`postal_code`	`enim`
`city`	`in voluptate sed id ad`
`district`	`eiusmod consectetur Lorem consequat`
`combined`	`Duis fugiat consectetur`

Request Payload

Response Payload

nulla

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 511
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 511
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 510
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 409
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 503
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "errorStatusCode": 510
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 421
}

GET

/select/de/postalcodes_cities_districts_streets

This endpoint logs the selected postal code, city, district and street for the given uuid.

Query Parameter Name	Example
`uuid`*	`nostrud Excepteur consectetur`
`postal_code`	`labore in aliqua veniam deserunt`
`city`	`sed enim reprehenderit consequat officia`
`district`	`ex adipisicing id cupidatat Lorem`
`street`	`aliqua minim mollit dolore`
`address_type`	`ut irure pariatur`
`combined`	`occaecat magna Duis sunt elit`

Request Payload

Response Payload

qui culpa voluptate sint ea

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 511
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "errorStatusCode": 511
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 404
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 508
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "errorStatusCode": 406
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 502
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 409
}

GET

/select/de/postalcodes_cities_streets

This endpoint logs the selected postal code, city and street for the given uuid.

Query Parameter Name	Example
`uuid`*	`sit irure elit`
`postal_code`	`eiusmod qui`
`city`	`sed et do occaecat ex`
`street`	`et in veniam`
`address_type`	`ullamco sit`
`combined`	`dolor dolore aliquip cupidatat eu`

Request Payload

Response Payload

culpa sit commodo reprehenderit mollit

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 502
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 414
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 506
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 508
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 401
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 505
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 501
}

GET

/select/de/streets

This endpoint logs the selected street for the given uuid.

Query Parameter Name	Example
`uuid`*	`reprehenderit`
`street`	`do`

Request Payload

Response Payload

consequat quis

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 402
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 501
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 505
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 503
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 507
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 507
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 428
}

Names(2 operations)

GET

/search/de/firstnames

This endpoint returns all the matching first names for the given first name part.

Query Parameter Name	Example
`first_name`	`aute`

Request Payload

Response Payload

{
  "firstnames": [
    {
      "firstName": "Breanne",
      "uuid": "58bb39c8-2fd1-495d-8cb2-b0acf964514e"
    }
  ],
  "numFound": 57
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 510
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 421
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 510
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 507
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 500
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 401
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Not Found",
  "errorStatusCode": 417
}

GET

/search/de/lastnames

This endpoint returns all the matching last names for the given last name part.

Query Parameter Name	Example
`last_name`	`labore in deserunt aliquip velit`

Request Payload

Response Payload

{
  "lastnames": [
    {
      "lastName": "Haag",
      "uuid": "0f5bcf14-6188-4740-bf47-7f1505bbce14"
    },
    {
      "lastName": "Oberbrunner",
      "uuid": "43a310a8-0839-4382-a312-e23ad8a2b856"
    }
  ],
  "numFound": 721
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 428
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 501
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Bad Request",
  "errorStatusCode": 410
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 507
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 505
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 507
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Bad Request",
  "errorStatusCode": 413
}

Post Office Boxes(2 operations)

GET

/search/de/poboxes

This endpoint returns all the matching post office boxes for the given postal code/city part.

Query Parameter Name	Example
`postal_code`	`in`
`city`	`mollit eu minim`

Request Payload

Response Payload

{
  "numFound": 486,
  "poboxes": [
    {
      "city": "Port Federico",
      "postalCode": "42070-1990",
      "postOfficeBoxRange": "3",
      "uuid": "befb5cc0-0bdd-40e1-a227-2ec68ff155cf"
    },
    {
      "city": "Ullrichview",
      "postalCode": "31694-7075",
      "postOfficeBoxRange": "7",
      "uuid": "1c8895be-c921-43b3-8522-f70df96e2ad9"
    },
    {
      "city": "Berkeley",
      "postalCode": "70675",
      "postOfficeBoxRange": "4",
      "uuid": "07979fbe-7e71-4461-bb59-86efb75c04f2"
    }
  ]
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 407
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "errorStatusCode": 505
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 400
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 504
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 403
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 425
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "errorStatusCode": 511
}

GET

/select/de/poboxes

This endpoint logs the selected post office box for the given uuid.

Query Parameter Name	Example
`uuid`*	`ex velit`
`postal_code`	`anim Excepteur ut enim`
`city`	`elit`
`po_box_range`	`in`

Request Payload

Response Payload

pariatur dolore

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Not Found",
  "errorStatusCode": 406
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Internal Error",
  "errorStatusCode": 417
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 502
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 501
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "errorStatusCode": 506
}

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "errorStatusCode": 429
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Internal Error",
  "errorStatusCode": 428
}

Token

GET

/token

Returns the access token and the token expire information in epoch seconds for the authenticated and authorized user.

Request Payload

Response Payload

{
  "access_token": "IHn78zM8mWyUVMBkXFfDxazTlaMKOMo6RtIuaqsJj25XwTvonucxcgsmXODHrLwI",
  "expires_in_epoch_seconds": 24357
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Not Found",
  "errorStatusCode": 422
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 415
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Bad Request",
  "errorStatusCode": 401
}

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 400
}

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Unauthorized",
  "errorStatusCode": 422
}

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Internal Error",
  "errorStatusCode": 500
}

Service Homepage: developer.dhl.com/api-reference/datafactory-autocomplete-20-post-parcel-germany#reference-docs-section

dhladdressautocompletelogisticsvalidation