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

quis minim esse

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`	`anim`
`city`	`reprehenderit in`
`street`	`in amet`
`house_number_short`	`veniam`
`combined`	`mollit occaecat laborum est`

Request Payload

Response Payload

{
  "atBuildings": [
    {
      "city": "Corkeryville",
      "district": "Lake County",
      "houseNumber": "7490",
      "houseNumberShort": "0",
      "postalCode": "17648-7063",
      "state": "Virginia",
      "street": "Tyrique Centers",
      "streetShort": "urefo",
      "uuid": "f66157de-1d7a-4052-a3af-fba9f25589a6"
    },
    {
      "city": "New Ryderfort",
      "district": "Dumfries and Galloway",
      "houseNumber": "824",
      "houseNumberShort": "2",
      "postalCode": "10175",
      "state": "Connecticut",
      "street": "Funk River",
      "streetShort": "AJHLl",
      "uuid": "cdbc7e07-797f-431b-9c33-95c46ddd74da"
    },
    {
      "city": "Quitzonland",
      "district": "Isle of Wight",
      "houseNumber": "1338",
      "houseNumberShort": "3",
      "postalCode": "28393",
      "state": "Pennsylvania",
      "street": "Swift Falls",
      "streetShort": "eShDX",
      "uuid": "ffc44c13-558f-4e69-adef-0ce481d1568b"
    },
    {
      "city": "Hickleburgh",
      "district": "Wiltshire",
      "houseNumber": "6289",
      "houseNumberShort": "8",
      "postalCode": "01216-2209",
      "state": "Nebraska",
      "street": "Moore Streets",
      "streetShort": "WyOfT",
      "uuid": "496886e6-e172-408e-99a8-bc7d1fc4e79b"
    },
    {
      "city": "Waltham",
      "district": "Highlands and Islands",
      "houseNumber": "3104",
      "houseNumberShort": "7",
      "postalCode": "98935-1129",
      "state": "Tennessee",
      "street": "Torp Tunnel",
      "streetShort": "uNxJe",
      "uuid": "6cf317a4-c7af-4f53-a3e4-fe0ecceb61f4"
    }
  ],
  "numFound": 755
}

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

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

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

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

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

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

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

GET

/search/at/cities

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

Query Parameter Name	Example
`city`*	`quis tempor sed`

Request Payload

Response Payload

{
  "atStreetcodes": [
    {
      "city": "Hacienda Heights",
      "district": "Hampshire",
      "postalCode": "00002",
      "state": "New Mexico",
      "street": "Lorna Shoals",
      "streetShort": "lXynI",
      "uuid": "43c24eb8-27b9-43d9-9d77-4cbeda8df412"
    },
    {
      "city": "Smithcester",
      "district": "Oxfordshire",
      "postalCode": "94995",
      "state": "North Dakota",
      "street": "Keira Mount",
      "streetShort": "vQfgL",
      "uuid": "9461fd45-faaf-4cbb-8535-ee56a9623cae"
    },
    {
      "city": "Lake Margretworth",
      "district": "Monroe County",
      "postalCode": "83254",
      "state": "Kansas",
      "street": "15th Street",
      "streetShort": "rEXCZ",
      "uuid": "93ef32f2-8231-45c1-92bc-3f0ae7c6db7c"
    },
    {
      "city": "Port Ariane",
      "district": "Central",
      "postalCode": "54458",
      "state": "Alaska",
      "street": "Predovic Walks",
      "streetShort": "Euayz",
      "uuid": "d4eb8a4f-1155-4aa3-9465-a63bf994700c"
    },
    {
      "city": "Kennewick",
      "district": "Hancock County",
      "postalCode": "05667-7417",
      "state": "West Virginia",
      "street": "Station Road",
      "streetShort": "OVann",
      "uuid": "7f0cdcfa-b63f-4404-88b9-e1eb0e07bda1"
    }
  ],
  "numFound": 207
}

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

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

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

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

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

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

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

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`*	`minim`

Request Payload

Response Payload

