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

cupidatat

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`	`Duis dolore`
`city`	`anim aute reprehenderit quis do`
`street`	`mollit occaecat consequat ea sit`
`house_number_short`	`eiusmod reprehenderit enim`
`combined`	`tempor veniam Excepteur`

Request Payload

Response Payload

{
  "atBuildings": [
    {
      "city": "Glennieberg",
      "district": "Tyne and Wear",
      "houseNumber": "81040",
      "houseNumberShort": "5",
      "postalCode": "50915-4621",
      "state": "Kentucky",
      "street": "Gabriella Circle",
      "streetShort": "AOFJD",
      "uuid": "7bb90489-4098-40aa-9176-487c9e6c2a2f"
    },
    {
      "city": "Raumouth",
      "district": "Avon",
      "houseNumber": "4475",
      "houseNumberShort": "1",
      "postalCode": "34671",
      "state": "Georgia",
      "street": "Belmont Road",
      "streetShort": "Dkjfl",
      "uuid": "a12582fa-5127-4b5f-9a6d-4da820f67ee4"
    },
    {
      "city": "North Orie",
      "district": "Hancock County",
      "houseNumber": "41593",
      "houseNumberShort": "0",
      "postalCode": "15955",
      "state": "Arkansas",
      "street": "Salvatore Estate",
      "streetShort": "GBave",
      "uuid": "2c574afb-2e7c-4600-9c5f-185735b0e8cf"
    }
  ],
  "numFound": 567
}

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

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

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

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

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

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

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

GET

/search/at/cities

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

Query Parameter Name	Example
`city`*	`sint qui`

Request Payload

Response Payload

{
  "atStreetcodes": [
    {
      "city": "Holdenland",
      "district": "Somerset",
      "postalCode": "26622-6235",
      "state": "Michigan",
      "street": "Nader Greens",
      "streetShort": "ArsYP",
      "uuid": "a63b247b-d9e8-4702-b24f-e02e096e5b34"
    },
    {
      "city": "Rogeliochester",
      "district": "Logan County",
      "postalCode": "02531",
      "state": "Alaska",
      "street": "Main Street N",
      "streetShort": "frwZd",
      "uuid": "8b8024b7-5c77-4f04-abc7-633254de1506"
    },
    {
      "city": "Lincoln",
      "district": "Wayne County",
      "postalCode": "42380-4599",
      "state": "Hawaii",
      "street": "S Mill Street",
      "streetShort": "fNzMR",
      "uuid": "6a10a363-a376-4546-83dc-efca20e9d1ff"
    },
    {
      "city": "Kenyonshire",
      "district": "Hertfordshire",
      "postalCode": "96583",
      "state": "Mississippi",
      "street": "Watsica Overpass",
      "streetShort": "UEhTu",
      "uuid": "a173011a-6de1-47b1-84d5-03a1ff729a9b"
    },
    {
      "city": "Lake Toby",
      "district": "Lothian",
      "postalCode": "32097",
      "state": "Missouri",
      "street": "Mraz Dale",
      "streetShort": "eiMyg",
      "uuid": "cc161e81-9cb6-44a7-87aa-7567ae77ddbc"
    }
  ],
  "numFound": 753
}

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

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

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

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

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

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

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

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`*	`quis fugiat velit proident`

Request Payload

Response Payload

