Subscribing to persons

Consumer Intelligence supports identifying persons in your customers registries, and monitor changes to the identified individual in a variety of different sources. Refer to our Sources table for an overview of which sources are supported.

Uploading consumers

Start with uploading your consumers to the Consumer API.

Upload consumers request example

curl {API_URL}/consumers \
  -X POST \
  -H "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "consumerId": "your-unique-id-to-the-consumer",
      "market": "SE",
      "data": {
        "legalId": "191212121212"      
      }
    }
  ]'

The API will respond with 202 Accepted and an empty response, if the upload was successful.

Supports batch uploads

The API supports uploading consumers in batches of 100.

Consumers are being identified

Once consumers are uploaded the identification process starts. Your consumers will automatically be identified in your available sources, in the configured prioritization order of your client. If an integration fails to identify a consumer, the next available integration will be used.

The system will emit events during this period, all of which is made available to your registered Webhook, or in the Audit events API.

List audit events request example

curl {API_URL}/audit-events \
  -H "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
  -H "Content-Type: application/json"

The list will be sorted in ascending order of insertion. Meaning, you will have to paginate the events using nextPageToken to get to the most recent events.

Audit event retention period

Audit events are stored for up to 1 year.

Subscription started

When the identification process is complete, your consumer will be updated with a state of either IDENTIFIED or NOT_IDENTIFIED. If your consumer was identified a subscription to monitor changes on that person will automatically be set up for you.

To find the latest data of your subscribed persons you can use the Subscriptions API. The subscriptions are sorted in ascending order of changed timestamp. This means that you will find the oldest changed subscription at the beginning of the list, and the most recent change at the end. Use nextPageToken to paginate the data.

List subscribed persons request example

curl {API_URL}/subscriptions/persons \
  -H "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
  -H "Content-Type: application/json"

If the response data is empty it means you've reached the end of your change stream.

Best practices

No sensitive data as consumer ID

Do not use sensitive data, such as social security numbers, as your consumer IDs. These are logged in our systems and are not subject of any encryption.

Provide as much data as you can

The more input we have the more likely we are to identify the person. It's better to send more data, as granular as possible, to guarantee a hit.

Persist nextPageToken

Persist the nextPageToken for your next scheduled request to only retrieve the changed data since last.