DKBSignDocs

API reference

POSTRequires Bearer token

Return the circuit to its initiator

/api/workflows/transactions/step/process/return-to-initiator

Submit /api/workflows/transactions/step/process/return-to-initiator. Authenticated routes need Authorization: Bearer {token} from POST /api/v1/login.

Path parameters

This endpoint has no path parameters.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
transaction_id
Required
integerCurrent step transaction id.
e.g. 44
motif_retour
Required
stringReturn reason (max 1000).
e.g. "Wrong document version"

Responses

StatusMeaning
200Returned to initiator
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/workflows/transactions/step/process/return-to-initiator' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"transaction_id":44,"motif_retour":"Wrong document version"}'

Response 200

json
{
  "status": "success",
  "message": "Circuit renvoyé à son initiateur pour correction",
  "workflow": {
    "id": 88,
    "name": "Contract ACME",
    "status": "in_progress",
    "model_id": 3,
    "client_id": 12
  }
}