{
  "atStreetcodes": [
    {
      "city": "Port Boris",
      "district": "Hampshire",
      "postalCode": "24983",
      "state": "Montana",
      "street": "Barbara Parks",
      "streetShort": "ZhvjG",
      "uuid": "33946192-6718-4f35-8415-c7f42c9b23ee"
    },
    {
      "city": "South Harold",
      "district": "Cambridgeshire",
      "postalCode": "72260",
      "state": "Connecticut",
      "street": "Elouise Estates",
      "streetShort": "vuZxJ",
      "uuid": "1f73db61-8984-43d0-8ce1-062925745ea9"
    }
  ],
  "numFound": 717
}

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

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

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

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

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

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

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

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`	`consequat do`
`city`	`fugiat et Lorem dolor`
`combined`	`adipisicing velit`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Commercial",
      "city": "New Mariela",
      "district": "Carroll County",
      "postalCode": "13777",
      "street": "Grove Street",
      "uuid": "2b473636-3c08-41e5-956b-8f1024808fd4"
    },
    {
      "addressType": "Office",
      "city": "North Queenchester",
      "district": "Highlands and Islands",
      "postalCode": "12474",
      "street": "Jason Burg",
      "uuid": "c0748a8b-44bb-4557-8e7a-7b438a4598c3"
    },
    {
      "addressType": "Commercial",
      "city": "Fort Daisha",
      "district": "Wayne County",
      "postalCode": "38397",
      "street": "Claude Station",
      "uuid": "ac65da40-63aa-4aff-b8c8-f42d5317727b"
    },
    {
      "addressType": "Residential",
      "city": "Lake Danykachester",
      "district": "County Down",
      "postalCode": "20286-4871",
      "street": "Manor Way",
      "uuid": "f013e85b-b1d1-40fd-a33b-e323e21b4ee5"
    }
  ],
  "numFound": 122
}

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

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

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

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

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

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

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

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`	`cupidatat adipisicing consequat veniam`
`city`	`ea proident`
`street`	`non aute anim dolore velit`
`combined`	`ex`

Request Payload

Response Payload

{
  "atStreetcodes": [
    {
      "city": "East Rylee",
      "district": "Buckinghamshire",
      "postalCode": "58141-6905",
      "state": "Mississippi",
      "street": "Lynch Knolls",
      "streetShort": "sotQN",
      "uuid": "9c59895a-7abe-4b24-bd9b-945d5cb7452d"
    },
    {
      "city": "Lake Zaria",
      "district": "Humberside",
      "postalCode": "70145-7646",
      "state": "Maryland",
      "street": "N 8th Street",
      "streetShort": "swtZv",
      "uuid": "fe248cfb-ef02-42ef-9023-b4a99acc4072"
    }
  ],
  "numFound": 77
}

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

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

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

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

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

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

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

GET

/search/at/streets

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

Query Parameter Name	Example
`street`*	`culpa aliqua ut nostrud`

Request Payload

Response Payload

{
  "atStreetcodes": [
    {
      "city": "Hanefurt",
      "district": "Essex",
      "postalCode": "47708-6767",
      "state": "South Dakota",
      "street": "Schaefer Corners",
      "streetShort": "RwiJC",
      "uuid": "7e7e9944-8214-4377-9883-e8b5225bf116"
    },
    {
      "city": "Carolyneville",
      "district": "Lee County",
      "postalCode": "54948-9762",
      "state": "Maryland",
      "street": "Wilkinson Villages",
      "streetShort": "BsYWM",
      "uuid": "63cbb87a-ea2d-4dd6-a796-7b4567b29ba0"
    }
  ],
  "numFound": 942
}

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

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

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

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

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

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

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

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`	`ullamco sit non`
`city`	`mollit fugiat enim`
`street`	`voluptate aute Ut in veniam`
`house_number`	`esse sit`
`combined`	`eu sint deserunt pariatur`

Request Payload

Response Payload

{
  "chBuildings": [
    {
      "canton": "ZH",
      "city": "Novahaven",
      "houseKey": "ZptcAbGv",
      "houseNumber": "660",
      "languageCode": "fr",
      "municipality": "Emilycester",
      "postalCode": "43074-0285",
      "street": "Carter Islands",
      "uuid": "14b236db-ace8-4ce6-aa66-870c4f3f4853"
    },
    {
      "canton": "VD",
      "city": "Manuelshire",
      "houseKey": "cwsXwJIJ",
      "houseNumber": "9457",
      "languageCode": "fr",
      "municipality": "New Adelbert",
      "postalCode": "56454-7144",
      "street": "Cassandre Valleys",
      "uuid": "74ed849c-fc6a-4b92-af8e-1e3409cd0c0d"
    },
    {
      "canton": "ZH",
      "city": "Port Charlotte",
      "houseKey": "kpYwPgHi",
      "houseNumber": "1705",
      "languageCode": "de",
      "municipality": "Schneiderburgh",
      "postalCode": "27610-1836",
      "street": "Mill Road",
      "uuid": "7363c8dc-64fc-4114-b000-c345361a6309"
    },
    {
      "canton": "BE",
      "city": "Fort Alanna",
      "houseKey": "GRgMU1GK",
      "houseNumber": "64416",
      "languageCode": "it",
      "municipality": "Haltom City",
      "postalCode": "89888",
      "street": "Lawrence Street",
      "uuid": "fff10eb4-318d-45c9-931d-2aa2e6c11894"
    }
  ],
  "numFound": 618
}

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

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

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

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

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

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

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

GET

/search/ch/cities

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

Query Parameter Name	Example
`city`*	`ut tempor dolor consectetur sit`

Request Payload

Response Payload

{
  "chStreetcodes": [
    {
      "canton": "BE",
      "city": "Wichita",
      "languageCode": "rm",
      "municipality": "East Newtonmouth",
      "postalCode": "62192",
      "street": "Park Street",
      "uuid": "fcfd0d17-b4f8-4bab-a300-b7a0f03bdfbb"
    }
  ],
  "numFound": 928
}

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

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

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

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

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

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

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

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`*	`minim Duis laboris`

