Updating Sandbox Person Records

Warning

This is guide is only applicable to the sandbox environment.

Sometimes, you may need to update or modify a person in the sandbox.
This guide outlines various ways to manage and update sandbox person, including full import, merging, removing, and updating statuses like deceased or deregistered.
For more detailed information, you can refer to the Sandbox API Swagger documentation: Swagger Sandbox API.

Full Import of a Sandbox Person

This is an example of how you can import a complex sandbox person:

cURL

curl -X PUT https://sandbox-api.bisnode.com/consumer-intelligence/sandbox/v1/persons \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{
    "id": "custom-id",
    "country": "SE",
    "legalId": "194908017800",
    "dateOfBirth": "1949-08-01",
    "dateOfDeath": "2023-01-02",
    "protectedIdentity": false,
    "firstNames": [
        "Eric",
        "Kissen"
    ],
    "familyName": "Andersson",
    "deregisteredReason" : null,
    "removed": false,
    "deregistered": true,
    "deregisteredDate": "2023-01-01",
    "deregisteredYear": "2023",
    "deregisteredMonth": "01",
    "deregisteredDay": "01",
    "additionalName": "additionalName",
    "preferredFirstName": "Nikke",
    "gender": "Male",
    "socialSecurityNumberTemporary": false,
    "socialSecurityNumberValidityPeriod": {
        "startDate": "1801-01-01",
        "startYear": 1801,
        "startMonth": 1,
        "startDay": 1,
        "endDate": "1901-01-01",
        "endYear": 1901,
        "endMonth": 1,
        "endDay": 1
    },
    "deprecatedLegalIds": [
        {
            "socialSecurityNumber": "170101010000",
            "socialSecurityNumberTemporary": false,
            "socialSecurityNumberValidityPeriod": {
                "startDate": "1701-01-01",
                "startYear": 1701,
                "startMonth": 1,
                "startDay": 1,
                "endDate": "1702-01-01",
                "endYear": 1702,
                "endMonth": 1,
                "endDay": 1
            }
        },
        {
            "socialSecurityNumber": "170101010000"
        }
    ],
    "diplomaticImmunity": true,
    "addressList": [
        {
            "type": "Postal",
            "subType": "Domicile",
            "restricted": "Confidential",
            "postOfficeBox": "postOfficeBox",
            "careOf": "Kalle",
            "streetName": "Norrbackagatan",
            "streetNumber": "7",
            "postalCode": "postalCode",
            "city": "Skellefteå",
            "floor": "122",
            "entrance": "A",
            "apartment": "1234",
            "county": "Soolna",
            "countyCode": "34",
            "municipality": "Stackhelm lan",
            "municipalityCode": "1234",
            "district": "district",
            "districtCode": "1234",
            "dispatchingInformation": "The left garden",
            "country": "SE"
        }
    ],
    "phoneList": [
        {
            "type": "Mobile",
            "number": "+4631728764",
            "telemarketingRestriction": true
        }
    ],
    "directMarketingRestriction": true,
    "charityMarketingRestriction": true,
    "onlineMarketingRestriction": true,
    "futureAuthorization": true,
    "identificationClaim": true,
    "citizenship": [
        "SE"
    ],
    "relationshipList": [
        {
            "hierarchicalRelationship": "Parent",
            "nonHierarchicalRelationship": null,
            "startDate": "1901-01-01",
            "endDate": "1901-01-01",
            "legalId": {
                "socialSecurityNumber": "200003211683",
                "socialSecurityNumberTemporary": false,
                "socialSecurityNumberValidityPeriod": {
                    "startDate": "1901-01-01",
                    "startYear": 2023,
                    "startMonth": 1,
                    "startDay": 1,
                    "endDate": "1901-01-01",
                    "endYear": 1901,
                    "endMonth": 1,
                    "endDay": 1
                }
            },
            "firstNames": [
                "Ann",
                "Lisa"
            ],
            "preferredFirstName": "Annie",
            "additionalName": "Ann",
            "familyName": "Karlsson",
            "dateOfBirth": "2000-01-05",
            "dateOfDeath":  "2050-01-05",
            "deceased": true,
            "gender": "Female",
            "citizenship": [
                "SE"
            ]
        }
    ]
}'

Merging a Sandbox Person

This is an example of how you can merge a person into an existing. Note that the gedi of the person to be merged must already exist in the system before performing the merge operation:

cURL

curl -X PUT https://sandbox-api.bisnode.com/consumer-intelligence/sandbox/v1/persons \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{
    "id": "custom-id",
    "country": "SE",
    "legalId": "198810236903",
    "dateOfBirth": "1801-01-01",
    "merged": {
        "gedi": "M3F28258FC1H" 
    }
}'

Removing a Person

This is an example of how to mark a sandbox person as removed by setting their removed status:

cURL

curl -X DELETE https://sandbox-api.bisnode.com/consumer-intelligence/sandbox/v1/persons \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{
    "id": "custom-id",
    "country": "SE",
    "legalId": "198810236903",
    "dateOfBirth": "1988-10-23",
    "removed": true,
    "firstName": "Annica",
    "familyName": "Sandberg",
    "gender": "Female"
}'

Deceased Person

This is an example of how to mark a person as deceased:

cURL

curl -X PUT https://sandbox-api.bisnode.com/consumer-intelligence/sandbox/v1/persons \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{
    "id": "customer-id",
    "country": "SE",
    "legalId": "198810236903",
    "dateOfBirth": "1988-10-23",
    "dateOfDeath": "1998-01-01"
}'

Deregistered Person

This is an example of how to mark a person as deregistered:

cURL

curl -X PUT https://sandbox-api.bisnode.com/consumer-intelligence/sandbox/v1/persons \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{
    "id": "customer-id",
    "country": "SE",
    "legalId": "198810236903",
    "dateOfBirth": "1988-10-23",
    "protectedIdentity": false,
    "firstNames": [
        "Annica"
    ],
    "familyName": "Sandberg",
    "deregisteredReason": "The deregistered Reason",
    "deregistered": true
}'

Relationship Updates

Deceased Relationship

If a relationship has a dateOfDeath, the related person is marked as deceased:

cURL

curl -X PUT https://sandbox-api.bisnode.com/consumer-intelligence/sandbox/v1/persons \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{
    "id": "custom-id",
    "country": "SE",
    "legalId": "198810236903",
    "dateOfBirth": "1988-10-23",
    "relationshipList": [
        {
            "hierarchicalRelationship": "Parent",
            "firstName": "Anna",
            "familyName": "Annsson",
            "dateOfBirth": "1938-01-05",
            "dateOfDeath": "1998-01-05"
        }
    ]
}'

Deregistered Relationship

This is an example of how to mark a related person in a relationship as deregistered:

cURL

curl -X PUT https://sandbox-api.bisnode.com/consumer-intelligence/sandbox/v1/persons \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{
    "id": "custom-id",
    "country": "SE",
    "legalId": "198810236903",
    "dateOfBirth": "1988-10-23",
    "relationshipList": [
        {
            "deregistered" : true,
            "deregisteredReason": "relationship deregistered reason",
            "hierarchicalRelationship": "Parent",
            "nonHierarchicalRelationship": null,
            "Name": "Ann",
            "familyName": "Karlsson"
        }
    ]
}'