Subscribe to a person

Use the consumer and subscription APIs to subscribe to a person and receive changes to the person. As a user of the API, you upload your consumers. A consumer is a consumer/customer/user/CRM-record in your system.

If a consumer is identified, a subscription to the underlying person is created. The identification process is asynchronous, and the time may vary depending on the underlying source. In case of duplicates, multiple consumers may identify the same person, in which case they will all map to the same subscription to the underlying person. The subscription will be present until the last consumer reference to that person is deleted.

Before you begin

The provided example values in this guide must be changed with the values of your client. Replace <client_id> with your client id, and <client_secret> with your client secret.

Consumers & Subscriptions

Step 1 - Setup

You must have already signed up as an organization with Dun & Bradstreet and have your sandbox credentials from the developer portal. See Getting started guide for help.

Step 2 - Authentication

First, you will need an access_token from the Authentication API (POST:https://login.bisnode.com/sandbox/v1/token.oauth2).

Don't forget to change credentials

Don't forget to replace <client_id> with your client id, and <client_secret> with your client secret.

cURL

curl -X POST https://login.bisnode.com/sandbox/v1/token.oauth2 \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "grant_type=client_credentials&scope=bci" \
     -u "<client_id>:<client_secret>"

The property access_token from the response should be used for all other API requests in the Authorization header as the Bearer token.

Step 3 - Upload consumers

Use POST:/v3/consumers to upload your consumers. If your consumer is identified a subscription to the underlying person is created.

cURL

curl -X POST https://sandbox-api.bisnode.com/consumer-intelligence/v3/consumers \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <access_token>" \
     -d '[
        {
            "consumerId": "<your-unique-id-to-the-consumer>",
            "market": "SE",
            "data": {
                "legalId": "196909234701"
            }
        }
    ]'

Step 4 - Get audit events

Use GET:/v3/audit-events to find the events that occurred to your uploaded consumers. You should see your uploaded consumer being identified. You can use pagination.

cURL

curl "https://sandbox-api.bisnode.com/consumer-intelligence/v3/audit-events?pageToken=<page_token>&pageSize=<pageSize>" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <access_token>"

Step 5 - Get consumers

Use GET:/v3/consumers to see your uploaded consumers and their states. You can use pagination.

cURL

curl "https://sandbox-api.bisnode.com/consumer-intelligence/v3/consumers?pageToken=<page_token>&pageSize=<pageSize>" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <access_token>"

Step 6 - Get subscribed persons

When your consumer was uploaded and was identified, a subscription was created. Use GET:/v3/subscriptions/persons to get the latest versions of your subscribed persons. You can use pagination.

cURL

curl "https://sandbox-api.bisnode.com/consumer-intelligence/v3/subscriptions/persons?pageToken=<page_token>&pageSize=<pageSize>" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <access_token>"

Step 7 - Delete consumers

Use DELETE:/v3/consumers to delete your consumers. If the underlying person is subscribed to, the subscription to the person will also be removed unless there is not another present consumer bound to the same underlying person.

cURL

curl -X DELETE https://sandbox-api.bisnode.com/consumer-intelligence/v3/consumers \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <access_token>" \
     -d '{
        "consumerIds": [
            "your-unique-id-to-the-consumer"
        ]
    }'