Request Payload

Response Payload

{
  "chStreetcodes": [
    {
      "canton": "GE",
      "city": "Franeckistad",
      "languageCode": "rm",
      "municipality": "North Damon",
      "postalCode": "04619",
      "street": "W 1st Street",
      "uuid": "dc2302aa-56b2-4c48-87c0-74759939d0b3"
    },
    {
      "canton": "SG",
      "city": "Port Eugeniaside",
      "languageCode": "rm",
      "municipality": "Cary",
      "postalCode": "30136",
      "street": "Raynor Extension",
      "uuid": "6052f5c0-f893-4118-9da7-16fde656381f"
    },
    {
      "canton": "GE",
      "city": "West Irwin",
      "languageCode": "rm",
      "municipality": "Hudsonhaven",
      "postalCode": "04327",
      "street": "Rice Valley",
      "uuid": "75fb1a93-8da3-4623-a54e-bfdbd9e72dfa"
    }
  ],
  "numFound": 584
}

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

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

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

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

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

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

{
  "errorMessage": "Unauthorized",
  "errorStatus": "Unauthorized",
  "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`	`minim id`
`city`	`cillum`
`combined`	`magna`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "New Raoulworth",
      "district": "Devon",
      "postalCode": "49865-4756",
      "street": "Bud Club",
      "uuid": "e195977c-24e1-4d05-8981-1a0244844544"
    },
    {
      "addressType": "Commercial",
      "city": "Kutchmouth",
      "district": "Union County",
      "postalCode": "91178-1444",
      "street": "Batz Glen",
      "uuid": "557c0c7d-2332-4a77-a4cd-79e02763fe0c"
    }
  ],
  "numFound": 573
}

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

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

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

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

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

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

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

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`	`occaecat consectetur sint elit`
`city`	`tempor`
`street`	`amet nostrud eu et labore`
`combined`	`ad minim ullamco aute cillum`

Request Payload

Response Payload

{
  "chStreetcodes": [
    {
      "canton": "ZH",
      "city": "Port Kirsten",
      "languageCode": "it",
      "municipality": "Gerdaboro",
      "postalCode": "39691",
      "street": "Adan Dale",
      "uuid": "3746bf8d-069b-4498-ba1c-f153b4a40c79"
    },
    {
      "canton": "BE",
      "city": "Lake Sydnee",
      "languageCode": "fr",
      "municipality": "West Edview",
      "postalCode": "11126-9086",
      "street": "College Street",
      "uuid": "df17a81d-cdf3-4715-b011-3b5cc9a924a1"
    },
    {
      "canton": "GE",
      "city": "Emardshire",
      "languageCode": "fr",
      "municipality": "Beattyfort",
      "postalCode": "70155-8838",
      "street": "Hilario Roads",
      "uuid": "b4d5de0d-4a35-45a2-a325-2e381ea636d0"
    }
  ],
  "numFound": 846
}

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

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

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

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

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

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

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

GET

/search/ch/streets

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

Query Parameter Name	Example
`street`*	`in`

Request Payload

Response Payload

{
  "chStreetcodes": [
    {
      "canton": "SG",
      "city": "Fort Myers",
      "languageCode": "fr",
      "municipality": "Celineborough",
      "postalCode": "62679",
      "street": "S Market Street",
      "uuid": "e9c5a144-e93e-4716-b087-bef5f6bbc77d"
    },
    {
      "canton": "GE",
      "city": "South Gustave",
      "languageCode": "rm",
      "municipality": "Josiahport",
      "postalCode": "69589",
      "street": "Domingo Circle",
      "uuid": "747796e1-bdb8-41ea-937e-ae0516c8fdb4"
    },
    {
      "canton": "ZH",
      "city": "North Audreannecester",
      "languageCode": "de",
      "municipality": "Santiagoside",
      "postalCode": "80291-2315",
      "street": "Tyler Road",
      "uuid": "2590c48f-6a25-4ac0-91f1-c1a373ef1ff8"
    },
    {
      "canton": "SG",
      "city": "Whitetown",
      "languageCode": "rm",
      "municipality": "Pagacstad",
      "postalCode": "93471-1835",
      "street": "Bayer Point",
      "uuid": "e7e34da2-118e-4d32-94e7-ecbcd38b94ee"
    },
    {
      "canton": "SG",
      "city": "Port Celiatown",
      "languageCode": "de",
      "municipality": "Watsicaborough",
      "postalCode": "54194-2081",
      "street": "Russel Hollow",
      "uuid": "45fe42dd-c327-4d59-815b-ac9b2aa32b61"
    }
  ],
  "numFound": 41
}

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

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

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

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

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

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

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

GET

/select/ch/buildings

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

Query Parameter Name	Example
`uuid`*	`velit aute occaecat`
`postal_code`	`enim`
`city`	`ut consectetur deserunt quis id`
`street`	`est tempor sunt`
`house_number`	`Ut`
`combined`	`non`

Request Payload

Response Payload

cillum

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

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

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

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

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

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

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

GET

/select/ch/cities

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

Query Parameter Name	Example
`uuid`*	`voluptate reprehenderit ut ex ipsum`
`city`	`non minim dolore Excepteur`

Request Payload

Response Payload

cillum in ipsum enim occaecat

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

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

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

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

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

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

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

GET

/select/ch/postalcodes

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

Query Parameter Name	Example
`uuid`*	`nostrud`
`postal_code`	`anim fugiat`

Request Payload

Response Payload

voluptate

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

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

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

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

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

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

{
  "errorMessage": "Not Found",
  "errorStatus": "Unauthorized",
  "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`*	`ipsum eu consequat reprehenderit`