{
  "atStreetcodes": [
    {
      "city": "Haleyport",
      "district": "Clwyd",
      "postalCode": "53287-9889",
      "state": "Virginia",
      "street": "Keeley Neck",
      "streetShort": "QWcnE",
      "uuid": "b451c641-fb5e-4cc4-8aa3-3bd819f37416"
    },
    {
      "city": "Homenickberg",
      "district": "Cambridgeshire",
      "postalCode": "94132-5091",
      "state": "Vermont",
      "street": "Autumn Route",
      "streetShort": "ZLZbV",
      "uuid": "1b6e7f0b-bc95-4416-ab03-4f4b0689fa09"
    },
    {
      "city": "Maureenbury",
      "district": "Hamilton County",
      "postalCode": "19473",
      "state": "West Virginia",
      "street": "Taurean Garden",
      "streetShort": "DOOCQ",
      "uuid": "1d709161-ddf5-46f2-aa9b-d9c46cf33912"
    },
    {
      "city": "Orloberg",
      "district": "Leicestershire",
      "postalCode": "40450",
      "state": "New Mexico",
      "street": "Alfred Street",
      "streetShort": "UPfUp",
      "uuid": "2241dd42-4065-4105-8432-a8674b2bfcb4"
    }
  ],
  "numFound": 744
}

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

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

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

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

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

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

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

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`	`dolor`
`city`	`veniam esse dolore`
`combined`	`Excepteur exercitation`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Residential",
      "city": "East Mason",
      "district": "Lawrence County",
      "postalCode": "89939",
      "street": "Erdman Street",
      "uuid": "bbb2ba29-d487-475a-a1a3-cce31343e743"
    },
    {
      "addressType": "Office",
      "city": "Fort Brookport",
      "district": "County Armagh",
      "postalCode": "90609",
      "street": "Meadow Way",
      "uuid": "586fbd12-4af1-4744-b9ee-e141d5e52b96"
    },
    {
      "addressType": "Residential",
      "city": "Manteshire",
      "district": "West Glamorgan",
      "postalCode": "37883",
      "street": "Spring Gardens",
      "uuid": "9843a9c6-53c1-4eae-96c8-9c48871189d5"
    },
    {
      "addressType": "Commercial",
      "city": "Port Kenyattachester",
      "district": "West Midlands",
      "postalCode": "74625-4523",
      "street": "Park Place",
      "uuid": "674b882c-c043-44c6-b01f-d7300cb27ec3"
    }
  ],
  "numFound": 86
}

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

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

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

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

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

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

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

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`	`consectetur anim Ut fugiat irure`
`city`	`ullamco`
`street`	`ad sit velit ut quis`
`combined`	`commodo`

Request Payload

Response Payload

{
  "atStreetcodes": [
    {
      "city": "Fort Raphaeltown",
      "district": "Derbyshire",
      "postalCode": "86818-6313",
      "state": "New Jersey",
      "street": "Franey Divide",
      "streetShort": "oNYYk",
      "uuid": "de2a7506-c749-4c0f-8116-fe14b2f02114"
    }
  ],
  "numFound": 164
}

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

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

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

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

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

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

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

GET

/search/at/streets

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

Query Parameter Name	Example
`street`*	`mollit ut minim et`

Request Payload

Response Payload

{
  "atStreetcodes": [
    {
      "city": "West Madisenview",
      "district": "South Yorkshire",
      "postalCode": "79261-2280",
      "state": "Washington",
      "street": "Beahan Parks",
      "streetShort": "PkWAh",
      "uuid": "67b6539f-8539-488d-941b-17698a287163"
    },
    {
      "city": "West Price",
      "district": "Gwent",
      "postalCode": "79040-7378",
      "state": "West Virginia",
      "street": "Maida Courts",
      "streetShort": "tsvXN",
      "uuid": "33a5ada4-f3a4-4f2f-b27a-c335d8b2b6d9"
    },
    {
      "city": "Pine Bluff",
      "district": "County Fermanagh",
      "postalCode": "08439",
      "state": "Utah",
      "street": "Larkin Spring",
      "streetShort": "hjngQ",
      "uuid": "55d98893-8196-42b2-a66d-2ee24cfddfe2"
    }
  ],
  "numFound": 299
}

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

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

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

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

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

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

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

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`	`sit mollit adipisicing est ea`
`city`	`sunt`
`street`	`minim sunt pariatur`
`house_number`	`exercitation fugiat ex`
`combined`	`ea sunt nostrud ex`

Request Payload

Response Payload

{
  "chBuildings": [
    {
      "canton": "BE",
      "city": "Madisonview",
      "houseKey": "O5tUUBOY",
      "houseNumber": "6832",
      "languageCode": "it",
      "municipality": "Turcottechester",
      "postalCode": "62664",
      "street": "Florian Pine",
      "uuid": "574193ca-8172-4cc8-a0e8-a49bfaa26b82"
    }
  ],
  "numFound": 814
}

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

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

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

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

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

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

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

GET

/search/ch/cities

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

Query Parameter Name	Example
`city`*	`dolor exercitation voluptate Lorem officia`

Request Payload

Response Payload

{
  "chStreetcodes": [
    {
      "canton": "ZH",
      "city": "Zulauftown",
      "languageCode": "fr",
      "municipality": "Watsicahaven",
      "postalCode": "37213",
      "street": "Bernard Walks",
      "uuid": "43346a38-48fe-47f0-b8f6-28ecee61c27e"
    },
    {
      "canton": "VD",
      "city": "North Terrell",
      "languageCode": "de",
      "municipality": "Robertsshire",
      "postalCode": "64656",
      "street": "Monahan Ramp",
      "uuid": "c4ffd9ac-a9a8-428c-bc98-f744a1023111"
    }
  ],
  "numFound": 259
}

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

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

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

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

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

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

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

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`*	`sunt adipisicing consequat consectetur cillum`

