Skip to navigation

Submit external gate decision

Submit a decision for a session paused at an external gate step. The session must be in awaiting_external status.

Decisions:

  • continue — resume executing the remaining workflow steps.
  • fail — apply the gate step’s on_fail action (e.g. review, reject, or jump to another step).
  • reject — immediately reject the session.

The workflow resumes asynchronously after the decision is accepted.

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

session_idstringRequired

Session ID (ses_*).

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Request

This endpoint expects an object.
decisionenumRequired
How the workflow should proceed.
Allowed values:
metadatamap from strings to any or nullOptional
Optional metadata from the external system. Stored on the workflow run.

Response

Decision accepted. The workflow will resume shortly.
session_idstringOptional
decisionstringOptional
statusstringOptional
messagestringOptional

Errors

401
Unauthorized Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error