`postal_code`	`aute laborum`
`city`	`est`
`combined`	`ut anim ea incididunt`

Request Payload

Response Payload

exercitation anim cillum

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

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

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

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

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

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

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

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`*	`nulla minim Excepteur aute ullamco`
`postal_code`	`Lorem`
`city`	`do proident mollit`
`street`	`laboris et veniam in dolore`
`combined`	`aliquip mollit`

Request Payload

Response Payload

dolore dolor

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

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

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

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

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

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

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

GET

/select/ch/streets

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

Query Parameter Name	Example
`uuid`*	`aute tempor`
`street`	`incididunt minim labore Ut`

Request Payload

Response Payload

occaecat nisi sint

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

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

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

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

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

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

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

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`	`officia`
`city`	`proident elit occaecat`
`district`	`cillum aliqua Ut`
`street`	`nisi amet`
`house_number`	`ad dolore ea est`
`distribution_code`	`nostrud ipsum sed`
`combined`	`deserunt ut`

Request Payload

Response Payload

{
  "buildings": [
    {
      "city": "Lake Urielmouth",
      "distributionCode": "9418",
      "district": "County Londonderry",
      "houseNumber": "7508",
      "postalCode": "50146-4795",
      "street": "Justice Harbor",
      "uuid": "59dce938-06c8-4aa8-bfab-16aec63ece67"
    },
    {
      "city": "North Jarred",
      "distributionCode": "4858",
      "district": "Wiltshire",
      "houseNumber": "88938",
      "postalCode": "13635-8208",
      "street": "Tromp Shoals",
      "uuid": "76fc7376-03da-45b9-a653-fffd897ccb5d"
    }
  ],
  "numFound": 160
}

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

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

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

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

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

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

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

