Introduction

On this website you can discover the Berichtenbox API provided by the Arpha B.V. API Platform.

With this API, organisations are able to send Berichtenbox messages to the central Berichtenbox system of the Dutch Government in the most secure and easy way possible.

Request access

To be able to test the API yourself, you will have to request access by filling out a short form. Testing the API is free of costs.

OpenAPI specification

Apart from discovering the Berichtenbox API through this website, you can also download the OpenAPI specification file.

Example message

{
 "BerichtLeverancierID" : "00000003869874370000", // OIN (from the formal sender of this letter, for example municipality)
 "Berichten" : [
   {
     "BerichtID" : "7E9126B2-C661-4C0F-9E05-7B038906CCCF", // UUID-format
     "BerichtType" : "APIDEMO",  // max 8 chars
     "PublicatieDatum" : "2022-06-11T09:30:47Z", // optional, YYYY-MM-DDTHH:MM:SSZ
     "Onderwerp" : "Subject of the message", // max 50 chars
     "Berichttekst" : "Hi,\r\n\r\nThis is a message, sent with the Berichtenbox API.\r\n\r\nRegards,\r\nBBAPI\r\nhttps://www.berichtenbox.dev", // max 4000 chars
     "Referentie" : "BB API Demo", // optional, max 25 chars
     "GebruikerID" : "000000012", // valid BSN
     "Bijlagen" : [  // optional, max. 2 PDF attachments per message
       {
         "Inhoud" : "ZGl0aXNlZW5QREZiZXN0YW5k", //base64 encoded PDF, total file size of binary PDFs 500kB
         "Omschrijving" : "Filename", // description or filename of PDF, max 128 chars
         "Volgorde" : "1" // optional when sending 2 PDF's
       }
     ]
   }
 ]
}

Need help?

Please contact us if you need any help with the API.

More information on berichtenbox.dev