Match documentation

Introduction

KPN Match API is to check and verify an identity. This API checks customer data, such as name, address and date of birth, against the same data verified by their own telecom providers. If it matches, they can complete the transaction.

API specification

Test the API on SwaggerHub

Base url

https://api-prd.kpn.com/communication/kpn/

This is the sandbox version of Match API.

Steps to Test the Match API

Below are the steps you can follow to interact with the API, ensuring it works as expected:

1. Get Access to the API

Before anything, make sure you have the necessary credentials to access the API. You need a client_id and client_secret to obtain an access token. If you don't have these credentials yet, you might need to register on the KPN Developer portal and follow the process to get them.

2. Generate an Access Token

Use the /token endpoint to generate an access token.

This token is necessary to authenticate your requests.

Request

Method: POST

URL: https://api-prd.kpn.com/communication/kpn/match/token

Headers: Content-Type: application/json

       Body example
      
        Code copied
        
            
      

{
  "client_id": "your_client_id",
  "client_secret": "your_client_secret",
  "scopes": [
    "mpm"
  ]
}

Enabled scopes:

• mpm

mpm: Mobile to Person Match

Enabled Country:

• NL

Response

On success, you'll get a JSON response with an access token. Copy this token, as you'll need it for the next steps.

3. Prepare the Request for Identity Check

With your access token in hand, you can now make a request to check someone's identity.

Request

Method: POST

URL: https://api-prd.kpn.com/communication/kpn/match/insights/{msisdn}

Replace {msisdn} with the mobile number you want to verify (e.g., 31630000000).

Headers

Authorization: Bearer <your_access_token> (Replace <your_access_token> with the token from Step 2)

Content-Type: application/json

      Body example
      
        Code copied
        
            
      

{
"mpm":{
  "firstname": "Hendricus Johannes",
  "lastname": "van der Vorst-Boomgaard",
  "address1": "237 IV",
  "postal_code": "1012 SB",
  "date_of_birth": "1953-11-23"
  }
}

• Please note that for address1, just the first part of the address is considered for Match and extension is not a part of it.

4. Send the Request

Once you've filled in the required details, send the request. If everything is correct, you should receive a response with the verification results.

Response

       Example 
      
        Code copied
        
            
      

{
  "firstname": "Hendricus Johannes",
  "lastname": "van der Vorst-Boomgaard",
  "address1": "237 IV",
  "postal_code": "1012 SB",
  "date_of_birth": "1953-11-23"
}