GET

/select/de/buildings

This endpoint logs the selected building for the given uuid.

Query Parameter Name	Example
`uuid`*	`Ut sunt magna ut`
`postal_code`	`pariatur quis dolor Lorem est`
`city`	`exercitation proident Duis id`
`district`	`veniam`
`street`	`ex sint id`
`house_number`	`amet`
`distribution_code`	`qui irure dolore`
`combined`	`nisi ut fugiat aliquip cupidatat`

Request Payload

Response Payload

sint tempor sunt

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

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

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

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

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

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

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

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`	`ut amet sunt`
`postal_code`	`occaecat ut reprehenderit`
`city`	`ad`

Request Payload

Response Payload

{
  "bulkrecipients": [
    {
      "bulkRecipientName": "Gislason, Williamson and Schimmel",
      "city": "Cooperborough",
      "postalCode": "16251-2450",
      "street": "Old Lane",
      "uuid": "167fca58-8a78-4a4b-81b6-c35e85783c82"
    },
    {
      "bulkRecipientName": "Reinger - Dickinson",
      "city": "Port Palmaville",
      "postalCode": "95290",
      "street": "River Road",
      "uuid": "cdb0aff3-ff8a-43a8-9d85-ac7178f743b7"
    },
    {
      "bulkRecipientName": "Dickens, Torp and Wunsch",
      "city": "New Astrid",
      "postalCode": "49825",
      "street": "Sanford Rest",
      "uuid": "8ea93bac-58f1-40e0-8759-c5127fde792e"
    },
    {
      "bulkRecipientName": "Sanford, Padberg and Prosacco",
      "city": "Beckermouth",
      "postalCode": "30149-0609",
      "street": "Victoria Place",
      "uuid": "c049fe42-a80b-4d65-800c-f4f9f83d2049"
    }
  ],
  "numFound": 834
}

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

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

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

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

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

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

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

GET

/select/de/bulkrecipients

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

Query Parameter Name	Example
`uuid`*	`id sint non ea in`
`bulk_recipient_name`	`ad`
`postal_code`	`ut dolore aute ad officia`
`city`	`pariatur dolore dolor labore ex`
`street`	`adipisicing aliqua in pariatur anim`

Request Payload

Response Payload

est cupidatat fugiat

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

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

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

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

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

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

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

Streetcodes(16 operations)

GET

/search/de/cities

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

Query Parameter Name	Example
`city`*	`tempor ipsum ea occaecat aliquip`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "Lincoln",
      "district": "Jefferson County",
      "postalCode": "00933",
      "street": "Kshlerin Via",
      "uuid": "f4ca5a3c-e9b1-4d8b-a64c-ca28460a7bd5"
    },
    {
      "addressType": "Office",
      "city": "Croninfurt",
      "district": "Suffolk",
      "postalCode": "47413-2369",
      "street": "Alexandre Row",
      "uuid": "0ad56239-5100-43f8-9130-1130555f43f8"
    },
    {
      "addressType": "Commercial",
      "city": "East Marilyne",
      "district": "County Tyrone",
      "postalCode": "57179",
      "street": "Spring Street",
      "uuid": "18ac953b-b74c-4475-8ab0-89409f286b4d"
    },
    {
      "addressType": "Commercial",
      "city": "Fort Shanna",
      "district": "Carroll County",
      "postalCode": "09537",
      "street": "Willy Fords",
      "uuid": "fb1f4aba-c382-4c27-9fec-59a0e505a13f"
    }
  ],
  "numFound": 535
}

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

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

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

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

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

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

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

GET

/search/de/districts

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

Query Parameter Name	Example
`district`*	`commodo incididunt irure laborum et`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Residential",
      "city": "Carsonchester",
      "district": "Lawrence County",
      "postalCode": "70237-0209",
      "street": "South Street",
      "uuid": "06d9e6c7-757b-413e-96ea-173c0860bfaa"
    },
    {
      "addressType": "Residential",
      "city": "West Jenniemouth",
      "district": "Cambridgeshire",
      "postalCode": "06528-9567",
      "street": "Field Lane",
      "uuid": "f00c33f4-f467-4888-926a-4227e756a77c"
    },
    {
      "addressType": "Residential",
      "city": "Pompano Beach",
      "district": "Fife",
      "postalCode": "15201-7608",
      "street": "Zander Courts",
      "uuid": "dd98f743-5945-42ba-8d2d-70220e35dd90"
    },
    {
      "addressType": "Office",
      "city": "Keyonberg",
      "district": "North Yorkshire",
      "postalCode": "23777-8274",
      "street": "Haley Shores",
      "uuid": "b8b41af9-b6be-458b-9a54-6617f500e8e8"
    },
    {
      "addressType": "Commercial",
      "city": "Sawaynbury",
      "district": "Durham",
      "postalCode": "78172-7856",
      "street": "Front Street",
      "uuid": "4102a76c-08ea-48cf-b4c1-fece229d5724"
    }
  ],
  "numFound": 898
}

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

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

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

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

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

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

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

GET

/search/de/postalcodes

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

Query Parameter Name	Example
`postal_code`*	`deserunt`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Residential",
      "city": "New Connie",
      "district": "Greene County",
      "postalCode": "57999",
      "street": "Wade Mills",
      "uuid": "20041f0c-b49e-449e-8fbd-1a970a7749bf"
    },
    {
      "addressType": "Commercial",
      "city": "Midwest City",
      "district": "Avon",
      "postalCode": "71416",
      "street": "Abbott Centers",
      "uuid": "1927ca45-a14a-46ba-97fc-d88c119d4071"
    },
    {
      "addressType": "Office",
      "city": "Port Josianneworth",
      "district": "Tayside",
      "postalCode": "10956",
      "street": "Queen's Road",
      "uuid": "1c77681c-436f-4cc2-8ef1-a2fd891442f7"
    },
    {
      "addressType": "Residential",
      "city": "South Madaline",
      "district": "Douglas County",
      "postalCode": "48157-3420",
      "street": "Avery Wells",
      "uuid": "4e27387d-0aae-41f1-9128-1e02420c4f5e"
    }
  ],
  "numFound": 695
}

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

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

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

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

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

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

{
  "errorMessage": "Not Found",
  "errorStatus": "Internal Error",
  "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`	`tempor mollit aliquip`
