KPN Default API
The default API from KPN — 6 operation(s) for default.
KPN Default API is one of 104 APIs that KPN publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and pricing.
This API exposes 6 operations across 6 paths, and defines 85 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 4 base URLs: https://api-prd.kpn.com/network/kpn/disturbance-check, https://api-prd.kpn.com/network/kpn/internet-speed-check, https://api-prd.kpn.com/wba, https://api-prd.kpn.com/wba/adresses.
6 operations
6 paths
85 schemas
5 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
KPN Default API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the clientCredentials flow.
Paths & Operations 6
Across 6 paths, the API surfaces 6 operations — 5 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
default 6
GET
/address
get info
POST
/offer
get info
GET
/fpi/addresses
Retrieves Functional Product Information
GET
/cip/addresses
Retrieves Carrier Information Product
GET
/functional-products
Functional Product Information
GET
/carriers
Carrier Information Product
Schemas 85
The contract defines 85 schemas that model the data the API accepts and returns. The most detailed are FiberInfo (11 properties), enduserinfo-fpi-schema (7 properties), enduserinfo-fpi-schema_2 (6 properties), planneduserinfo-schema (5 properties). Each schema is shown below with its type and property counts.
fixed
array
broadband
array
mobile
array
generic
array
error
object
5 properties
search
object
4 properties
alert
object
3 properties
FiberInfo
object
11 properties
FixedInfo
object
4 properties
offer_object
object
5 properties
zipcode-schema
string
actualuserinfo-schema
object
This object is copied from the user provided address (requested address). This container is not filled when an error is returned.
5 properties
odf-connection-id-schema
string
Current odf connection id: For carrier-vendor-id REGG, this field is filled with the current ODF ConnectionID. Future odf connection id: For carrier-vendor-id…
bandwidth-down-schema
string
This field provides the expected actual down bitrate in kbps, i.e. the actual bitrate as defined in the corresponding technology standard for an xDSL modem or…
diy-allowed-schema
string
The Area PoP location can be managed by Reggefiber and DiY is not allowed in this case. Possible values are: - false (DiY is not allowed, this Area PoP and ord…
san-only-schema
string
SAN-only indicates that a copper connection to the house is planned but is built on customer request only. Tariff is according to NL type 1, but different lead…
planned_user-street-schema
string
bandwidth-up-schema
string
This field provides the expected actual up bitrate in kbps, i.e. the actual bitrate as defined in the corresponding technology standard for an xDSL modem or a…
plandate-reliability-schema
string
Presentation of a plandate and reliability is in the following format: - Week reliability: field is filled with “dd-mm-yyyy” (NEN ISO 8601 date format) - Month…
copperinfo-schema
object
This object is present in the response for physical-carrier “Copper” and will be returned when requested address has copper connections.
4 properties
status-connection-schema
string
The field “status-connection” is filled with: 0: Operational, in use 1: Broadband order in progress 2: Telephony order in progress 3: Terminate broadband order…
note-schema
string
Note field contains additional information for ordering such as complex address.
availability-schema
string
This field indicates the availability per technology type. A technology type can be Open (O), Planned (P), Closed (C) or Temporary Closed (TC). A technology ty…
has-date-schema
string
Home connection: Date at which an appointment is made with end-user to install the fiber, including FTU-Type, in the home / building. Has-date is only provided…
technologyavailability-schema
array
The technologyavailability array can have multiple occurrences. Available technology types, bitrates with reliability are shown.
housenumber-schema
string
reliability-schema
string
This field is the probability of the bitrate up and down that can be achieved with a specific technology type. The probability is an indication for the reliabi…
errorcode-schema
integer
If the errorcode is not equal to 0, there was an error in the validations and the information request could not be fulfilled. This can be syntax errors on the…
phonenumber-schema
string
Main phonenumber: Identifies the phone number on which the access may be ordered. Can be different from input in case of ISDN2. example: 0201234567 Current, Fu…
fiber-terminationpoint-id-schema
string
This is the identification of the fiber termination point on the customer address (for Reggefiber: Room). There may be more fiber-terminationpoint-ids on an en…
technology-type-schema
string
This field contains the technology type. When provided a technology type as part of the request make sure to url encode it, e.g. ADSL2+POTS becomes ADSL2%2BPOT…
carrier-status-schema
string
In case of a full match, the carrier status for each carrier-vendor will be shown. For carrier-vendor MDF/SDF, carrier-status will be Open or Planned (e.g. Hig…
soft-connect-possible-schema
string
Soft-connect-possible indication will be returned when the connection to the DSLAM port was not removed (soft-cease). This is currently only applicable on Copp…
patchless-possible-schema
string
Patchless-possible is used for Coper and Fiber Technology types. Patchless-possible is set to true to indicate that the related technology type is supported by…
number-of-nl-lines-schema
string
Number of NL1 lines: Number of NL type 1 copper connections on the ISRA (with or without services) Number of NL2 lines: Number of NL type 2 copper connections…
cable-length-schema
string
Length of the copper cable connection (in meters) which can be used to determine NLS-type 3 category. In case this length =25m and no free copper pairs are ava…
typeofconnection-schema
string
This field is filled with the (current or future) type of connection. 0: Not in use 1: Fixed Line service 2: Telephony service 3: MDF Broadband service (1 xdf-…
planneduserinfo-schema
object
The “planned” user-info is the customer address from installed base. Zipcode and housenumber may be corrected in case a phonenumber or xdf-access-serviceid was…
5 properties
power-outlet-available-schema
string
Indication for availability of a power outlet. Possible values are: - NO - YES - UNKNOWN
ftu-type-schema
string
The FTU is used for installation of the NT (Network Termination device) at the customer premises. FPI provides the ftu-type to be installed at the customer loc…
commentcode-schema
string
Commentcodes are never blocking but meant to inform the WSO about certain situations. Information about commentcodes can be found in the document WBA Fulfillme…
telephonytype-schema
string
This field is filled with the type of the telephony service: POTS, ISDN, MI, MP. MI = multiple ISDN, MP = multiple POTS. Current telephonytype: If current-phon…
xdf-access-serviceid-schema
string
Copperinfo: In case a phonenumber was specified and it is a shared line service, (broadband and POTS/ISDN telephony), this field is filled with xDF-access-serv…
physical-carrier-schema
string
carriervendor-cip-schema
array
construction-type-schema
string
Possible values for this field are: - EXISTINGCONSTRUCTION (“bestaande bouw”) - NEWCONSTRUCTION (“nieuwbouw”) - UNKNOWN
cgb-name-schema
string
This is the MDF-location where the end-user address is connected to.
isra-pin-schema
string
In case xDF-access-serviceid was provided, ISRA pin can be shown in output. “isra-pin” (or stift number) is a numeric field with leading zero’s.
isra-specs-schema
string
The ISRA specs of a copper termination point of the customer address, connected to the Distribution Point
bonding-allowed-schema
string
Bonding allowed information is mainly based on the quality of the copper cable and must not be confused with free available copper pairs. Refer to the table be…
connectionpointnumber-schema
string
supported-on-current-nt-schema
string
Only filled for PON based technologies.
current-nt-type-schema
string
The nt-type as found in the inventory. This might either be an active line of an inactive line.
service-group-schema
string
The service-group is a reference to the existing WBA service. The service-group is used for migration orders and for changes in existing WBA service of a WSO.
enduserinfo-cip-schema
object
The requested elements are echoed from the input. Optional field requested-phonenumber is included, since this may be a different phonenumber (i.e. an ISDN-2 s…
4 properties
2 required
nl-type-schema
string
The nl-type (NewLineService type) is only shown for carrier-type Fiber and cannot be shown for Copper. It describes the status of pre-provisioned physical fibe…
technologyreliability-schema
array
plan-date-schema
string
The plan-date will only be provided for a carrier-status Planned. For carrier-vendor MDF/SDF plan-date is only provided when there is a full match. For carrier…
mdf-cable-length-schema
string
The total length from MDF to the end of the cable. The house connection cable, having a separate cable-length is connected on any point in the distribution cab…
access-area-id-schema
string
An Access Area consists of a set of locations with DSLAMs connected to the Ethernet Transport Network.
carriervendor-fpi-schema
array
housenrext-schema
string
network-provider-schema
string
This is the network provider (owner of the network) of the passive connection. In case of KPN this field is filled with KPN Network NL.
ftu-close-to-isra-schema
string
Possible values are: true, false
fiberinfo-schema
object
This object is present in the message for physical-carrier “Fiber”.
3 properties
asw-schema
string
Access Stability Value (ASW) is a broadband performance indicator from 1 (‘bad line’) to 10 (‘excellent line’). ASW is applicable for xDSL technology types on…
planned-user-city-schema
string
enduserinfo-fpi-schema
object
This container has the address details with xdf-access-serviceid, connectionpointnumber and fiber-terminationpoint-id as provided in the FPI request. The field…
7 properties
2 required
location-ftu-schema
string
Location of the FTU. This can have the following values: - METERBOX - LIVINGROOM - BASEMENT - OTHER
carrier-vendor-id-schema
string
The carrier-vendor is the provider of the WBA physical carrier between DSLAM port and customer location, i.e.: - Copper carrier: MDF, SDF - Fiber carrier: REGG…
areapop-schema
string
This field is filled with the AreaPoP (PoP location of the carrier vendor Fiber) connected to the customers address.
actualuserinfo-schema_2
object
This object is copied from the user provided address (requested address). This container is not filled when an error is returned.
3 properties
copperinfo-schema_2
object
This object is present in the response for physical-carrier “Copper” and will be returned when requested address has copper connections.
4 properties
technologyavailability-schema_2
array
The technologyavailability array can have multiple occurrences. Available technology types, bitrates with reliability are shown.
street-schema
string
errorcode-schema_2
integer
If the errorcode is not equal to 0, there was an error in the validations and the information request could not be fulfilled. This can be syntax errors on the…
planneduserinfo-schema_2
object
The “planned” user-info is the customer address from installed base. Zipcode and housenumber may be corrected in case a phonenumber or xdf-access-serviceid was…
5 properties
commentcode-schema_2
string
Commentcodes are never blocking but meant to inform the WSO about certain situations. Following commentcodes are defined for Carrier Info requests: - The Reque…
originator-schema
string
technologyreliability-schema_2
array
carriervendor-fpi-schema_2
array
requested-address-schema
object
3 properties
2 required
city-schema
string
fiberinfo-schema_2
object
This object is present in the message for physical-carrier “Fiber”.
3 properties
enduserinfo-fpi-schema_2
object
This container has the address details with xdf-access-serviceid, connectionpointnumber and fiber-terminationpoint-id as provided in the FPI request. The field…
6 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from KPN 12
Other APIs KPN publishes across the network.
KPN GRIP API
KPN PIM ID API
KPN SMS Campaigns API
KPN Email-to-SMS API
KPN Account API
KPN Activation API
KPN Alarm API
KPN Appliance.configure API
KPN Appliance.monitor API
KPN Application API
KPN Application Keys API
KPN Applications API
Where this information came from
This is an independent, third-party profile of KPN Default API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.