Roaring logo
Log in

Person Register Monitoring

Person Register Monitoring

Person Register Monitoring

[se]
Webhook is availableRequires addon

Documentation

In order to receive webhook events for the event type Person Registry Sweden, you need a webhook monitoring list (bundle) created by Roaring. As soon as you have a bundle in place you may update it by its id, i.e. upload a list of personal numbers to monitor. Please read more about webhook monitoring lists in our guide

There is one sandbox endpoint for updating a bundle. Id and entities don't matter, you may choose freely, the endpoint is there only to provide means to verify the file upload and the format.

Common use-cases:

  • Manage monitoring lists for person registry Sweden

Apply for Production Data

This API requires permission. You apply for this through your account. Access Developer, Webhooks, Event types.

The accepted media types are:

  • text/csv
  • application/json

Status

Status Values:

  • APPROVED- Bundle has been processed by SPAR.
  • INCORRECT - Validation of bundle has failed on our end. Please contact us if you come across this status.
  • MISSING - Something has gone wrong on our end. Please contact us if you come across this status.
  • PENDING - Bundle is being processed by SPAR.
  • SENT_IN - Bundle sent in to SPAR.

Status values when updating monitoring list

  1. On update expect status PENDING or SENT_IN if the file is great in size.
  2. Run list monitoring list every other minute until other status than PENDING or SENT_IN.
  3. If status is APPROVED the job is completed.
  4. Else if status is INCORRECT or MISSING, take appropriate measures according to status values.

Endpoints

List monitoring lists

gethttps://api.roaring.io/se/person/monitoring/1.0/bundles

Response schema: application/json

Update monitoring list

puthttps://api.roaring.io/se/person/monitoring/1.0/bundle/{id}

Parameters path

id

required

string
Request body schemamultipart/form-dataRequired
file
stringCSV or a JSON file containing rows of personal numbers