`city`	`fugiat ullamco sunt aliquip quis`
`combined`	`Duis est anim`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Commercial",
      "city": "New Montana",
      "district": "Washington County",
      "postalCode": "20642-8291",
      "street": "Mertz Row",
      "uuid": "07b92025-01f7-4ac1-9419-ff9f4bd52653"
    },
    {
      "addressType": "Residential",
      "city": "Bauchshire",
      "district": "Perry County",
      "postalCode": "72057",
      "street": "Tomasa Overpass",
      "uuid": "710a42dd-78e3-414f-8ff2-e2e9fb09e0c4"
    },
    {
      "addressType": "Office",
      "city": "North Rodrick",
      "district": "Scott County",
      "postalCode": "21689-1372",
      "street": "Fritsch Valley",
      "uuid": "46a80f03-f2c9-4ad5-8910-1214077e8638"
    },
    {
      "addressType": "Residential",
      "city": "Justiceton",
      "district": "Gloucestershire",
      "postalCode": "21641",
      "street": "West Summit",
      "uuid": "17ccab5a-46aa-4c26-9202-78b4b4285e21"
    }
  ],
  "numFound": 850
}

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

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

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

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

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

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

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

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`	`Duis adipisicing nulla incididunt`
`city`	`minim ullamco`
`district`	`tempor consectetur`
`combined`	`aute`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "Lake Noel",
      "district": "North Yorkshire",
      "postalCode": "08114-3121",
      "street": "5th Street",
      "uuid": "4a911589-25d9-42a9-9626-5b7bb941263d"
    },
    {
      "addressType": "Residential",
      "city": "Kshlerinberg",
      "district": "Franklin County",
      "postalCode": "94376",
      "street": "Willie View",
      "uuid": "42346213-9da7-479d-8b6e-e833d9b42a02"
    },
    {
      "addressType": "Office",
      "city": "Lake Chadrick",
      "district": "County Antrim",
      "postalCode": "56985-8908",
      "street": "Park View",
      "uuid": "31503b28-344b-43c6-be94-90b13663eaf1"
    }
  ],
  "numFound": 678
}

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

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

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

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

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

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

{
  "errorMessage": "Invalid Input",
  "errorStatus": "Unauthorized",
  "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`	`Excepteur`
