Skip to main content
Scoping is a mechanism in OAuth 2.0 to limit an application’s access to the portal of a MijnKlantportaal user. When asking the user for permission to access his/her portal, you have to provide the areas/data (scopes) you want to get access to, as well if you want just to read the data (*.read) or also be able to create, delete and/or make changes to it (*.write).

Available scopes

ScopeDescription
agreements.readGetting the agreements and the documents related to it.
agreements.writeCreating and deleting agreements
appointments.readGetting the appointments, both planned as pending records
appointments.writeScheduling, changing, and canceling appointments
businessoperations.readGetting the invoices sent to the user from MijnKlantportaal
customers.readGetting the customers, and their data, and customer groups
customers.writeCreating, editing and deleting customers and customer groups
files.readGetting files and be able to download them
files.writeUploading and deleting files
filerequest.readGetting file requests and the records of delivered files (not able to download)
filerequest.writeCreating and deleting file requests
fileshare.readGetting the file share records and so see what files have been shared
fileshare.writeSharing existing files with customers or via a public link
offers.readGetting the offers in MijnKlantportaal and the PDF of it
offers.writeBeing able to create new offers and/or upload new offer PDFs for customers, as well marking existing once accepted or declined
invoices.readGetting the invoices in MijnKlantportaal and the PDF of it
paymentlinks.readGetting the payment links and it’s corresponding payments
paymentlinks.writeCreating new payment links and being able to close existing once
subscription.readGetting the subscriptions in MijnKlantportaal
subscription.writeCreating, editing and deleting subscriptions in MijnKlantportaal
tickets.readGetting and reading support tickets
tickets.writeBeing able to respond to support tickets and close them (marking as done)
webhooks.readListing and getting the webhooks which are created and set up
webhooks.writeCreating new webhooks and being able to delete existing once
I