Individual

Delete individual

DELETE/v4/service/platform/individual/{individualId}

Deletes an individual. The service marks the record as deleted, so no route finds the individual again, and deletes the login account of the individual, if it has one. The consent records of the individual are not deleted. The response returns the individual as it was.

This route takes an API key, or a token of the identity provider of the organisation: with such a token the individual can delete only its own record, and another ID gets 403. An individual token and a token of the privacy dashboard login get 403.

Delete individual

Language of the request sample

curl -X DELETE 'https://demo-api.igrant.io/v4/service/platform/individual/6af0821c38e8f33dcf79962e' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "individual": {
    "id": "6af0821c38e8f33dcf79962e",
    "externalId": "customer-1002",
    "externalIdType": "customerNumber",
    "identityProviderId": "",
    "name": "Sam Doe",
    "iamId": "",
    "email": "",
    "phone": "",
    "pushNotificationToken": "<push-notification-token>",
    "deviceType": "ios",
    "mapperId": ""
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:individuals:delete

Path parameters

individualIdstringrequired
Individual ID.
Example:"6af0821c38e8f33dcf79962e"

Response

application/json

The deleted individual.

individualobject
A person whose consent the organisation records, for example a customer. The record can point to the person in another system through externalId. Keep personal data in it to the minimum that you need.