`city`	`eiusmod`
`district`	`officia nostrud sint adipisicing id`
`street`	`velit`
`address_type`	`dolore eu`
`combined`	`in quis`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Residential",
      "city": "Lake Dangelostad",
      "district": "Greater Manchester",
      "postalCode": "44067",
      "street": "E Center Street",
      "uuid": "c27d10fe-da1b-4462-b885-8cba4f4b4a4e"
    },
    {
      "addressType": "Commercial",
      "city": "East Ezra",
      "district": "Northumberland",
      "postalCode": "63977-5392",
      "street": "Lura Fords",
      "uuid": "6d5e16f3-d266-4cb6-a1e2-62e166974e78"
    },
    {
      "addressType": "Office",
      "city": "McAllen",
      "district": "Polk County",
      "postalCode": "06166-2616",
      "street": "Trinity Road",
      "uuid": "74612cba-e276-4c52-ace0-2af2ed921667"
    },
    {
      "addressType": "Residential",
      "city": "Metairie",
      "district": "Montgomery County",
      "postalCode": "45142",
      "street": "Lamont Knoll",
      "uuid": "9d6f75b3-76a1-4136-901b-384ef34be0ff"
    }
  ],
  "numFound": 195
}

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

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

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

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

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

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

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

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`	`sit`
`city`	`magna cupidatat`
`street`	`Excepteur magna pariatur`
`address_type`	`dolor ad dolore voluptate proident`
`combined`	`eiusmod velit dolore adipisicing`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Residential",
      "city": "East Alfcester",
      "district": "Dyfed",
      "postalCode": "25517",
      "street": "E Cedar Street",
      "uuid": "a589b966-1454-4c57-83a0-3f1b90b21611"
    },
    {
      "addressType": "Commercial",
      "city": "Port Augustineland",
      "district": "Fife",
      "postalCode": "88195-3615",
      "street": "Schaden Crescent",
      "uuid": "818ec1eb-2c48-4578-9439-58811b1dadaa"
    },
    {
      "addressType": "Residential",
      "city": "South Juliofield",
      "district": "Essex",
      "postalCode": "62760",
      "street": "Reymundo Avenue",
      "uuid": "67bb42ff-cdf3-4c90-90b4-cde49b2e084d"
    },
    {
      "addressType": "Office",
      "city": "Fort Wilfredo",
      "district": "East Sussex",
      "postalCode": "37317-2433",
      "street": "Robel Forge",
      "uuid": "08d57c73-ce49-4007-ae73-fa5f841c72cb"
    },
    {
      "addressType": "Residential",
      "city": "Greenholtbury",
      "district": "Oxfordshire",
      "postalCode": "99677",
      "street": "Alec Spurs",
      "uuid": "36b22840-edcd-4b5a-8849-856f531cdc7e"
    }
  ],
  "numFound": 996
}

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

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

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

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

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

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

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

GET

/search/de/streets

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

Query Parameter Name	Example
`street`*	`incididunt elit culpa`

Request Payload

Response Payload

{
  "addresses": [
    {
      "addressType": "Office",
      "city": "Dickinsonbury",
      "district": "Hertfordshire",
      "postalCode": "62262",
      "street": "Elliot Cliff",
      "uuid": "644d32c6-5bae-4edd-81a2-da0fd7453c08"
    },
    {
      "addressType": "Office",
      "city": "South Robertaberg",
      "district": "Clwyd",
      "postalCode": "95640",
      "street": "1st Street",
      "uuid": "9a4780be-74e3-4a6d-89b4-f4cafd5a1a01"
    },
    {
      "addressType": "Commercial",
      "city": "East Carley",
      "district": "Jefferson County",
      "postalCode": "76109-8922",
      "street": "Cruickshank Station",
      "uuid": "4c89b1c2-2307-462b-8b03-56ea2ca0cb9e"
    },
    {
      "addressType": "Office",
      "city": "Okunevaport",
      "district": "Cumbria",
      "postalCode": "51481",
      "street": "Schimmel Pines",
      "uuid": "db459fc1-39d9-4058-aff3-e56d5e1eecda"
    }
  ],
  "numFound": 27
}

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

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

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

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

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

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

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

GET

/select/de/cities

This endpoint logs the selected city for the given uuid.

Query Parameter Name	Example
`uuid`*	`dolore`
`city`	`ipsum magna Lorem`

Request Payload

Response Payload

do et

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

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

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

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

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

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

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

GET

/select/de/districts

This endpoint logs the selected district for the given uuid.

Query Parameter Name	Example
`uuid`*	`voluptate`
`district`	`ex nisi in mollit`

Request Payload

Response Payload

sint adipisicing aliquip

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

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

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

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

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

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

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

GET

/select/de/postalcodes

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

Query Parameter Name	Example
`uuid`*	`culpa officia`
`postal_code`	`ut ut do commodo officia`

Request Payload

Response Payload

velit laboris aute

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

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

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

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

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

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

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

GET

/select/de/postalcodes_cities

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

Query Parameter Name	Example
`uuid`*	`ex Duis nostrud elit deserunt`
`postal_code`	`Lorem ut fugiat sed`
`city`	`mollit`
`combined`	`consectetur pariatur ut nisi`

Request Payload

Response Payload

ullamco voluptate pariatur

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

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

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

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

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

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

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

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`*	`Duis nostrud`
`postal_code`	`eu`
`city`	`incididunt`
`district`	`in`
`combined`	`esse ullamco officia consectetur`

