workflow.requiredDocument.fulfillment.delete
Delete a Fulfillment entity from a Required Document.
POST http://api.kompliant.com/workflow.requiredDocument.fulfillment.delete (OpenAPI specification)
Usage Info
This method performs a soft delete operation on a fulfillment, removing the association between a document and a required document while retaining the record in the database with a deleted_at timestamp. This is an idempotent operation that returns success even if the fulfillment is already deleted.
Use this method when a document was incorrectly linked to a required document, when removing a rejected fulfillment to allow resubmission, when cleaning up duplicate or erroneous fulfillments, or when managing document associations during workflow processing. The operation only affects the fulfillment relationship; the underlying document remains in the system unless separately deleted.
Request
Authentication: KSig1-HMAC-SHA256
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| fulfillment_id | string | Yes | The identifier for the Fulfillment. |
Example
{
"fulfillment_id": "f_1rQYvnUQdcatd4TcZQu0l8"
}
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. Invalid values provided. |
| ENTITY_NOT_FOUND | 400 | The fulfillment_id provided does not exist. |
| SYSTEM_RULE_VIOLATION | 400 | System rule violations are described below. |
System Rule Violations
When a SYSTEM_RULE_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:
| Entity Type | Sub-code | Description |
|---|---|---|
| Workflow | WORKFLOW_ENDED | The Workflow is in an ENDED state and cannot completed. |
Updated 7 months ago