Request Payload

Response Payload

{
  "chStreetcodes": [
    {
      "canton": "GE",
      "city": "Hodkiewiczborough",
      "languageCode": "fr",
      "municipality": "Vanceside",
      "postalCode": "85692-2831",
      "street": "Kunde Court",
      "uuid": "975ebfc8-b975-46e6-ac8a-ebabf5b44abf"
    }
  ],
  "numFound": 155
}

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

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

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

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

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

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

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Bad Request",
  "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`	`ad ut irure dolore`
`city`	`Lorem Excepteur culpa fugiat Ut`
`combined`	`eu nostrud cupidatat`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Commercial",
      "city": "Lake Lorenzchester",
      "district": "Cambridgeshire",
      "postalCode": "16891-3244",
      "street": "Beverly Junction",
      "uuid": "7429df6a-3264-4354-8191-a7286f0e17e6"
    }
  ],
  "numFound": 190
}

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

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

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

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

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

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

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

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`	`in aliqua proident`
`city`	`nostrud deserunt`
`street`	`amet voluptate id sint est`
`combined`	`id in nostrud Ut esse`

Request Payload

Response Payload

{
  "chStreetcodes": [
    {
      "canton": "BE",
      "city": "Kihnfort",
      "languageCode": "fr",
      "municipality": "Upland",
      "postalCode": "19849-7842",
      "street": "Jennie Valley",
      "uuid": "00846652-e15f-46bc-ab1a-4a78a27917ca"
    },
    {
      "canton": "GE",
      "city": "North Marquisbury",
      "languageCode": "rm",
      "municipality": "Reichelshire",
      "postalCode": "29014-9832",
      "street": "Kirlin Common",
      "uuid": "ddab9350-ead9-42b1-a49b-bf61cc4ef8cd"
    }
  ],
  "numFound": 990
}

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

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

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

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

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

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

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

GET

/search/ch/streets

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

Query Parameter Name	Example
`street`*	`magna`

Request Payload

Response Payload

{
  "chStreetcodes": [
    {
      "canton": "VD",
      "city": "Scranton",
      "languageCode": "de",
      "municipality": "New Kurt",
      "postalCode": "56496-4999",
      "street": "E North Street",
      "uuid": "407d16ec-79ff-4d30-8902-d318768efbde"
    }
  ],
  "numFound": 392
}

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

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

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

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

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

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

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

GET

/select/ch/buildings

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

Query Parameter Name	Example
`uuid`*	`Excepteur quis aliqua eu`
`postal_code`	`nostrud`
`city`	`dolore culpa ut`
`street`	`sint`
`house_number`	`incididunt`
`combined`	`commodo aliquip minim ex`

Request Payload

Response Payload

aliquip velit

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

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

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

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

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

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

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

GET

/select/ch/cities

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

Query Parameter Name	Example
`uuid`*	`magna`
`city`	`fugiat cupidatat`

Request Payload

Response Payload

elit incididunt

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

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

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

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

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

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

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

GET

/select/ch/postalcodes

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

Query Parameter Name	Example
`uuid`*	`reprehenderit consectetur id non aliquip`
`postal_code`	`ullamco`

Request Payload

Response Payload

cupidatat velit fugiat mollit

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

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

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

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

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

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

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

GET

/select/ch/postalcodes_cities

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

Query Parameter Name	Example
`uuid`*	`dolor amet voluptate nulla dolore`
`postal_code`	`in`
`city`	`Duis nostrud consectetur in`
`combined`	`aute id`

Request Payload

Response Payload

ipsum

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

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

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

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

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

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

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

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`*	`elit laboris`
`postal_code`	`magna sit deserunt`
`city`	`nisi aute`
`street`	`veniam officia Ut`
`combined`	`eiusmod`

