Get flow result

• X-Verigram-Api-Key

  string

  header

  обязательно

  API key in the X-Verigram-Api-Key header

• X-Verigram-Api-Version

  string

  header

  обязательно

  Required API version header.

  Значение по умолчанию:

  2.0.0

Flow Projection

• person_id

  string

  Identifier of a person associated with the session. Alphanumeric string.

• flow_id

  string

  Unique identifier for the flow.

• person_name

  string

  The full name of the person being verified. This field is populated if a document recognition service was part of the flow and successfully extracted the name.

• iin

  string

  Individual Identification Number (IIN) of the person, if extracted.

• check_type

  enum<string>

  Indicates whether the verification result was determined automatically or manually reviewed/edited by an operator.

  Одно из:

  auto

  edited
• country_code

  string

  Three-letter ISO 3166-1 alpha-3 country code (e.g., "KAZ").

• end_cause

  enum<string>

  The reason why the flow ended. Returns "completed" when execution finishes without errors, "failed" when a server error or unhandled exception occurs, "timeout" when a specific step exceeds its allocated duration, or "disconnected" when the flow terminates due to a lost network connection or user intervention — a status applied automatically once the default five-minute inactivity threshold is reached, provided at least one service session was successfully initialized.

  Одно из:

  completed

  failed

  timeout

  disconnected
• flow_status

  enum<string>

  The main status of a flow or a service. Helps to make a binary decision whether the flow/service was successful or not. If "pass" - the flow/service was successful, unsuccessful otherwise.

  Одно из:

  pass

  fail

  unknown
• sessions_count

  integer

  The total number of service sessions (e.g., liveness checks, document recognition) executed during the flow.

• services_count

  integer

  The total number of unique services that were executed during the flow.

• created_at

  string<date-time>

  Timestamp when the flow was first initialized.

• updated_at

  string<date-time>

  Timestamp of the last update to any session within the flow.

• ended_at

  string<date-time>

  Timestamp when the flow reached its final state.

• service_statuses

  FlowServiceStatus[]

  Detailed status and result summary for each service executed in the flow.

  Показать поля