Usage Info

This method permanently deletes a Subject Record entity from the system. Use with caution as this operation cannot be undone and may affect relationships with associated entities. This method is typically used to remove incorrect entries or during testing in sandbox environments.

Note that a Subject Record entity cannot be deleted if it is currently associated with any of the linked entities. You must first remove the linked entities using the appropriate method before deletion can be completed.

Linked Entity	Appropriate Method
BankAccount	bankAccount.delete
Business	business.delete
Person	person.delete
Workflow	workflow.delete

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
subject_record_id	string	Yes	The ID of the Subject Record.

Example

{
  "subject_record_id": "sr_4PYsekjAX8VMuAOfmW81C7"
}

Response

Data

An empty data object is returned when the delete is successful.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6hz3G2jgP5tfBKZRmZplk8",
    "version": "2025-03-24"
  },
  "data": {}
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided.
ENTITY_LINKED	400	The Subject Record cannot be deleted because it is currently linked one or more Entities. You must first remove the linked entities with appropriate method before the Subject Record can be deleted.
ENTITY_NOT_FOUND	400	The `subject_record_id` provided does not exist.