KPN Default API

openapi: 3.2.0
info:
  title: Kpn Default API
  contact:
    name: API Support
    email: api_developer@kpn.com
    url: https://developer.kpn.com/support
  termsOfService: https://developer.kpn.com/legal
  version: '1.0'
  description: 'Operations tagged default across 4 of this provider''s published API definitions: kpn-disturbance-check-openapi.yml, kpn-internet-speed-check-openapi.yml, kpn-wholesale-broadband-access-fpi-cip-openapi.yml, kpn-wholesale-wba-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-prd.kpn.com/network/kpn/disturbance-check
- url: https://api-prd.kpn.com/network/kpn/internet-speed-check
- url: https://api-prd.kpn.com/wba
- url: https://api-prd.kpn.com/wba/adresses
tags:
- name: default
  description: ''
paths:
  /address:
    get:
      tags:
      - default
      summary: get info
      description: Retrieves the information about internet connection and technology for the given address identified by postcode, house number and house extension.
      security:
      - oauth2: []
      parameters:
      - $ref: '#/components/parameters/api_version'
      - $ref: '#/components/parameters/zip_code_query'
      - $ref: '#/components/parameters/house_number_query'
      - $ref: '#/components/parameters/house_number_extension_query'
      responses:
        '200':
          $ref: '#/components/responses/success'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '429':
          $ref: '#/components/responses/too_many'
        '500':
          $ref: '#/components/responses/server_error'
        '503':
          $ref: '#/components/responses/service_unavailable'
    servers:
    - url: https://api-prd.kpn.com/network/kpn/disturbance-check
  /offer:
    post:
      tags:
      - default
      summary: get info
      description: Retrieves the information about internet connection and technology for the given address identified by postcode, house number and house extension
      security:
      - oauth2: []
      parameters:
      - $ref: '#/components/parameters/api_version'
      - $ref: '#/components/parameters/api_version_query'
      requestBody:
        description: request body properties
        content:
          application/json:
            schema:
              type: object
              properties:
                service_address:
                  type: object
                  properties:
                    house_number:
                      type: integer
                      description: House number you want to check
                    zip_code:
                      type: string
                      description: The Postcode you want to check
                    house_number_extension:
                      type: string
                      description: The extension of the house, if provided.
                  required:
                  - house_number
                  - zip_code
      responses:
        '200':
          $ref: '#/components/responses/success_2'
    servers:
    - url: https://api-prd.kpn.com/network/kpn/internet-speed-check
  /fpi/addresses:
    get:
      summary: Retrieves Functional Product Information
      tags:
      - default
      security:
      - oauth2: []
      description: "This API is in line with WBA FPI v26.\n\nThe Functional Product Information (FPI) service is used to provide WBA access information for new and existing WBA connections. FPI provides carrier vendor information and WBA technology availability with actual up and down bitrates with a reliability per technology type. The reliability is defined as the probability that the bitrate can be achieved and is only applicable for WBA connections on copper lines. The provided reliability in FPI is within 50% to 100%. The reliability for fiber WBA connections is always 100%. It is allowed to request different reliability per copper technology type.\n\nAn address is mandatory in the FPI request.\nFor an existing WBA broadband connection, the WSO specifies the `xdf-access-serviceid`, provided by KPN when the connection was delivered. The `xdf-access-serviceid` is the unique identifier for the current access connection. The bitrates up/down are determined by measurement on the broadband connection of the `xdf-access-serviceid`.\n\nAn address can have one or more carrier vendors. FPI provides information for the following carrier vendors:\n- MDF: WBA services on copper lines from central office (MDF)\n- SDF: WBA services on copper lines from street cabinet (SDF)\n- REGG: WBA Fiber to the Home (FttH) services from Reggefiber\n- KPNFO: WBA Fiber to the Office (FttO) services form KPNFO\n\nThe API request should be of the form: `/fip/addresses?{query-parameters}`.\n\nExample without URL encoding: \n\n`/fpi/addresses?requested-zipcode=1234AB&requested-housenumber=12&requested-housenrext=A&connectionpointnumber=001&technologyreliability=[{\"technology-type\":\"ADSL2+_ISDN\",\"reliability\":\"80\"},{\"technology-type\":\"GPON\"}]`\n\nExample with URL encoding: \n\n`/fpi/addresses?requested-zipcode=1234AB&requested-housenumber=12&requested-housenrext=A&connectionpointnumber=001&technologyreliability=%5B%7B%22technology-type%22%3A%22ADSL2+_ISDN%22%2C%22reliability%22%3A%2280%22%7D%2C%7B%22technology-type%22%3A%22GPON%22%7D%5D`\n"
      parameters:
      - $ref: '#/components/parameters/requested-zipcode'
      - $ref: '#/components/parameters/requested-housenumber'
      - $ref: '#/components/parameters/requested-housenrext'
      - $ref: '#/components/parameters/connectionpointnumber'
      - $ref: '#/components/parameters/fiber-terminationpoint-id'
      - $ref: '#/components/parameters/xdf-access-serviceid'
      - $ref: '#/components/parameters/technologyreliability'
      - $ref: '#/components/parameters/service-group'
      responses:
        '200':
          description: WBA Functional Product Information response
          content:
            application/json:
              schema:
                type: object
                properties:
                  enduserinfo:
                    $ref: '#/components/schemas/enduserinfo-fpi-schema'
                  actualuserinfo:
                    $ref: '#/components/schemas/actualuserinfo-schema'
                  carriervendor:
                    $ref: '#/components/schemas/carriervendor-fpi-schema'
                  technologyavailability:
                    $ref: '#/components/schemas/technologyavailability-schema'
                  errorinfo:
                    type: object
                    properties:
                      errorcode:
                        $ref: '#/components/schemas/errorcode-schema'
                      commentcode:
                        $ref: '#/components/schemas/commentcode-schema'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '429':
          description: Too many requests
        '500':
          description: Server error
        '502':
          description: Bad gateway
        '503':
          description: Server unavailable
    servers:
    - url: https://api-prd.kpn.com/wba
  /cip/addresses:
    get:
      summary: Retrieves Carrier Information Product
      description: "This API is in line with WBA CIP v46.\n\nThe Carrier Information Product (CIP) service provides information about the infrastructure and active services on the physical connection of a customer address. For physical carrier Copper, the ISRA with current and future connection details of all copperlines are shown. For physical carrier Fiber, all fiber-terminationpoints are shown including current and future connection details. To support WSO’s clean order process, a list of house number extensions per carrier-vendor will be provided in case of a wrong or missing housenumber extension and there are no other identifiers (i.e. phone number or xdf-access-service-id) specified for the connection.\n\nThe Carrier Information service can be used for several scenarios:\n1. Scenario for an address connected to physical carrier Copper. User creates a CIP request for physical carrier Copper and the connection details for the copper connection will be shown\n2. Scenario for an address connected to physical carrier Fiber. User creates a CIP request for physical carrier Fiber and the connection details for the fiber connection will be shown\n3. Scenario for an address connected to both Copper and Fiber. User creates a CIP request without specifying physical carrier (empty field) and the connection details for the copper and fiber connection will be shown.\n\nWhen the user requests information for a Copper carrier, an optional phonenumber, xdf-service-id or a connectionpointnumber can be provided. The Carrier Info Product provides current and future type of services on all copper lines of the ISRA-connectionpoint. Note that there may be more than one ISRA-connectionpoints on the customer’s address. \n\nIn case one or two ISRA-connectionpoints exists, all connection details of those ISRA’s will be shown. If more than two ISRA-connectionpoints exist, the list of ISRA’s is shown without connection details and errorcode 642 will be returned When the user requests information for a Fiber carrier, an optional fiber-terminationpoint-id can be provided. The Carrier Info Product provides current and future type of services on the specified fiber-terminationpoint-id. If no fiber-terminationpoint was specified, the Carrier Info Service provides current and future type of services on all fiber-terminationpoints.\n\nThe API request should be of the form: `/cip/addresses?{query-parameters}`.\n\nExample: \n\n`/cip/addresses?requested-zipcode=1234AB&requested-housenumber=12&requested-housenrext=A&connectionpointnumber=001`\n"
      tags:
      - default
      security:
      - oauth2: []
      responses:
        '200':
          description: WBA Carrier Information Product response
          content:
            application/json:
              schema:
                type: object
                properties:
                  enduserinfo:
                    $ref: '#/components/schemas/enduserinfo-cip-schema'
                  planneduserinfo:
                    $ref: '#/components/schemas/planneduserinfo-schema'
                  carriervendor:
                    $ref: '#/components/schemas/carriervendor-cip-schema'
                  copperinfo:
                    $ref: '#/components/schemas/copperinfo-schema'
                  fiberinfo:
                    $ref: '#/components/schemas/fiberinfo-schema'
                  errorinfo:
                    type: object
                    properties:
                      errorcode:
                        $ref: '#/components/schemas/errorcode-schema'
                      commentcode:
                        $ref: '#/components/schemas/commentcode-schema'
                      note:
                        $ref: '#/components/schemas/note-schema'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '429':
          description: Too many requests
        '500':
          description: Server error
        '502':
          description: Bad gateway
        '503':
          description: Server unavailable
      parameters:
      - $ref: '#/components/parameters/requested-zipcode'
      - $ref: '#/components/parameters/requested-housenumber'
      - $ref: '#/components/parameters/requested-housenrext'
      - $ref: '#/components/parameters/physical-carrier'
      - $ref: '#/components/parameters/requested-phonenumber'
      - $ref: '#/components/parameters/copper-xdf-access-serviceid'
      - $ref: '#/components/parameters/connectionpointnumber'
      - $ref: '#/components/parameters/fiber-terminationpoint-id'
      - $ref: '#/components/parameters/fiber-xdf-access-serviceid'
    servers:
    - url: https://api-prd.kpn.com/wba
  /functional-products:
    get:
      summary: Functional Product Information
      tags:
      - default
      description: "This API is in line with WBA FPI v24.\n\nThe Functional Product Information (FPI) service is used to provide WBA access information for new and existing WBA connections. FPI provides carrier vendor information and WBA technology availability with actual up and down bitrates with a reliability per technology type. The reliability is defined as the probability that the bitrate can be achieved and is only applicable for WBA connections on copper lines. The provided reliability in FPI is within 50% to 100%. The reliability for fiber WBA connections is always 100%. It is allowed to request different reliability per copper technology type.\n\nAn address is mandatory in the FPI request.\nFor an existing WBA broadband connection, the WSO specifies the xdf-access-serviceid, provided by KPN when the connection was delivered. The xdf-access-serviceid is the unique identifier for the current access connection. The bitrates up/down are determined by measurement on the broadband connection of the xdf-access-serviceid.\n\nAn address can have one or more carrier vendors. FPI provides information for the following carrier vendors:\n- MDF: WBA services on copper lines from central office (MDF)\n- SDF: WBA services on copper lines from street cabinet (SDF)\n- REGG: WBA Fiber to the Home (FttH) services from Reggefiber\n- KPNFO: WBA Fiber to the Office (FttO) services form KPNFO\n\nThe API request should be of the form `/wba/addresses/{requested-address}/functional-products?{query-parameters}`.\n\nExample with URL encoding: \n\n`/wba/addresses/requested-zipcode%3D1234AB%2Crequested-housenumber%3D12%2Crequested-housenrext%3DA/functional-products?connectionpointnumber=001&technologyreliability=%5B%7B%22technology-type%22%3A%22ADSL2+_ISDN%22%2C%22reliability%22%3A%2280%22%7D%2C%7B%22technology-type%22%3A%22GPON%22%7D%5D`\n"
      parameters:
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/requested-address'
      - $ref: '#/components/parameters/connectionpointnumber'
      - $ref: '#/components/parameters/fiber-terminationpoint-id'
      - $ref: '#/components/parameters/xdf-access-serviceid_2'
      - $ref: '#/components/parameters/technologyreliability_2'
      responses:
        '200':
          description: WBA Functional Product Information response
          content:
            application/json:
              schema:
                type: object
                properties:
                  enduserinfo:
                    $ref: '#/components/schemas/enduserinfo-fpi-schema_2'
                  actualuserinfo:
                    $ref: '#/components/schemas/actualuserinfo-schema_2'
                  carriervendor:
                    $ref: '#/components/schemas/carriervendor-fpi-schema_2'
                  technologyavailability:
                    $ref: '#/components/schemas/technologyavailability-schema_2'
                  errorinfo:
                    type: object
                    properties:
                      errorcode:
                        $ref: '#/components/schemas/errorcode-schema_2'
                      commentcode:
                        $ref: '#/components/schemas/commentcode-schema_2'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        403:
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        404:
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        429:
          description: too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        500:
          description: server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
    servers:
    - url: https://api-prd.kpn.com/wba/adresses
  /carriers:
    get:
      summary: Carrier Information Product
      description: "This API is in line with WBA CIP v44.\n\nThe Carrier Information Product (CIP) service provides information about the infrastructure and active services on the physical connection of a customer address. For physical carrier Copper, the ISRA with current and future connection details of all copperlines are shown. For physical carrier Fiber, all fiber-terminationpoints are shown including current and future connection details. To support WSO’s clean order process, a list of house number extensions per carrier-vendor will be provided in case of a wrong or missing housenumber extension and there are no other identifiers (i.e. phone number or xdf-access-service-id) specified for the connection.\n\nThe Carrier Information service can be used for several scenarios:\n1. Scenario for an address connected to physical carrier Copper. User creates a CIP request for physical carrier Copper and the connection details for the copper connection will be shown\n2. Scenario for an address connected to physical carrier Fiber. User creates a CIP request for physical carrier Fiber and the connection details for the fiber connection will be shown\n3. Scenario for an address connected to both Copper and Fiber. User creates a CIP request without specifying physical carrier (empty field) and the connection details for the copper and fiber connection will be shown.\n\nWhen the user requests information for a Copper carrier, an optional phonenumber, xdf-service-id or a connectionpointnumber can be provided. The Carrier Info Product provides current and future type of services on all copper lines of the ISRA-connectionpoint. Note that there may be more than one ISRA-connectionpoints on the customer’s address. In case one or two ISRA-connectionpoints exists, all connection details of those ISRA’s will be shown. If more than two ISRA-connectionpoints exist, the list of ISRA’s is shown without connection details and errorcode 642 will be returned When the user requests information for a Fiber carrier, an optional fiber-terminationpoint-id can be provided. The Carrier Info Product provides current and future type of services on the specified fiber-terminationpoint-id. If no fiber-terminationpoint was specified, the Carrier Info Service provides current and future type of services on all fiber-terminationpoints.\n\nThe API request should be of the form `/wba/addresses/{requested-address}/carriers?{query-parameters}`. \n\nExample without URL encoding: \n\n`/wba/addresses/requested-zipcode=1234AB,requested-housenumber=12,requested-housenrext=A/carriers?connectionpointnumber=001`\n\nExample with URL encoding: \n\n`/wba/addresses/requested-zipcode%3D1234AB%2Crequested-housenumber%3D12%2Crequested-housenrext%3DA/carriers?connectionpointnumber=001`\n"
      tags:
      - default
      responses:
        '200':
          description: WBA Carrier Information Product response
          content:
            application/json:
              schema:
                type: object
                properties:
                  enduserinfo:
                    $ref: '#/components/schemas/enduserinfo-cip-schema'
                  planneduserinfo:
                    $ref: '#/components/schemas/planneduserinfo-schema_2'
                  carriervendor:
                    $ref: '#/components/schemas/carriervendor-cip-schema'
                  copperinfo:
                    $ref: '#/components/schemas/copperinfo-schema_2'
                  fiberinfo:
                    $ref: '#/components/schemas/fiberinfo-schema_2'
                  errorinfo:
                    type: object
                    properties:
                      errorcode:
                        $ref: '#/components/schemas/errorcode-schema_2'
                      commentcode:
                        $ref: '#/components/schemas/commentcode-schema_2'
                      note:
                        $ref: '#/components/schemas/note-schema'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        403:
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        404:
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        429:
          description: too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        500:
          description: server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/requested-address'
      - $ref: '#/components/parameters/physical-carrier'
      - $ref: '#/components/parameters/requested-phonenumber'
      - $ref: '#/components/parameters/xdf-access-serviceid_2'
      - $ref: '#/components/parameters/connectionpointnumber'
      - $ref: '#/components/parameters/fiber-terminationpoint-id'
    servers:
    - url: https://api-prd.kpn.com/wba/adresses
