person.delete
Remove a Person entity from a Subject Record.
POST http://api.kompliant.com/person.delete (OpenAPI specification)
Usage Info
This method permanently deletes a Person entity from the system. Use with caution as this operation cannot be undone. Typically used when person information is incorrect or when person is no longer active.
Note that a Person entity cannot be deleted if it is currently associated with a Business. You must first remove the association using the business.removePerson method before deletion can be completed.
Request
Authentication: KSig1-HMAC-SHA256
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| person_id | string | Yes | The ID of the Person entity. |
Example
{
"person_id": "p_6zNzQZHSf26V83BO3uW6dS"
}
Response
Data
An empty data object is returned when the completion is successful.
Example
{
"meta": {
"status": "SUCCESS",
"trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
"version": "2025-03-24"
},
"data": {}
}
Errors
| Error Code | HTTP Code | Possible Cause |
|---|---|---|
| BAD_REQUEST | 400 | Required parameters not provided. |
| ENTITY_LINKED | 400 | The Person entity cannot be deleted because it is currently linked to a Business entity. You must first remove the association using the business.removePerson method before the Person can be deleted. |
| ENTITY_NOT_FOUND | 400 | The person_id provided does not exist. |
Updated 6 months ago