CPR Nullification via API

In order to remove any consumer records using our MobileDB persons APIs, relevant fields will have to be set to null. Since the MDN may exist under multiple company keys, the MDN will have to iterated through all the company keys. Assuming we use API version 2, you must send E.164 compliant numbers with the + prefix.

Step 1: Lookup the person by MDN

Using Find person by MDN, retrieve the record you'd like to nullify.

GET https://public-api.vibescm.com/companies/{company_key}/mobiledb/persons?mdn=%2B{mdn}

Step 2: Update the record

Using Update a person by person_key, send a payload that nullifies any information you'd like to remove in the request.

Every relevant field in custom_fields entry, must be iterated and set to null.

PUT https://public-api.vibescm.com/companies/{company_key}/mobiledb/persons/{person_key}
{
  "mobile_phone": {
    "mdn": null,
    "carrier_code": null
    "external_person_id" : null
  },
  "custom_fields": {
    "<key>": null
  }
}

Example cURLs

curl --request GET \
     --url 'https://public-api.vibescm.com/companies/{company_key}/mobiledb/persons?mdn=%2B10005550100' \
     --header 'X-API-Version: 2' \
     --header 'accept: application/json'

curl --request PUT \
     --url https://public-api.vibescm.com/companies/{company_key}/mobiledb/persons/{person_key} \
     --header 'X-API-Version: 2' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "mobile_phone": {
    "mdn": null,
    "carrier_code": null
  },
  "custom_fields": {
    "{key}": null
  }
}
'