API referenceServicelogs

Get session result

Retrieve detailed technical logs and results for a specific service session (e.g., liveness check, document recognition). This endpoint returns the session context and results.

GET

/journal/session/{session_id}

GET

/journal/session/{session_id}

curl -X GET "https://demo.verigram.kz/journal/session/{session_id}" \
  -H "X-Verigram-Api-Key: $IDENTIFICATION_SAAS_API_KEY" \
  -H "X-Verigram-Api-Version: 2.0.0"

Авторизация

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

Ответ

application/json

Detailed session projection result.

session_id
string
Unique identifier for the session.
person_id
string
Identifier of a person associated with the session. Alphanumeric string.
consumer_id
string
Identifier of the consumer who owns the session.
flow_id
string | null
Identifier of the flow associated with the session.
vlink_id
string | null
Identifier of the vlink associated with the session.
api_version
string
The version of the API used to create and process this session.
service_name
enum<string>
Одно из:
verilive
verilive-one-shot
verilive-infrared
veriface
veridoc
kisc
redoc
egov-doc
aml-cft
flow-form
consent
veriphone
esign
kyc-list
otp
notification
device-filter
doc-preview
doc-builder
file-storage
client-card
erd
interrupter
language-selector
amlcft-service
session_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
test_session
boolean | null
Whether the session was created for test purposes.
step_id
string | null
process
string | null
user_ip
string | null
vendor
string | null
created_at
string<date-time>
Timestamp when the session was created.
updated_at
string<date-time>
Timestamp of the last update to the session's state.
session_states
SessionState[]
History of execution states reached by this session.
result
one of

{
  "session_id": "string",
  "person_id": "string",
  "consumer_id": "string",
  "flow_id": "string",
  "vlink_id": "string",
  "api_version": "string",
  "service_name": "verilive",
  "session_status": "pass",
  "test_session": true,
  "step_id": "string",
  "process": "string",
  "user_ip": "string",
  "vendor": "string",
  "created_at": "2026-01-15T09:30:00Z",
  "updated_at": "2026-01-15T09:30:00Z",
  "session_states": [
    {
      "state_name": "created",
      "created_at": "2026-01-15T09:30:00Z"
    }
  ],
  "result": {
    "created_at": "2026-01-15T09:30:00Z",
    "created_by": "string",
    "error_code": "string",
    "error_msg": "string",
    "service_name": "verilive",
    "service_status": "real",
    "error_codes": [
      "timeout"
    ],
    "warnings": [
      "timeout"
    ],
    "start_time": "2026-01-15T09:30:00Z",
    "end_time": "2026-01-15T09:30:00Z"
  }
}

GET

/journal/session/{session_id}

curl -X GET "https://demo.verigram.kz/journal/session/{session_id}" \
  -H "X-Verigram-Api-Key: $IDENTIFICATION_SAAS_API_KEY" \
  -H "X-Verigram-Api-Version: 2.0.0"

{
  "session_id": "string",
  "person_id": "string",
  "consumer_id": "string",
  "flow_id": "string",
  "vlink_id": "string",
  "api_version": "string",
  "service_name": "verilive",
  "session_status": "pass",
  "test_session": true,
  "step_id": "string",
  "process": "string",
  "user_ip": "string",
  "vendor": "string",
  "created_at": "2026-01-15T09:30:00Z",
  "updated_at": "2026-01-15T09:30:00Z",
  "session_states": [
    {
      "state_name": "created",
      "created_at": "2026-01-15T09:30:00Z"
    }
  ],
  "result": {
    "created_at": "2026-01-15T09:30:00Z",
    "created_by": "string",
    "error_code": "string",
    "error_msg": "string",
    "service_name": "verilive",
    "service_status": "real",
    "error_codes": [
      "timeout"
    ],
    "warnings": [
      "timeout"
    ],
    "start_time": "2026-01-15T09:30:00Z",
    "end_time": "2026-01-15T09:30:00Z"
  }
}

Flow
Servicelogs
- GETGet session result
Liveness
- POSTCreate new liveness session
Face
Resources
Mocking services

