Skip to main content
POST
Check postal code

Authorizations

api-key
string
header
required

Path Parameters

locationId
string
required

The location whose coverage you want to check. The same identifier you pass to the check endpoint.

Body

application/json
postalCode
string
required

Postal code to check. Case and whitespace are ignored, so 1018 PN, 1018pn and 1018PN are treated as the same code.

Example:

"1018PN"

countryCode
string
required

ISO 3166-1 alpha-2 country code the postal code belongs to.

Example:

"NL"

dimensions
object

Collo dimensions in mm. Must satisfy length >= width >= height.

weight
number

Weight in grams.

Example:

1500

signature
boolean

Delivery requires a signature.

Example:

false

notAtNeighbour
boolean

Do not deliver to a neighbour.

Example:

false

Response

Validation result

deliverable
boolean
required

Whether the postal code area can be served for this location.

Example:

true

reason
string

Why the postal code is not deliverable. Only present when deliverable is false.

Example:

"OUT_OF_AREA"

missingCapabilities
object

Requested capabilities no carrier could satisfy. Only present when deliverable is false.