Skip to content

Latest commit

 

History

History
115 lines (80 loc) · 5.04 KB

stuf_bg.rst

File metadata and controls

115 lines (80 loc) · 5.04 KB
Raw

StUF-BG

StUF-BG (StUF Basis Gegegevens) is a message standard that allows retrieving of personal information through a SOAP service from municipalities and government organizations. Open Forms can be configured to use this service to prefill personal data of the person filling out the form.

Note

This service contains sensitive data and requires a connection to an external system, offered or maintained by a service provider.

What does the Open Forms administrator need?

The values for these parameters should be provided to the Open Forms administrator by the service provider.

Parameter Description
Security

Public certificate SOAP services

The certificate, used by the service, to identify itself for 2-way TLS.

BeantwoordVraag endpoint Stuurgegevens

URL for the BeantwoordVraag SOAP-endpoint that Open Forms can access.
Ontvanger Organisatie Name of the organization submissions are sent to.
Ontvanger Applicatie Name of the application submissions are sent to.

What does the service provider need?

The values for these parameters should be provided to the service provider by the Open Forms administrator.

Parameter Description
Security
Public certificate The certificate, used by Open Forms, to identify itself for 2-way TLS.

IP address Stuurgegevens

The IP address of the Open Forms server (optional, for whitelisting).
Zender Organisatie Typically the organization name but can be whatever the service provider configured.
Zender Applicatie Typically Open Forms but can be whatever the service provider configured.

Configuration

  1. Obtain credentials and endpoint for StUF-ZDS from the client.
  2. In Open Forms, navigate to: Configuration > SOAP Services
  3. Click Add SOAP Services and fill in the following details:
    • Label: Fill in a human readable label, for example: My StUF-BG service
    • URL: Fill in the full URL to the SOAP service endpoint
    • SOAP Version: Select the SOAP version of your backend provider

  4. In the Authentication section enter the authentication details provided by the service provider:

    • Security: select the security level required by your backend provider

      • Basic authentication: use HTTP Basic authentication, requires to also fill in Username and Password
      • SOAP extension: WS-Security: use WS-Security, requires to also fill in Username and Password
      • Both: use both HTTP Basic authentication and WS-Security, requires to also fill in a shared Username and Password
      • None: no username/password based security (default)
    • Certificate and Certificate key: optionally provide a certificate and key file for client identification. If empty mutual TLS is disabled
  5. Click Save
  6. Navigate to: Miscellaneous > StUF-services
  7. Click Add StUF-service and fill in the following details:
    • Soap service: Select the SOAP service we created above
  8. In the StUF parameters section enter the receiving details provided by the service provider. For the sending organization details, you can fill in:
    • Versturende applicatie: Open Forms
  9. In the Connection section:
    • Endpoint BeantwoordVraag: Fill in the full URL to the endpoint for the SOAP 'BeantwoordVraag' action
    • Endpoint VrijeBerichten: Fill in the full URL to the endpoint for the SOAP 'VrijeBerichten' action
    • Endpoint OntvangAsynchroon: Fill in the full URL to the endpoint for the SOAP 'OntvangAsynchroon' action
  10. Click Save
  11. Navigate to Configuration > Configuration Overview. In the Prefill plugin group, click on Configuration for the StUF-BG line.
  12. Select for the Service, the StUF Service we created above
  13. Click Save

The StUF-BG configuration is now completed.

Technical

Service Supported versions
StUF-BG 3.10 (npsLv01)