Submit external gate decision | Verifa

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.

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_*).

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_idstring

decisionstring

statusstring

messagestring

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

1	import requests
2
3	url = "https://devapi.withverifa.com/api/v1/sessions/session_id/external-decision"
4
5	payload = { "decision": "continue" }
6	headers = {
7	"X-API-Key": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"session_id": "ses_abc123",
3	"decision": "continue",
4	"status": "processing",
5	"message": "External decision accepted. The workflow will resume shortly."
6	}

Authentication

Path parameters

Headers

Request

Response

Errors