API Reference

Release Log

Release 29 July 2025

API Updates

Customers Endpoints

GET /customers and GET /customers/:customerId
  • New fields added:
    • addressFields: A structured address object containing:
      • street
      • houseNumber
      • box
      • postalCode
      • city
      • country
    • customerCode: Code of the customer.
    • registrationNumber: National registration number (e.g., Rijksregisternummer) of the customer.
    • spouseRegistrationNumber: National registration number of the partner of the customer.
  • New filters added in GET /customers:
    • registrationNumber - National registration number (e.g., Rijksregisternummer) of the customer.
    • spouseRegistrationNumber - National registration number of the partner of the customer.
    • language: Preferred language of the customer.
    • responsible: User ID responsible for the customer.
    • email: Email of the customer.

Note: Accessing registrationNumber and spouseRegistrationNumber or filtering by them requires the privacy.read scope.

POST /customers
  • New field supported:
    • customerCode - Code of the customer.
PUT /customers
  • New fields supported for update:
    • customerCode - Code of the customer.
    • responsible - User ID responsible for the customer.

Data Model Changes

Transcript Model:

  • processPercentage has been renamed to progressPercentage.

Release 13 May 2024

New scopes added

  • settings.write this scope is mandatory to write setting values, for example creating new labels

If you want to activate new scopes on your credential pair, the provided technical owner can send a request to [email protected]. As a security measure, newly added scopes are by default not added to existing credential pairs.

API Updates

  • General bug fixes and performance improvements
  • POST /settings/labels endpoint that enables the creation of new labels

Release 04 April 2024

New scopes added

  • privacy.read this scope is mandatory to read the privacy sensitive data related social registration numbers of a customer
  • customers.writethis scope is mandatory to create, update or delete customer related data
  • pti.write this scope is mandatory to assign a checklist to a customer
  • minfin.read this scope enables the listing and downloading of customer's Minfin documents.

If you want to activate new scopes on your credential pair, the provided technical owner can send a request to [email protected]. As a security measure, newly added scopes are by default not added to existing credential pairs.

API Updates

  • GET /customers/:customerId/privacy has been added to request privacy sensitive information of a customer, such as registration number and spouse registration number
  • Minfin
    • GET /minfin endpoint that allows you to retrieve all minfin documents in the backoffice, various filter queries exist to filter results
    • GET /minfin/download/:id endpoint to download a binary synched Minfin file
    • GET /minfin/metadata/:id endpoint to retrieve metadata about a synched Minfin file
  • Customers
    • POST /customers endpoint that enables the creation of customer objects
    • PUT /customers/:customerId endpoint that enables the update of customer objects
    • DELETE /customers/:customerId endpoint that enables the deletion of customer objects
  • Personal Income Tax
    • POST /checklists/assign assign a checklist to a customer