PostNL

PostNL Checkout Postalcode Check API

Check a Dutch postal code and house number and return the address (v1).

GitHub OpenAPI

Operations 1

GET /shipment/checkout/v1/postalcodecheck Checkout postalcode check #

Documentation

📖
Documentation
https://developer.postnl.nl/integration-with-postnl/api-overview/checkout/postcodecheck/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/postnl/openapi/postnl-postalcode-check-api-openapi.yml
⚙
OpenAPI
https://api-sandbox.postnl.nl/shipment/checkout/v1/postalcodecheck/swagger.json

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/postnl/json-schema/postnl-postalcode-check-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/postnl:postalcode-check-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

postnl-postalcode-check-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Checkout Postalcode check API
  description: Check Dutch address data that is entered in your webshop checkout.
  version: v1
servers:
- url: https://api-sandbox.postnl.nl
  description: Non-Production server
- url: https://api.postnl.nl
  description: Production server
security:
- APIKeyHeader: []
tags:
- name: Postalcode check
paths:
  /shipment/checkout/v1/postalcodecheck:
    get:
      tags:
      - Postalcode check
      summary: Checkout postalcode check
      description: 'Please note that this API is not available on the sandbox environment.


        Request example:

        ```

        curl -X GET "https://api.postnl.nl/shipment/checkout/v1/postalcodecheck?postalcode=3571ZZ&housenumber=74&housenumberaddition=bis" \

        -H "Accept: application/json" \

        -H "apikey: APIKEY-HERE"

        ```'
      operationId: CheckoutPostalcodeCheck
      security:
      - APIKeyHeader: []
      parameters:
      - name: postalcode
        in: query
        required: true
        schema:
          type: string
          example: 3571ZZ
          minLength: 6
          maxLength: 6
      - name: housenumber
        in: query
        required: true
        schema:
          type: string
          example: '74'
          minLength: 1
          maxLength: 5
      - name: housenumberaddition
        in: query
        schema:
          type: string
          example: bis
          maxLength: 6
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postalcodeCheckResponse'
              examples:
                Single address found:
                  $ref: '#/components/examples/cpcSuccessSingleAddress'
                Multiple addresses found:
                  $ref: '#/components/examples/cpcSuccessMultipleAddresses'
                No address found:
                  $ref: '#/components/examples/cpcSuccessNoAddress'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postalcodeCheckResponseInvalid'
              example:
                errors:
                - status: '400'
                  title: Bad request
                  detail: Input field 'housenumber' must be a number
        '401':
          description: Invalid apikey
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
              example:
                message: Failed to resolve API Key variable 'request.header.apikey'
                http_status_code: 401
        '405':
          description: Method not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedOnlyGetPost'
              example:
                message: Only GET & POST requests allowed
                http_status_code: 405
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequests'
              example:
                message: Too many requests. Rate limit exceeded!
                http_status_code: 429
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
              example:
                fault:
                  faultstring: Unexpected token in object literal
                  detail:
                    errorcode: Validation Fault
components:
  schemas:
    postalcodeCheckAddress:
      type: object
      properties:
        city:
          type: string
          description: City of requested address
          example: UTRECHT
        postalCode:
          type: string
          description: Postalcode of requested address
          example: 3571ZZ
        streetName:
          type: string
          description: Street of requested address
          example: Molengraaffplantsoen
        houseNumber:
          type: integer
          description: Housenumber of requested address
          example: 74
        houseNumberAddition:
          type: string
          description: Housenumber addition
          example: bis
        formattedAddress:
          type: array
          description: Full formatted address according to PostNL standard (returns each line as a separate string)
          items:
            type: string
          example:
          - Molengraaffplantsoen 74
          - 3571ZZ UTRECHT
    postalcodeCheckResponse:
      type: array
      description: Array of addresses found. If no exact match is available, multiple addresses will be returned.
      items:
        $ref: '#/components/schemas/postalcodeCheckAddress'
    postalcodeCheckError:
      type: object
      properties:
        status:
          type: string
          example: '400'
        title:
          type: string
          example: Bad request
        detail:
          type: string
          example: Input field 'housenumber' must be a number
    Unauthorized:
      type: object
      properties:
        message:
          type: string
          example: Failed to resolve API Key variable 'request.header.apikey'
        http_status_code:
          type: number
          example: 401
    InternalServerError:
      type: object
      properties:
        fault:
          type: object
          properties:
            faultstring:
              type: string
              example: Unexpected token in object literal
            detail:
              type: object
              properties:
                errorcode:
                  type: string
                  example: Validation Fault
    TooManyRequests:
      type: object
      properties:
        message:
          type: string
          example: Too many requests. Rate limit exceeded!
        http_status_code:
          type: number
          example: 429
    postalcodeCheckResponseInvalid:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/postalcodeCheckError'
    MethodNotAllowedOnlyGetPost:
      type: object
      properties:
        message:
          type: string
          example: Only GET & POST requests allowed
        http_status_code:
          type: number
          example: 405
  examples:
    cpcSuccessSingleAddress:
      value:
      - city: UTRECHT
        postalCode: 3571ZZ
        streetName: Molengraaffplantsoen
        houseNumber: 74
        houseNumberAddition: bis
        formattedAddress:
        - Molengraaffplantsoen 74 bis
        - 3571ZZ UTRECHT
    cpcSuccessNoAddress:
      value: []
    cpcSuccessMultipleAddresses:
      value:
      - city: UTRECHT
        postalCode: 3532VA
        streetName: Bilderdijkstraat
        houseNumber: 9
        formattedAddress:
        - Bilderdijkstraat 9
        - 3532VA UTRECHT
      - city: UTRECHT
        postalCode: 3532VA
        streetName: Bilderdijkstraat
        houseNumber: 9
        houseNumberAddition: A
        formattedAddress:
        - Bilderdijkstraat 9 A
        - 3532VA UTRECHT
      - city: UTRECHT
        postalCode: 3532VA
        streetName: Bilderdijkstraat
        houseNumber: 9
        houseNumberAddition: ABS
        formattedAddress:
        - Bilderdijkstraat 9 ABS
        - 3532VA UTRECHT
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      name: apikey
      in: header