Request Payload

Response Payload

Ut veniam irure

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

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

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

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

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

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

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

GET

/select/ch/streets

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

Query Parameter Name	Example
`uuid`*	`labore voluptate ad dolor`
`street`	`elit labore nisi`

Request Payload

Response Payload

aliquip irure et dolor

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

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

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

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

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

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

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

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`	`adipisicing nostrud ea`
`city`	`nostrud sunt aliqua qui`
`district`	`mollit voluptate`
`street`	`ea eiusmod consequat qui quis`
`house_number`	`dolor labore cupidatat magna reprehenderit`
`distribution_code`	`adipisicing enim elit et laborum`
`combined`	`proident`

Request Payload

Response Payload

{
  "buildings": [
    {
      "city": "Gerdaview",
      "distributionCode": "9199",
      "district": "County Armagh",
      "houseNumber": "79497",
      "postalCode": "16528-1222",
      "street": "Highfield Avenue",
      "uuid": "8d3be566-9ec6-4fb8-92f5-c5d93ff49c2e"
    },
    {
      "city": "Port Kadin",
      "distributionCode": "4882",
      "district": "Surrey",
      "houseNumber": "738",
      "postalCode": "63573",
      "street": "Grange Avenue",
      "uuid": "7caae711-86fa-4bbb-978b-5e8c8d8b325b"
    },
    {
      "city": "Adelafield",
      "distributionCode": "6163",
      "district": "Devon",
      "houseNumber": "739",
      "postalCode": "83233-4549",
      "street": "Wren Close",
      "uuid": "3f5df747-f892-4275-b337-5eb8938b1c76"
    }
  ],
  "numFound": 702
}

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

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

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

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

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

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

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

GET

/select/de/buildings

This endpoint logs the selected building for the given uuid.

Query Parameter Name	Example
`uuid`*	`labore`
`postal_code`	`tempor laborum eu et`
`city`	`exercitation ipsum laboris officia`
`district`	`elit ut exercitation anim`
`street`	`exercitation voluptate aliquip sed minim`
`house_number`	`velit in aliqua`
`distribution_code`	`Lorem`
`combined`	`proident irure sunt reprehenderit`

Request Payload

Response Payload

mollit nostrud

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

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

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

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

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

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

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

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`	`ad elit`
`postal_code`	`est cupidatat adipisicing`
`city`	`elit aute incididunt deserunt`

Request Payload

Response Payload

{
  "bulkrecipients": [
    {
      "bulkRecipientName": "Boyle, D'Amore and Carter",
      "city": "Weberchester",
      "postalCode": "62367-9662",
      "street": "Martin Luther King Boulevard",
      "uuid": "e21fd537-f785-4a6b-954e-a15db23eb894"
    }
  ],
  "numFound": 850
}

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

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

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

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

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

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

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

GET

/select/de/bulkrecipients

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

Query Parameter Name	Example
`uuid`*	`amet ipsum dolor occaecat`
`bulk_recipient_name`	`veniam sint cupidatat anim`
`postal_code`	`nulla Lorem`
`city`	`dolore ullamco exercitation pariatur ipsum`
`street`	`ea aliquip reprehenderit`

Request Payload

Response Payload

anim culpa

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

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

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

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

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

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

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

Streetcodes(16 operations)

GET

/search/de/cities

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

Query Parameter Name	Example
`city`*	`pariatur mollit do nostrud Ut`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Residential",
      "city": "Kiarraboro",
      "district": "Staffordshire",
      "postalCode": "22694-3068",
      "street": "Frankie Locks",
      "uuid": "674bfac8-9555-4e00-bdb6-223d35b0b9cd"
    },
    {
      "addressType": "Residential",
      "city": "Careycester",
      "district": "Oxfordshire",
      "postalCode": "46860",
      "street": "Romaine Crossroad",
      "uuid": "c5a3ca47-6506-420b-9bdf-d6bc4fa2d28b"
    }
  ],
  "numFound": 743
}

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

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

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

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

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

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

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

