Validate postcode coverage

Check whether a postcode lies within one of your business areas, for example to see whether you deliver to a customer's address.

Before you start

You need an API key with access to Geposit Atlas. If you don't have one, contact us at [email protected] or read more about Atlas zoning. How to send the key and other basics: ATLAS API Support.

Create areas based on postcodes

The easiest way to create your areas is the web app at app.geposit.se:

• Create a new map under Atlas > Maps
• Add a group to the map
• Add an area to the group
• Use the selection tools to build the area from postcodes
• Save the area

You can also create areas with the API (see Create areas and set attributes) or import them from Excel or CSV files.

Query a postcode

Find the areas that contain postcode 93391 (reference). You need the Map ID:

curl https://app-api.geposit.se/v2.0/container/postcode \
  --header 'x-api-key: {API_KEY}' \
  --header 'content-type: application/json' \
  --data '{
    "map_id": "{map_id}",
    "postcode": "93391",
    "region": "se"
  }'

The response lists every area in the map that contains the postcode:

[
  {
    "id": "CONTAINER_ID",
    "map_id": "MAP_ID",
    "layer_id": "LAYER_ID",
    "name": "Arvidsjaur",
    "color": "",
    "description": "",
    "visible": true,
    "created_at": "2024-03-08T12:32:53.585884Z",
    "updated_at": "2024-03-08T12:33:14.876772Z"
  }
]

If no area contains the postcode, the response is HTTP 200 with an empty body, not an empty list.

What counts as "contains"

The lookup only matches areas built from postcodes, of any length. A 3-digit postcode area 939 matches 93391. An area built from municipalities, localities, districts or custom shapes is not found this way, even if the postcode lies inside it. For those, look the area up by coordinate (POST /v2.0/container/coordinate) or by address (POST /v2.0/container/address).

Narrowing the search

Add layer_id to search one group only. Add filter_id (a saved filter) or filter to search only the areas that match attribute conditions, for example only the areas where a "Delivery" attribute is set.