Deleting Resources
Orum allows you to delete persons, businesses, external accounts in the API and in the Orum Portal.
- Once deleted, the resource will transition to a closed status, at which point Orum will maintain the record and you will be able to access the resource’s history
- Deleted resources will still appear in GET responses
- Deleted resources cannot be re-opened
- Reference id’s from deleted resources cannot be reused for new resources
If a cancellation is successful, you will receive a 200 response from the API. An example can be found below:
{
"external_account": {
"account_holder_name": "Lemon Liz",
"account_number": "9876543210",
"account_reference_id": "071357c0-a82a-45fb-a618-5c1c9b6371d9",
"account_type": "checking",
"closed_at": "2025-01-16T17:14:32.421294Z",
"created_at": "2023-03-23T17:32:32.913478Z",
"customer_reference_id": "bc5270c7-d209-4fc5-b201-708d04534893",
"customer_resource_type": "business",
"id": "5aa8f8ae-2690-4bc2-8544-ba7aa45652b2",
"routing_number": "987654321",
"status": "closed",
"updated_at": "2025-01-16T17:14:32.421294Z"
}
}
A sample webhook response can be found below.
{
"event_id": "98fc664e-3175-4f39-9b1d-56352c491fd3",
"event_type": "external_account_closed",
"created_at": "2025-01-16T17:14:35.631Z",
"event_data": {
"external_account": {
"id": "4c8f7e72-092e-4621-8cf8-4774915eaf01",
"account_reference_id": "ab76d-9363bd-s27d",
"customer\_reference\_id": "bc5270c7-d209-4fc5-b201-708d04534893",
"account_type": "checking",
"account_number": "012345678",
"routing_number": "021000021",
"account_holder_name": "John Doe",
"status": "closed",
"created_at": "2023-03-23T17:32:32.913478Z",
"updated_at": "2025-01-16T17:14:32.421294Z"
}
}
}
Updated about 6 hours ago