Session Status

Status is one of the session’s inherent properties and helps determine whether a particular session meets the business rules defined in the workflow.

Usage of statuses is technically optional: the workflow author must explicitly define the points at which the session status is changed.

Currently supported session statuses and their suggested usage:

Status	Code	Description
not completed	0	Assigned automatically when the session starts. It remains the active status until it is changed. Generally used to indicate that a session has not reached one of the designated success or failure points.
verified	2	Commonly used to indicate that the session has been completed successfully, i.e., the session data has met all required verifications implemented in the workflow.
not verified	1	The opposite of verified, meaning that the data in the session does not meet the required verifications implemented in the workflow. Can also indicate processing issues showing the session failed to reach a certain point.
approved	3	Implies the approval of the session by a human operator. It is used on the session page rather than as a part of the workflow. This status does not necessarily mean that the session ends, as it can trigger further automatic or manual steps required by the business logic.
rejected	1000	The opposite of approved, indicating that the session has been rejected by a human operator. It can also be used to trigger further machine or human actions once applied.
pending	4	Indicates that the session has reached a point where additional actions or inputs are required to proceed further — for example, a manual review of the session results.

The general meaning of each status, as described above, should be viewed as a suggestion and can be reinterpreted to suit the goals of each particular use case.

To find the status in the session data container, look for the status property, for example:

"status": 3