Individual

Delete individual by mapper ID

DELETE/v4/config/platform/individual/mapper/{mapperId}

Deletes the individual of the organisation that has this mapperId. It works as Delete individual: the service marks the record as deleted and deletes the login account of the individual, if it has one. The consent records of the individual are not deleted.

Language of the request sample

curl -X DELETE 'https://demo-api.igrant.io/v4/config/platform/individual/mapper/app-user-2001' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "individual": {
    "id": "6af081b138e8f33dcf799628",
    "externalId": "customer-1001",
    "externalIdType": "customerNumber",
    "identityProviderId": "",
    "name": "Alex Doe",
    "iamId": "3314e64f-b0ab-4078-923f-2250ebbbd9aa",
    "email": "[email protected]",
    "phone": "+46700000002",
    "pushNotificationToken": "",
    "deviceType": "android",
    "mapperId": "app-user-2001"
  }
}

Authorizations

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

Path parameters

mapperIdstringrequired
Mapper ID of the individual (mapperId).
Example:"app-user-2001"

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.