Get session result - Verigram Центр помощи

API referenceServicelogs

Get session result

Retrieve detailed technical logs and results for a specific service session (e.g., liveness check, document recognition). This endpoint returns the session context and results.

GET

/journal/session/{session_id}

GET

/journal/session/{session_id}

curl -X GET "https://demo.verigram.kz/journal/session/{session_id}" \
  -H "X-Verigram-Api-Key: $IDENTIFICATION_SAAS_API_KEY" \
  -H "X-Verigram-Api-Version: 2.0.0"

Авторизация

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

Ответ

application/json

Detailed session projection result.

session_id
string
Unique identifier for the session.
person_id
string
Identifier of a person associated with the session. Alphanumeric string.
consumer_id
string
Identifier of the consumer who owns the session.
flow_id
string | null
Identifier of the flow associated with the session.
vlink_id
string | null
Identifier of the vlink associated with the session.
api_version
string
The version of the API used to create and process this session.
service_name
enum<string>
Одно из:
verilive
verilive-one-shot
verilive-infrared
veriface
veridoc
kisc
redoc
egov-doc
aml-cft
flow-form
consent
veriphone
esign
kyc-list
otp
notification
device-filter
doc-preview
doc-builder
file-storage
client-card
erd
interrupter
language-selector
amlcft-service
session_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
test_session
boolean | null
Whether the session was created for test purposes.
step_id
string | null
process
string | null
user_ip
string | null
vendor
string | null
created_at
string<date-time>
Timestamp when the session was created.
updated_at
string<date-time>
Timestamp of the last update to the session's state.
session_states
SessionState[]
History of execution states reached by this session.
result
one of

{
  "session_id": "string",
  "person_id": "string",
  "consumer_id": "string",
  "flow_id": "string",
  "vlink_id": "string",
  "api_version": "string",
  "service_name": "verilive",
  "session_status": "pass",
  "test_session": true,
  "step_id": "string",
  "process": "string",
  "user_ip": "string",
  "vendor": "string",
  "created_at": "2026-01-15T09:30:00Z",
  "updated_at": "2026-01-15T09:30:00Z",
  "session_states": [
    {
      "state_name": "created",
      "created_at": "2026-01-15T09:30:00Z"
    }
  ],
  "result": {
    "created_at": "2026-01-15T09:30:00Z",
    "created_by": "string",
    "error_code": "string",
    "error_msg": "string",
    "service_name": "verilive",
    "service_status": "real",
    "error_codes": [
      "timeout"
    ],
    "warnings": [
      "timeout"
    ],
    "start_time": "2026-01-15T09:30:00Z",
    "end_time": "2026-01-15T09:30:00Z"
  }
}

GET

/journal/session/{session_id}

curl -X GET "https://demo.verigram.kz/journal/session/{session_id}" \
  -H "X-Verigram-Api-Key: $IDENTIFICATION_SAAS_API_KEY" \
  -H "X-Verigram-Api-Version: 2.0.0"

{
  "session_id": "string",
  "person_id": "string",
  "consumer_id": "string",
  "flow_id": "string",
  "vlink_id": "string",
  "api_version": "string",
  "service_name": "verilive",
  "session_status": "pass",
  "test_session": true,
  "step_id": "string",
  "process": "string",
  "user_ip": "string",
  "vendor": "string",
  "created_at": "2026-01-15T09:30:00Z",
  "updated_at": "2026-01-15T09:30:00Z",
  "session_states": [
    {
      "state_name": "created",
      "created_at": "2026-01-15T09:30:00Z"
    }
  ],
  "result": {
    "created_at": "2026-01-15T09:30:00Z",
    "created_by": "string",
    "error_code": "string",
    "error_msg": "string",
    "service_name": "verilive",
    "service_status": "real",
    "error_codes": [
      "timeout"
    ],
    "warnings": [
      "timeout"
    ],
    "start_time": "2026-01-15T09:30:00Z",
    "end_time": "2026-01-15T09:30:00Z"
  }
}