Request Payload

Response Payload

ut non

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

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

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

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

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

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

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

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`*	`nulla ullamco Duis dolore dolor`
`postal_code`	`sed occaecat sit reprehenderit`
`city`	`reprehenderit tempor in aliquip commodo`
`district`	`incididunt in aliqua consectetur Excepteur`
`street`	`exercitation ea`
`address_type`	`Lorem`
`combined`	`ullamco in dolore pariatur fugiat`

Request Payload

Response Payload

veniam Lorem aliqua minim

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

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

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

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

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

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

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

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`*	`officia labore elit`
`postal_code`	`in voluptate laboris`
`city`	`ipsum aute labore`
`street`	`amet`
`address_type`	`culpa nulla`
`combined`	`anim consequat`

Request Payload

Response Payload

in irure aute dolore

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

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

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

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

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

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

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

GET

/select/de/streets

This endpoint logs the selected street for the given uuid.

Query Parameter Name	Example
`uuid`*	`quis est Duis ut pariatur`
`street`	`ad dolor nostrud`

Request Payload

Response Payload

nostrud fugiat nulla

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

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

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

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

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

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

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

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": "Audra",
      "uuid": "27fd8c34-755c-4ce9-b7a1-b7123e2528a6"
    },
    {
      "firstName": "Federico",
      "uuid": "64697dcc-61ed-40ae-a909-6fbd492076f0"
    },
    {
      "firstName": "Irving",
      "uuid": "65f5c3f2-9dc6-4c71-8980-385d2d3550d9"
    },
    {
      "firstName": "Leonardo",
      "uuid": "2f5a2537-2168-4b9a-a9cd-7d0c829f5eda"
    }
  ],
  "numFound": 157
}

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

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

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

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

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

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

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

GET

/search/de/lastnames

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

Query Parameter Name	Example
`last_name`	`magna culpa consectetur tempor proident`

Request Payload

Response Payload

{
  "lastnames": [
    {
      "lastName": "White",
      "uuid": "0caf8c79-8a01-4dc1-a462-bfc45feeaddb"
    }
  ],
  "numFound": 980
}

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

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

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

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

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

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

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

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

Request Payload

Response Payload

{
  "numFound": 628,
  "poboxes": [
    {
      "city": "Irondequoit",
      "postalCode": "95048",
      "postOfficeBoxRange": "2",
      "uuid": "d635c1f3-345a-48dd-ac81-391a7bed622d"
    }
  ]
}

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

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

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

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

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

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

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

GET

/select/de/poboxes

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

Query Parameter Name	Example
`uuid`*	`elit amet dolor`
`postal_code`	`adipisicing id proident ea`
`city`	`aliquip`
`po_box_range`	`nostrud`

Request Payload

Response Payload

consectetur ex amet nostrud reprehenderit

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

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

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

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

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

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

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

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": "kMC1Jb6JkGN6ivoyCg5iDCdbf3gE1cMCKUpvKoKuZm98JnFe36J63fXOAak6vuPf",
  "expires_in_epoch_seconds": 86353
}

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

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

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

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

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

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

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

dhladdressautocompletelogisticsvalidation