API referenceFace

Insert a face

Enroll a face by providing person_id and a base64-encoded image. collection defaults to default. If collection is set to custom, custom_collection parameter is required. The service extracts and stores the face embedding for the authenticated consumer. Enrolling the same person_id in the same collection replaces its existing embedding. HTTP 201 contains a completed session projection with: - service_name: veriface - session_status: pass - result.action: enroll - result.service_status: enrolled

POST

/face

POST

/face

curl -X POST "https://demo.verigram.kz/face" \
  -H "X-Verigram-Api-Key: $IDENTIFICATION_SAAS_API_KEY" \
  -H "X-Verigram-Api-Version: 2.0.0" \
  -H "Content-Type: application/json" \
  -d '{
  "person_id": "string",
  "image": "string"
}'

Авторизация

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

person_id
string
обязательно
Person ID
collection
enum<string>
Collection name
Одно из:
blacklist
whitelist
graylist
watchlist
default
custom
Значение по умолчанию:
default
custom_collection
string
Custom collection name, use when 'collection' is set to 'custom'
image
string<byte>
обязательно
Base64 encoded image

Ответ

application/json

Face embedding enrolled successfully.

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": "face-enrolled-S",
  "person_id": "person-123",
  "consumer_id": "consumer-123",
  "flow_id": "face-flow-F",
  "api_version": "2.0.0",
  "service_name": "veriface",
  "session_status": "pass",
  "created_at": "2026-10-02T10:00:00Z",
  "updated_at": "2026-10-02T10:00:01Z",
  "session_states": [
    {
      "state_name": "created",
      "created_at": "2026-10-02T10:00:00Z"
    },
    {
      "state_name": "processed",
      "created_at": "2026-10-02T10:00:01Z"
    }
  ],
  "result": {
    "service_name": "veriface",
    "service_status": "enrolled",
    "action": "enroll",
    "score": null,
    "collection": "default",
    "custom_collection": null,
    "error_code": null,
    "error_msg": null,
    "created_at": "2026-10-02T10:00:01Z",
    "created_by": "system"
  }
}

POST

/face

curl -X POST "https://demo.verigram.kz/face" \
  -H "X-Verigram-Api-Key: $IDENTIFICATION_SAAS_API_KEY" \
  -H "X-Verigram-Api-Version: 2.0.0" \
  -H "Content-Type: application/json" \
  -d '{
  "person_id": "string",
  "image": "string"
}'

{
  "session_id": "face-enrolled-S",
  "person_id": "person-123",
  "consumer_id": "consumer-123",
  "flow_id": "face-flow-F",
  "api_version": "2.0.0",
  "service_name": "veriface",
  "session_status": "pass",
  "created_at": "2026-10-02T10:00:00Z",
  "updated_at": "2026-10-02T10:00:01Z",
  "session_states": [
    {
      "state_name": "created",
      "created_at": "2026-10-02T10:00:00Z"
    },
    {
      "state_name": "processed",
      "created_at": "2026-10-02T10:00:01Z"
    }
  ],
  "result": {
    "service_name": "veriface",
    "service_status": "enrolled",
    "action": "enroll",
    "score": null,
    "collection": "default",
    "custom_collection": null,
    "error_code": null,
    "error_msg": null,
    "created_at": "2026-10-02T10:00:01Z",
    "created_by": "system"
  }
}

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

Insert a face - Verigram Центр помощи

API referenceFace

Insert a face

POST

/face

POST

/face

curl -X POST "https://demo.verigram.kz/face" \
  -H "X-Verigram-Api-Key: $IDENTIFICATION_SAAS_API_KEY" \
  -H "X-Verigram-Api-Version: 2.0.0" \
  -H "Content-Type: application/json" \
  -d '{
  "person_id": "string",
  "image": "string"
}'

Авторизация

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

person_id
string
обязательно
Person ID
collection
enum<string>
Collection name
Одно из:
blacklist
whitelist
graylist
watchlist
default
custom
Значение по умолчанию:
default
custom_collection
string
Custom collection name, use when 'collection' is set to 'custom'
image
string<byte>
обязательно
Base64 encoded image

Ответ

application/json

Face embedding enrolled successfully.

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": "face-enrolled-S",
  "person_id": "person-123",
  "consumer_id": "consumer-123",
  "flow_id": "face-flow-F",
  "api_version": "2.0.0",
  "service_name": "veriface",
  "session_status": "pass",
  "created_at": "2026-10-02T10:00:00Z",
  "updated_at": "2026-10-02T10:00:01Z",
  "session_states": [
    {
      "state_name": "created",
      "created_at": "2026-10-02T10:00:00Z"
    },
    {
      "state_name": "processed",
      "created_at": "2026-10-02T10:00:01Z"
    }
  ],
  "result": {
    "service_name": "veriface",
    "service_status": "enrolled",
    "action": "enroll",
    "score": null,
    "collection": "default",
    "custom_collection": null,
    "error_code": null,
    "error_msg": null,
    "created_at": "2026-10-02T10:00:01Z",
    "created_by": "system"
  }
}

POST

/face

curl -X POST "https://demo.verigram.kz/face" \
  -H "X-Verigram-Api-Key: $IDENTIFICATION_SAAS_API_KEY" \
  -H "X-Verigram-Api-Version: 2.0.0" \
  -H "Content-Type: application/json" \
  -d '{
  "person_id": "string",
  "image": "string"
}'

{
  "session_id": "face-enrolled-S",
  "person_id": "person-123",
  "consumer_id": "consumer-123",
  "flow_id": "face-flow-F",
  "api_version": "2.0.0",
  "service_name": "veriface",
  "session_status": "pass",
  "created_at": "2026-10-02T10:00:00Z",
  "updated_at": "2026-10-02T10:00:01Z",
  "session_states": [
    {
      "state_name": "created",
      "created_at": "2026-10-02T10:00:00Z"
    },
    {
      "state_name": "processed",
      "created_at": "2026-10-02T10:00:01Z"
    }
  ],
  "result": {
    "service_name": "veriface",
    "service_status": "enrolled",
    "action": "enroll",
    "score": null,
    "collection": "default",
    "custom_collection": null,
    "error_code": null,
    "error_msg": null,
    "created_at": "2026-10-02T10:00:01Z",
    "created_by": "system"
  }
}