General

PiM is an identification service from KPN. You can use PiM to retrieve verified consumer data, ensuring you know who you do business with.

Each consumer creates an account within the PiM app, and verifies the data in the app. Via a DataRequest with action "Generate", you can specify which information you want to retrieve. This will create a QR code, which the consumer can scan. After approving to share the requested data, a new DataRequest with action "Verify" is created, sharing all shared information.

Generate

With the action Generate you can create a QR code that consumers can scan. Within the Generate action, you can specify which fields you want to retrieve.

View in playground

Request


JSON Gateway request

JSON

copy
{
  "Currency": "EUR",
  "Services": {
    "Global": null,
    "ServiceList": [
      {
        "Name": "pim",
        "Action": "generate",
        "Parameters": [
          {
            "Name": "Description",
            "Value": "Omschrijving"
          },
          {
            "Name": "Title",
            "Value": "Titel"
          },
          {
            "Name": "ReturnNickname",
            "Value": "true"
          },
          {
            "Name": "ReturnInitials",
            "Value": "false"
          },
          {
            "Name": "ReturnFirstname",
            "Value": "true"
          },
          {
            "Name": "ReturnLastnamePrefix",
            "Value": "false"
          },
          {
            "Name": "ReturnLastname",
            "Value": "true"
          },
          {
            "Name": "ReturnBirthnamePrefix",
            "Value": "false"
          },
          {
            "Name": "ReturnBirthname",
            "Value": "true"
          },
          {
            "Name": "ReturnDateOfBirth",
            "Value": "true"
          },
          {
            "Name": "ReturnGender",
            "Value": "true"
          },
          {
            "Name": "ReturnEmail",
            "Value": "true"
          },
          {
            "Name": "ResultTitle",
            "Value": "succes"
          },
          {
            "Name": "ResultText",
            "Value": "bedankt"
          }
        ]
      }
    ]
  }
}

Response


JSON Gateway response

JSON

copy
{
    "Key": "F61EDB9DD25946BDBE1A2DC1XXXXXXXX",
    "Status": {
        "Code": {
            "Code": 190,
            "Description": "Success"
        },
        "SubCode": {
            "Code": "S990",
            "Description": "The request was successful."
        },
        "DateTime": "2021-07-14T11:40:34"
    },
    "RequiredAction": null,
    "Services": [
        {
            "Name": "PiM",
            "Action": null,
            "Parameters": [
                {
                    "Name": "redirectUrl",
                    "Value": "https://m.pim.app/?m=buck129&k=F61EDB9DD25946BDBE1A2DC1CA5CBBB6&t=Titel&a=ZZ&d=Omschrijving&r=NFF2L4DGE&s=1kxQXugk_QbPELgYfbjkHc9fo2Mki-t-Are-BU2xxxxxx"
                },
                {
                    "Name": "qrUrl",
                    "Value": "https://static.buckaroo.nl/qr/v1/aHR0cHM6Ly9tLnBpbS5hcHAvP209YnVjazEyOSZrPUY2MUVEQjlERDI1OTQ2QkRCRTFBMkRDMUNBNUNCQkI2JnQ9VGl0ZWwmYT1aWiZkPU9tc2NocmlqdmluZyZyPU5GRjJMNERHRSZzPTFreFFYdWdrX1FiUEVMZ1lmYmprSGM5Zm8yTWtpLXQtQXJlLUJVMm52xxxxxx=="
                }
            ]
        }
    ],
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "ServiceCode": "PiM",
    "IsTest": false,
    "ConsumerMessage": null
}

Push


Verify

When the consumer scans a QR code and shares his data, a new Datarequest with action "Verify" is created. On this action, all consumer information is saved and then pushed to the merchant.

Push


JSON Push response

JSON

copy
{
   "DataRequest":{
      "Key":"641A1B3FD2684CAF8C4E2638XXXXXXXX",
      "Invoice":null,
      "ServiceCode":"PiM",
      "ActionCode":"Verify",
      "Status":{
         "Code":{
            "Code":190,
            "Description":"The request was successful."
         },
         "SubCode":null,
         "DateTime":"2021-02-10T07:18:45"
      },
      "IsTest":false,
      "Order":null,
      "Currency":null,
      "AmountDebit":0.0,
      "Services":[
         {
            "Name":"PiM",
            "Action":null,
            "Parameters":[
               {
                  "Name":"Nickname",
                  "Value":"John Doe"
               },
               {
                  "Name":"Birthname",
                  "Value":"Doe"
               },
               {
                  "Name":"Dateofbirth",
                  "Value":"1984-01-01"
               },
               {
                  "Name":"Gender",
                  "Value":"Male"
               },
               {
                  "Name":"Email",
                  "Value":"JohnDoe@gmail.com"
               }
            ],
            "VersionAsProperty":1
         }
      ],
      "CustomParameters":null,
      "AdditionalParameters":null,
      "MutationType":0,
      "IssuingCountry":null,
      "StartRecurrent":false,
      "Recurring":false,
      "CustomerName":null,
      "PayerHash":null,
      "PaymentKey":null
   }
}