components:
  schemas:
    fixed:
      type: array
      items:
        type: object
        properties:
          id:
            type: integer
            description: Identifier
          affected_elements_count:
            type: integer
            description: affected elements count
          affected_customers_count:
            type: integer
            description: affected customers count
          communicated_customers_sms_count:
            type: integer
            description: communicated customers sms count
          communicated_customers_email_count:
            type: integer
            description: communicated customers email count
          type:
            type: string
            description: type
          cause:
            type: string
            description: cause
          source:
            type: string
            description: affected customers count
          service:
            type: string
            description: service
          state:
            type: string
            description: affected customers count
          start_date:
            type: string
            description: start date
          end_date:
            type: string
            description: end date
          region:
            type: string
            description: region
          description:
            type: string
            description: description
          long_description:
            type: string
            description: long description
          serviceguard_ticket_id:
            type: string
            description: serviceguard ticket id
          created_at:
            type: string
            description: created at
          communication_type:
            type: string
            description: communication type
          user:
            type: string
            description: user
    broadband:
      type: array
      items:
        type: object
        properties:
          id:
            type: integer
            description: Identifier
          affected_elements_count:
            type: integer
            description: affected elements count
          affected_customers_count:
            type: integer
            description: affected customers count
          communicated_customers_sms_count:
            type: integer
            description: communicated customers sms count
          communicated_customers_email_count:
            type: integer
            description: communicated customers email count
          type:
            type: string
            description: type
          cause:
            type: string
            description: cause
          source:
            type: string
            description: affected customers count
          service:
            type: string
            description: service
          state:
            type: string
            description: affected customers count
          start_date:
            type: string
            description: start date
          end_date:
            type: string
            description: end date
          region:
            type: string
            description: region
          description:
            type: string
            description: description
          long_description:
            type: string
            description: long description
          serviceguard_ticket_id:
            type: string
            description: serviceguard ticket id
          created_at:
            type: string
            description: created at
          communication_type:
            type: string
            description: communication type
          user:
            type: string
            description: user
    mobile:
      type: array
      items:
        type: object
        properties:
          id:
            type: integer
            description: Identifier
          affected_elements_count:
            type: integer
            description: affected elements count
          affected_customers_count:
            type: integer
            description: affected customers count
          communicated_customers_sms_count:
            type: integer
            description: communicated customers sms count
          communicated_customers_email_count:
            type: integer
            description: communicated customers email count
          type:
            type: string
            description: type
          cause:
            type: string
            description: cause
          source:
            type: string
            description: affected customers count
          service:
            type: string
            description: service
          state:
            type: string
            description: affected customers count
          start_date:
            type: string
            description: start date
          end_date:
            type: string
            description: end date
          region:
            type: string
            description: region
          description:
            type: string
            description: description
          long_description:
            type: string
            description: long description
          serviceguard_ticket_id:
            type: string
            description: serviceguard ticket id
          created_at:
            type: string
            description: created at
          communication_type:
            type: string
            description: communication type
          user:
            type: string
            description: user
    generic:
      type: array
      items:
        type: object
        properties:
          id:
            type: integer
            description: Identifier
          affected_elements_count:
            type: integer
            description: affected elements count
          affected_customers_count:
            type: integer
            description: affected customers count
          communicated_customers_sms_count:
            type: integer
            description: communicated customers sms count
          communicated_customers_email_count:
            type: integer
            description: communicated customers email count
          type:
            type: string
            description: type
          cause:
            type: string
            description: cause
          source:
            type: string
            description: affected customers count
          service:
            type: string
            description: service
          state:
            type: string
            description: affected customers count
          start_date:
            type: string
            description: start date
          end_date:
            type: string
            description: end date
          region:
            type: string
            description: region
          description:
            type: string
            description: description
          long_description:
            type: string
            description: long description
          serviceguard_ticket_id:
            type: string
            description: serviceguard ticket id
          created_at:
            type: string
            description: created at
          communication_type:
            type: string
            description: communication type
          user:
            type: string
            description: user
    error:
      type: object
      properties:
        transactionId:
          type: string
          description: Transaction id of the the request
          title: Transaction ID
        status:
          type: string
          description: Status
          title: Status
        name:
          type: string
          description: Error name
          title: Error name
        message:
          type: string
          description: Error message
          title: Error message
        info:
          type: string
          description: Additional information about error
          title: Info
    search:
      type: object
      properties:
        broadband:
          $ref: '#/components/schemas/broadband'
        fixed:
          $ref: '#/components/schemas/fixed'
        mobile:
          $ref: '#/components/schemas/mobile'
        generic:
          $ref: '#/components/schemas/generic'
    alert:
      type: object
      properties:
        code:
          type: string
          description: Alert identifier
        description:
          type: string
          description: description of the alert.
        code_message:
          type: string
          description: message related with the alert identifier.
    FiberInfo:
      type: object
      properties:
        thirdparty_delivery:
          title: Thirdparty delivery
          type: boolean
        thirdparty_permission:
          title: Thirdparty permission
          type: boolean
        thirdparty_name:
          title: Thirdparty name
          type: string
          minLength: 1
        construction_type:
          title: Construction type
          type: string
          minLength: 1
        planned_fiber_to_the_home_date:
          title: Planned fiber to the home date
          type: string
          format: date
        planned_fiber_to_the_home_description:
          title: Planned fiber to the home description
          type: string
          minLength: 1
        civil_date:
          title: Civil date
          type: string
          format: date
        wholesale_broadband_access_plan_date:
          title: Wholesale broadband access plan date
          type: string
          format: date
        wholesale_broadband_access_plan_date_description:
          title: Wholesale broadband access plan date description
          type: string
          minLength: 1
        nl_type:
          title: Nl type
          type: string
          minLength: 1
        phase:
          title: Phase
          type: string
          minLength: 1
    FixedInfo:
      type: object
      properties:
        copper_access:
          title: Copper access
          type: boolean
        fiber_access:
          title: Fiber access
          type: boolean
        hybrid_access:
          title: Hybrid access
          type: boolean
        mobile_access:
          title: Mobile access
          type: boolean
    offer_object:
      type: object
      properties:
        available_on_address:
          type: object
          properties:
            technologies:
              type: array
              items:
                type: object
        

# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kpn/refs/heads/main/openapi/kpn-default-api-openapi.yml