GET

/search/de/districts

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

Query Parameter Name	Example
`district`*	`ad nisi deserunt`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Residential",
      "city": "Lake Valentin",
      "district": "Dumfries and Galloway",
      "postalCode": "67007-8872",
      "street": "Highfield Road",
      "uuid": "3f0f4960-d8f7-49ee-8d78-43aff888df2a"
    },
    {
      "addressType": "Residential",
      "city": "Rachelleton",
      "district": "South Glamorgan",
      "postalCode": "66911",
      "street": "E 4th Avenue",
      "uuid": "1700ac4a-13e1-4932-b930-c45bfb0df0cc"
    },
    {
      "addressType": "Residential",
      "city": "Welchcester",
      "district": "County Armagh",
      "postalCode": "07602-5647",
      "street": "East Avenue",
      "uuid": "d24d8207-cf7c-451b-8df5-064330877ad7"
    }
  ],
  "numFound": 972
}

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

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

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

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

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

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

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

GET

/search/de/postalcodes

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

Query Parameter Name	Example
`postal_code`*	`laboris Excepteur anim`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "Haucktown",
      "district": "Cheshire",
      "postalCode": "02605",
      "street": "Cayla Centers",
      "uuid": "65720e2f-5ce9-414e-b036-306ea78f7f71"
    },
    {
      "addressType": "Commercial",
      "city": "Lake Rita",
      "district": "Fayette County",
      "postalCode": "76690-1917",
      "street": "Donnelly Flat",
      "uuid": "0ed3853f-029a-42e6-8829-1817bb3614d8"
    }
  ],
  "numFound": 736
}

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

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

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

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

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

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

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

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`	`Excepteur dolore`
`city`	`in labore sed`
`combined`	`veniam est enim velit aliqua`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Commercial",
      "city": "Whitebury",
      "district": "Marion County",
      "postalCode": "79473-0486",
      "street": "2nd Street",
      "uuid": "2960ac96-4a56-4cea-9826-7a3238499011"
    }
  ],
  "numFound": 374
}

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

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

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

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

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

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

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

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`	`reprehenderit exercitation aliquip proident`
`city`	`non laborum officia veniam aliqua`
`district`	`et ullamco dolore commodo`
`combined`	`sed`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "Ortizport",
      "district": "West Yorkshire",
      "postalCode": "67712",
      "street": "Altenwerth Drives",
      "uuid": "cc6453b1-3491-4424-be8f-e6890c15cecb"
    },
    {
      "addressType": "Residential",
      "city": "Treyburgh",
      "district": "Clark County",
      "postalCode": "42183",
      "street": "University Drive",
      "uuid": "d7d34c0d-b3ec-4d1f-8750-82db22e49767"
    },
    {
      "addressType": "Commercial",
      "city": "Sengerfield",
      "district": "Pike County",
      "postalCode": "77602-3566",
      "street": "W Market Street",
      "uuid": "4b7d03d0-6016-4167-8d67-bfe1715885ca"
    },
    {
      "addressType": "Office",
      "city": "North Emilia",
      "district": "Monroe County",
      "postalCode": "51126",
      "street": "Branson Junction",
      "uuid": "f25606a6-5a17-4cb8-83dd-cc54d803cdba"
    },
    {
      "addressType": "Residential",
      "city": "Bell Gardens",
      "district": "North Yorkshire",
      "postalCode": "07821-4000",
      "street": "North Lane",
      "uuid": "0cefddff-f98e-4531-a376-d38381d2f002"
    }
  ],
  "numFound": 962
}

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

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

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

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

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

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

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

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`	`sunt laboris reprehenderit culpa pariatur`
`city`	`proident incididunt ullamco`
`district`	`adipisicing cupidatat dolor`
`street`	`dolore amet cupidatat quis`
`address_type`	`fugiat sit deserunt velit`
`combined`	`in aliquip anim est`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "New Feliciachester",
      "district": "Worcestershire",
      "postalCode": "10776",
      "street": "Keyon Throughway",
      "uuid": "4fc1724e-4ba3-4f63-98c8-d483612cad3a"
    },
    {
      "addressType": "Commercial",
      "city": "Port Charlotte",
      "district": "Warwickshire",
      "postalCode": "50965-9626",
      "street": "Schowalter Route",
      "uuid": "0d1f47ff-d39f-49c9-b23b-f1dbd0053255"
    },
    {
      "addressType": "Residential",
      "city": "Deltona",
      "district": "Clwyd",
      "postalCode": "84017",
      "street": "Shanie Center",
      "uuid": "57429e2d-ea95-4b7c-879c-30b5ab4e3015"
    },
    {
      "addressType": "Commercial",
      "city": "Jevonland",
      "district": "Lake County",
      "postalCode": "49169-2000",
      "street": "Nina Pine",
      "uuid": "df8085aa-b2d6-45b3-9dce-8cf2618f632c"
    },
    {
      "addressType": "Office",
      "city": "Lexieborough",
      "district": "Polk County",
      "postalCode": "98929-5877",
      "street": "O'Reilly Rapids",
      "uuid": "e26aded7-2cc6-4dae-ab35-54c6528f51c1"
    }
  ],
  "numFound": 356
}

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

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

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

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

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

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

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

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`	`nulla eiusmod`
`city`	`occaecat Duis`
`street`	`nisi commodo`
`address_type`	`eu ea incididunt`
`combined`	`incididunt dolor ad`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Residential",
      "city": "Fort Vanessaview",
      "district": "Durham",
      "postalCode": "24505",
      "street": "Kiehn Mall",
      "uuid": "12e1fedf-e7e2-4c10-bc03-690fedd6a03a"
    },
    {
      "addressType": "Office",
      "city": "Alizefield",
      "district": "Monroe County",
      "postalCode": "11114",
      "street": "Josiane Forks",
      "uuid": "c2f34ff1-070e-4f88-aa97-92580d3c6e23"
    }
  ],
  "numFound": 827
}

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

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

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

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

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

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

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

