esign_requirements_not_met (403)

← Error reference

esign_requirements_not_met

HTTP status: 403

Retryable: No. Retrying without changes will fail the same way.

The workflow cannot run the document signing step it was given.

When it fires

A create or update of a workflow template, or a session create, resolved a workflow whose `esign` step outruns what would be available to it. `details.reason` names the exact rule. Most name something about the workflow or the document, and a template save is refused for them: the named document version is not published, the workflow has two signing steps, signing is ordered before identity verification, the document places a variable only identity verification supplies, or it places a collected input the workflow never gathers. One names something about the request instead. `esign_session_metadata_required` means the document places a session metadata variable (`start_datetime`, `end_datetime`, `amount`, `currency`, or `location`) and this create did not supply the matching key in `metadata`. A template save cannot decide that one, because the value comes from the individual create call and no saved template knows it, so a workflow using those variables saves normally and the refusal lands here instead. Either way the refusal is raised before anyone is handed a document a signer could never complete.

How to handle it

Read `details.reason`, then fix whichever side it names and retry. For `esign_session_metadata_required`, supply the named key in the `metadata` object when you create the session; the message names both the variable and the key. For the rest, change the workflow or the document: publish the document version, remove the second signing step, move the signing step after identity verification, add the step that supplies the missing value, or use a `workflow_template_id` instead of an ad-hoc `checks` array. Retrying the same request unchanged will produce the same response.

Example response

{
  "error": {
    "type": "https://docs-dev.autohost-dev.uk/api/errors/esign_requirements_not_met",
    "code": "esign_requirements_not_met",
    "message": "The document signing step cannot run in this workflow.",
    "request_id": "req_01HEXAMPLE0000000000000000",
    "doc_url": "https://docs-dev.autohost-dev.uk/api/errors/esign_requirements_not_met"
  }
}