BiQ Alert SDK

Third Party Developer

BiQ Alert SDK consist of 3 services, they are documented at
their respective swagger sites.

Introduction

BiQ Alert is a service developed by BiQ A/S that facilitates realtime information about important changes in your customers master data and other relevant customer data from CPR, CVR and Statstidende such as name changes, address changes, status changes etc.

Our solution is based on creation of what we call a ‘customer shadow database’ with a selected subset of your customer data. Typically, a client number, a name and an address. The customer data is then constantly mirrored against public databases (now CPR, Statstidende and CVR). The Alert solution then facilitates a flow of updates to customer data back to the client’s own database. These customer updates are provided in feeds and are categorized in either notifications or approved changes from where it is possible to automate important customer changes, such as a name and address change of a customer.

Secure integration and creation of your customer database is described in the below two services and related documentation: “Authorization” and “CustomerShadow”.

How to handle the updates and integrate to your client databases is described and documented in the below service “AlertChanges”.

To help getting started we have provided developers with a step-by-step guide “Step by step guide – try it in your browser” as the last part of this page.

Important: To complete the full integration a BiQ Search account is needed. The account will give you access to an api-key, tenant-ID and a GUI part of the solution. The api-key is private and must be kept a secret. We can provide a new key upon request if necessary.

Authorization

Service documentation: https://auth-api.idq.dk/swagger
Service URL: https://auth-api.idq.dk/api/auth/login

Your TenantId: [recieve it from BiQ Support]
Your apiKey: [recieve it from BiQ Support]

Customer Shadow

Place a shadow/a copy of your customers at BiQ, so BiQ can monitor public
data sources for changes.
Service documentation: https://alert.idq.dk/swagger-ui
Service URL: https://alert.idq.dk/

Alert Changes

Retrieve alerts, notification and changes about your customers.

Service documentation: https://alert-changes.idq.dk/swagger-ui

Service URL: https://alert-changes.idq.dk

Step by Step Guide – Try it in your browser

Use the GET /api/Auth/login with only your api-key to obtain a JWT.
Use a tool (eg. jwt.io/ ) to verify that you received a well-formed JWT (it should contain your tenantId in the field tenatIds)
Authorize the Swagger site with your JWT
(in the value field enter: ‘Bearer YOUR-JWT-FROM-THE-ABOVE-STEP-HERE’)
Use GET /tenants/{tenantid}/shadowsources to get your shadowSourceId.
Use POST /tenants/{tenantid}/shadowsources/{shadowsourceid}/customers and some data from a customer to upload a shadow copy of one of your customers to Idq.
Use PUT /tenants/{tenantid}/shadowsources/{shadowsourceid}/customers to update your customer from the previous step.
Use IDQ’s regular web-front (logon with your email and password) to double check the results of the above transactions.
Using ‘Fritekst’ search with your customer number – you should be able to find the customer and on the customer dash board the history should contain the above transactions.
Use GET /tenants/{tenantid}/notifications to obtain the feed with surveillance notifications for all your customers. And you can use GET /tenants/{tenantid}/approved-changes to obtain the feed with surveillance changes to all your customers.
Note that some surveillances needs to be turned on by BiQ before they deliver any results