GET

/search/de/streets

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

Query Parameter Name	Example
`street`*	`esse adipisicing`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Residential",
      "city": "Sporerchester",
      "district": "Jefferson County",
      "postalCode": "75222-1199",
      "street": "Tiana Mount",
      "uuid": "61cee8d4-d51b-4b9b-9892-77f41510e790"
    },
    {
      "addressType": "Office",
      "city": "Fort Reed",
      "district": "Tyne and Wear",
      "postalCode": "98754-2647",
      "street": "Lester Spur",
      "uuid": "7d01a18d-4e4d-40d0-8e02-eabcef42ef7a"
    },
    {
      "addressType": "Residential",
      "city": "Nitzschemouth",
      "district": "Madison County",
      "postalCode": "93941-1829",
      "street": "School Lane",
      "uuid": "5fc5a40c-1fbd-4a28-af37-8a61a3997d34"
    },
    {
      "addressType": "Commercial",
      "city": "South Yadirashire",
      "district": "Washington County",
      "postalCode": "11129-2542",
      "street": "Daugherty Keys",
      "uuid": "f9daccc3-cd76-4ea1-848c-1ae442ac2b91"
    },
    {
      "addressType": "Office",
      "city": "Riverview",
      "district": "Cleveland",
      "postalCode": "52020-9131",
      "street": "Bashirian Flat",
      "uuid": "f5bca840-ce3b-48eb-be35-e8b31afd2fa7"
    }
  ],
  "numFound": 481
}

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

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

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

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

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

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

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

GET

/select/de/cities

This endpoint logs the selected city for the given uuid.

Query Parameter Name	Example
`uuid`*	`voluptate sint ipsum`
`city`	`Excepteur irure nulla`

Request Payload

Response Payload

esse

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

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

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

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

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

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

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

GET

/select/de/districts

This endpoint logs the selected district for the given uuid.

Query Parameter Name	Example
`uuid`*	`culpa in est deserunt do`
`district`	`eiusmod et`

Request Payload

Response Payload

in qui et

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

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

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

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

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

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

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

GET

/select/de/postalcodes

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

Query Parameter Name	Example
`uuid`*	`sint irure deserunt elit in`
`postal_code`	`incididunt proident commodo ea`

Request Payload

Response Payload

