Transaction Workflows

Get the generated document status for a form implementation

GET/transaction-workflows/form-implementations/{implementationId}/generated-document
transaction-workflows:readget_transaction_workflow_form_implementation_documentRead-only

Docgen status for a form implementation — whether the step's generated document has been produced and the attachment it landed in. The implementation is org-scoped through its transaction user → 404 leak-safe.

Path parameters

  • implementationIdstring (uuid)Required#

    The form implementation id.

Responses

200

OK

FormImplementation
{
  "data": {
    "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "workflow_step_id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
    "deal_id": "9f8e7d6c-5b4a-4938-8271-6a5b4c3d2e1f",
    "transaction_user_id": "8d9e0f1a-2b3c-4d5e-8f6a-7b8c9d0e1f2a",
    "tranche_id": null,
    "form_implementation_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
    "completed_at": "2026-06-18T14:05:00+00:00",
    "document_generated": true,
    "generated_attachment_id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/transaction-workflows/form-implementations/{implementationId}/generated-document\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"