Documents - Make public on API

You can make documents in AdminPulse available via the API. External software can then retrieve those documents and show them to your customers, for example via Skwarel, Silverfin, Accounton or Claritalk.

Please note: marking a document in AdminPulse as Public on portal does not automatically make it visible to your customers. There must also be a connection to a portal or external application that retrieves and shows the documents via the API.

💡 A typical example: enable Public on portal for the Annual accounts document type or for a tag such as For customer. This allows those documents to become available automatically in the customer portal.

In this article, you will read how you can make documents public for use via the API, both manually and automatically.

Making documents public manually

You can make one document public separately, or several documents at the same time via a batch operation.

Making one document public

1. Open the document.
2. Tick Public on portal.
3. Click Save.

Making multiple documents public in bulk

1. Go to Documents > Documents.
2. If needed, use filters to find the correct documents more quickly.
3. Select the documents you want, one by one or via the checkbox at the top of the overview.
4. Go to Batch operations and choose Set public on portal.
5. Tick the checkbox.
6. Click 'Ok' to run the batch operation.

💡 You can also use the same batch operation to make documents no longer public. In that case, untick the checkbox.

Making documents public automatically via a tag or document type

You can set documents to become public automatically as soon as they get a specific tag or document type. This means you do not need to mark each document separately.

Set it up like this:

1. Go to Settings > Tags.
2. Open the Document tags tab if you want to set this up per tag or Document types if you want to set it up per document type.
3. In the Public on portal column, tick the box next to the tag or document type for which you want to enable this.

From then on, every document with that tag or document type is automatically marked as public. This applies both to tags you add manually and to tags that are assigned automatically via document recognition.

👉 The automatic marking happens at the moment a document gets the tag or document type, for example, when uploading, when you add a tag manually afterwards, or when you change the document type.

👉 If you change the Public on portal setting afterwards for a tag or document type, this has no effect on documents that were already processed.