proident velit ullamco

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

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

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

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

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

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

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

GET

/select/de/postalcodes_cities

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

Query Parameter Name	Example
`uuid`*	`Excepteur esse`
`postal_code`	`sit`
`city`	`proident ad dolor do`
`combined`	`irure quis ex`

Request Payload

Response Payload

nulla reprehenderit nisi laboris

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

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

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

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

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

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

{
  "errorMessage": "Internal Server Error",
  "errorStatus": "Not Found",
  "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`*	`esse ipsum exercitation`
`postal_code`	`occaecat laborum fugiat sunt nisi`
`city`	`proident dolor`
`district`	`qui dolore nulla`
`combined`	`laboris ex`

Request Payload

Response Payload

ut dolore labore in

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

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

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

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

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

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

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

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`*	`nisi laborum incididunt`
`postal_code`	`consectetur est non sed adipisicing`
`city`	`ea nulla adipisicing nisi aliqua`
`district`	`ea eiusmod sit`
`street`	`ea Lorem`
`address_type`	`incididunt esse dolor elit do`
`combined`	`minim dolore dolore adipisicing eu`

Request Payload

Response Payload

laboris in

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

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

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

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

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

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

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

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`*	`ad eu incididunt`
`postal_code`	`elit`
`city`	`ad dolor`
`street`	`tempor commodo`
`address_type`	`enim nostrud`
`combined`	`culpa voluptate anim exercitation`

Request Payload

Response Payload

aliqua ut mollit consectetur velit

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

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

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

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

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

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

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

GET

/select/de/streets

This endpoint logs the selected street for the given uuid.

Query Parameter Name	Example
`uuid`*	`in enim pariatur`
`street`	`Excepteur`

Request Payload

Response Payload

aliqua consequat do mollit

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

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

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

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

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

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

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

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`	`voluptate`

Request Payload

Response Payload

{
  "firstnames": [
    {
      "firstName": "Verner",
      "uuid": "47a2dc5c-a2db-4d26-b074-66a86af71755"
    },
    {
      "firstName": "Kennedi",
      "uuid": "1ee1f013-c284-4e9c-ac74-6c75dc978f61"
    },
    {
      "firstName": "Jesus",
      "uuid": "59f78074-cc8b-43c1-b591-baeb05c02a6c"
    },
    {
      "firstName": "Ethyl",
      "uuid": "094aa9ec-50d5-4ed1-9193-dcfee1264774"
    }
  ],
  "numFound": 361
}

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

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

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

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

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

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

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

GET

/search/de/lastnames

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

Query Parameter Name	Example
`last_name`	`eiusmod reprehenderit ipsum occaecat`

Request Payload

Response Payload

{
  "lastnames": [
    {
      "lastName": "Greenfelder",
      "uuid": "6a173edf-7316-40fe-bb32-95788aae3537"
    },
    {
      "lastName": "Torphy",
      "uuid": "10b011fc-c464-4ba1-a113-20beb2b80a81"
    },
    {
      "lastName": "Collins",
      "uuid": "49644233-a235-4baa-807f-aceb3db6bb57"
    }
  ],
  "numFound": 467
}

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

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

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

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

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

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

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

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`	`deserunt voluptate sint ex`
`city`	`qui tempor`

Request Payload

Response Payload

{
  "numFound": 882,
  "poboxes": [
    {
      "city": "Port Brandoncester",
      "postalCode": "53472",
      "postOfficeBoxRange": "1",
      "uuid": "5d0f5f2d-ebf1-4955-bd7d-3fe4881a1ecd"
    }
  ]
}

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

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

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

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

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

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

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

GET

/select/de/poboxes

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

Query Parameter Name	Example
`uuid`*	`dolor`
`postal_code`	`commodo minim`
`city`	`dolore cupidatat in mollit`
`po_box_range`	`ex aute proident`

Request Payload

Response Payload

irure

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

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

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

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

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

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

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

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": "TIUBcZMXIInwMFb1bsWoc7NxEpGxMtZBT48CLkH8WBgkzgMYm97wjXME7zWbx3R0",
  "expires_in_epoch_seconds": 73932
}

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

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

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

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

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

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

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

dhladdressautocompletelogisticsvalidation