workflow.requiredDocument.fulfillment.update
Update the decision status of a Fulfillment entity.
POST http://api.kompliant.com/workflow.requiredDocument.fulfillment.update (OpenAPI specification)
Usage Info
This method allows you to update the decision status of a Fulfillment, enabling reviewers to mark documents as accepted, rejected, or move them through various review stages. The decision status controls the workflow progression and determines whether a required document has been satisfied.
Use this method when reviewing uploaded documents and making acceptance decisions, moving documents between review stages, updating the decision status after additional document review, or tracking document review progress through the workflow lifecycle.
Request
Authentication: KSig1-HMAC-SHA256
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| fulfillment_id | string | Yes | The identifier for the Fulfillment. |
| decision_status | string | Yes | The new decision status for this fulfillment. Must be one of the FULFILLMENT_DECISION_STATUSES. |
Examples
{
"fulfillment_id": "f_1rQYvnUQdcatd4TcZQu0l8",
"decision_status": "ACCEPTED"
}
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