curl

curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"status": "BLOCKED"}'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.users.updateStatus("user-123", {
  status: "ACTIVE",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Users.UpdateStatus(ctx, "user-123", didit.UsersUpdateStatusParams{
	Status: "ACTIVE",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.EntityStatusUpdateRequest;
import me.didit.types.UsersUpdateStatusParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.users().updateStatus("user-123", UsersUpdateStatusParams.builder()
        .status(EntityStatusUpdateRequest.Status.of("ACTIVE"))
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->users->updateStatus('user-123', [
    'status' => 'ACTIVE',
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Users.UpdateStatusAsync("user-123", new UsersUpdateStatusParams
{
    Status = "ACTIVE",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
  "vendor_data": "user-abc-123",
  "display_name": null,
  "full_name": "John Michael Doe",
  "date_of_birth": "1990-05-15",
  "effective_name": "John Michael Doe",
  "status": "BLOCKED",
  "metadata": {
    "tier": "premium",
    "source": "website"
  },
  "portrait_image_url": "https://<media-host>/...",
  "session_count": 3,
  "approved_count": 2,
  "declined_count": 0,
  "in_review_count": 1,
  "issuing_states": [
    "USA"
  ],
  "approved_emails": [
    "john@example.com"
  ],
  "approved_phones": [
    "+14155551234"
  ],
  "features": {
    "ID_VERIFICATION": "Approved",
    "LIVENESS": "Approved",
    "FACE_MATCH": "Approved",
    "AML": "Approved"
  },
  "features_list": [
    {
      "feature": "ID_VERIFICATION",
      "status": "Approved"
    },
    {
      "feature": "LIVENESS",
      "status": "Approved"
    },
    {
      "feature": "FACE_MATCH",
      "status": "Approved"
    },
    {
      "feature": "AML",
      "status": "Approved"
    }
  ],
  "last_session_at": "2025-06-15T10:30:00Z",
  "last_activity_at": "2025-06-15T10:30:00Z",
  "first_session_at": "2025-06-01T08:00:00Z",
  "tags": [
    {
      "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "tag": {
        "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
        "name": "VIP",
        "color": "#2567FF",
        "description": null,
        "source": "custom",
        "created_at": "2025-05-01T09:00:00Z",
        "updated_at": "2025-05-01T09:00:00Z"
      },
      "added_by_email": "analyst@acme.com",
      "added_by_name": "Jane Analyst",
      "created_at": "2025-06-02T11:00:00Z"
    }
  ],
  "comments": [
    {
      "uuid": "c1111111-2222-4333-8444-555555555555",
      "comment_type": "STATUS_CHANGED",
      "comment": "Chargeback fraud pattern confirmed",
      "actor_email": null,
      "actor_name": null,
      "previous_status": "ACTIVE",
      "new_status": "BLOCKED",
      "previous_value": null,
      "new_value": null,
      "changed_fields": [],
      "metadata": null,
      "mentioned_emails": [],
      "created_at": "2025-06-15T10:30:00Z"
    }
  ],
  "created_at": "2025-06-01T08:00:00Z",
  "updated_at": "2025-06-15T10:30:00Z"
}

Пользователи

API обновления статуса пользователя: блокировка и флаги

Блокируйте, помечайте флагом или активируйте пользователя вендора в Didit. Статус применяется к будущим KYC-сессиям и скринингу транзакций. Оплата за вызов.

PATCH

users

{vendor_data}

update-status

curl

curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"status": "BLOCKED"}'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.users.updateStatus("user-123", {
  status: "ACTIVE",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Users.UpdateStatus(ctx, "user-123", didit.UsersUpdateStatusParams{
	Status: "ACTIVE",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.EntityStatusUpdateRequest;
import me.didit.types.UsersUpdateStatusParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.users().updateStatus("user-123", UsersUpdateStatusParams.builder()
        .status(EntityStatusUpdateRequest.Status.of("ACTIVE"))
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->users->updateStatus('user-123', [
    'status' => 'ACTIVE',
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Users.UpdateStatusAsync("user-123", new UsersUpdateStatusParams
{
    Status = "ACTIVE",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
  "vendor_data": "user-abc-123",
  "display_name": null,
  "full_name": "John Michael Doe",
  "date_of_birth": "1990-05-15",
  "effective_name": "John Michael Doe",
  "status": "BLOCKED",
  "metadata": {
    "tier": "premium",
    "source": "website"
  },
  "portrait_image_url": "https://<media-host>/...",
  "session_count": 3,
  "approved_count": 2,
  "declined_count": 0,
  "in_review_count": 1,
  "issuing_states": [
    "USA"
  ],
  "approved_emails": [
    "john@example.com"
  ],
  "approved_phones": [
    "+14155551234"
  ],
  "features": {
    "ID_VERIFICATION": "Approved",
    "LIVENESS": "Approved",
    "FACE_MATCH": "Approved",
    "AML": "Approved"
  },
  "features_list": [
    {
      "feature": "ID_VERIFICATION",
      "status": "Approved"
    },
    {
      "feature": "LIVENESS",
      "status": "Approved"
    },
    {
      "feature": "FACE_MATCH",
      "status": "Approved"
    },
    {
      "feature": "AML",
      "status": "Approved"
    }
  ],
  "last_session_at": "2025-06-15T10:30:00Z",
  "last_activity_at": "2025-06-15T10:30:00Z",
  "first_session_at": "2025-06-01T08:00:00Z",
  "tags": [
    {
      "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "tag": {
        "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
        "name": "VIP",
        "color": "#2567FF",
        "description": null,
        "source": "custom",
        "created_at": "2025-05-01T09:00:00Z",
        "updated_at": "2025-05-01T09:00:00Z"
      },
      "added_by_email": "analyst@acme.com",
      "added_by_name": "Jane Analyst",
      "created_at": "2025-06-02T11:00:00Z"
    }
  ],
  "comments": [
    {
      "uuid": "c1111111-2222-4333-8444-555555555555",
      "comment_type": "STATUS_CHANGED",
      "comment": "Chargeback fraud pattern confirmed",
      "actor_email": null,
      "actor_name": null,
      "previous_status": "ACTIVE",
      "new_status": "BLOCKED",
      "previous_value": null,
      "new_value": null,
      "changed_fields": [],
      "metadata": null,
      "mentioned_emails": [],
      "created_at": "2025-06-15T10:30:00Z"
    }
  ],
  "created_at": "2025-06-01T08:00:00Z",
  "updated_at": "2025-06-15T10:30:00Z"
}

Обзор

Переводит сущность User между статусами ACTIVE, FLAGGED и BLOCKED. Полный конечный автомат см. в разделе жизненный цикл сущности.

Когда использовать

Заблокировать пользователя после подтверждения мошенничества или нарушения требований комплаенса.
Пометить пользователя для ручной проверки, не блокируя его жёстко.
Разблокировать пользователя после успешного устранения причин.
Передавать внешние сигналы: например, когда ваш собственный движок выявления мошенничества присваивает пользователю оценку выше порога, переведите его в FLAGGED через этот endpoint.

Примечания

Допустимые значения: ACTIVE, FLAGGED, BLOCKED. Недопустимые значения возвращают 400.
Передайте необязательный параметр reason (до 1000 символов), чтобы записать причину изменения статуса. Didit сохраняет его как комментарий к записи об изменении статуса в активности пользователя: comments[].comment у пользователя и Активность в Business Console. Он записывается только тогда, когда статус действительно меняется.
Для пользователей со статусом BLOCKED все новые сессии и все новые транзакции автоматически отклоняются.
Отправляет webhook user.status.updated с полями previous_status и status. Webhook не содержит reason.

Применение статусов

Статус	Влияние на новые сессии	Влияние на новые транзакции
`ACTIVE`	Обычный процесс	Обычный процесс
`FLAGGED`	Разрешено, но направляется в `IN_REVIEW`	Разрешено; может автоматически эскалироваться в зависимости от правил
`BLOCKED`	Автоматически отклоняется	Автоматически отклоняется

Разрешения

Основной секретный ключ и API-ключи с полным доступом всегда могут вызывать этот endpoint. Ключу с настраиваемым доступом требуется разрешение на запись в разделе People (users). Ключ, ограниченный отдельными сценариями или одобренными сессиями, не может обратиться к этому endpoint. Роли и разрешения в Console определяют, что может делать член команды в Console. Для запросов с API-ключами они не проверяются.

Связанные разделы

Авторизации

x-api-key

string

header

обязательно

API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.

Параметры пути

vendor_data

string

обязательно

Ваш уникальный идентификатор пользователя.

Тело

application/json

status

enum<string>

обязательно

Новый статус жизненного цикла. BLOCKED также добавляет vendor_data в системный список блокировки.

Доступные опции:

ACTIVE,

FLAGGED,

BLOCKED

reason

string | null

Причина изменения статуса. Записывается в записи об изменении статуса в активности пользователя (comments[].comment и раздел Activity в Business Console), только когда статус действительно меняется. В webhook не передается.

Maximum string length: 1000

Ответ

Статус пользователя обновлён. Возвращается полная запись пользователя.

Полные сведения о пользователе. Дополняет UserListItem метаданными, комментариями и updated_at.

didit_internal_id

string<uuid>

Стабильный внутренний UUID Didit для этого пользователя.

vendor_data

string | null

Ваш уникальный идентификатор этого пользователя (передаётся при создании сессий). Может быть равен null, если идентификатор поставщика не был передан.

display_name

string | null

Пользовательское отображаемое имя, заданное вами

full_name

string | null

Полное имя, извлечённое из верифицированных документов

date_of_birth

string<date> | null

effective_name

string | null

Наиболее подходящее имя: display_name, если задано, иначе full_name

status

enum<string>

Статус жизненного цикла записи пользователя (НЕ статус сессии). ACTIVE используется по умолчанию, FLAGGED помечает пользователя для ручной проверки, BLOCKED запрещает новые сессии для этого vendor_data.

Доступные опции:

ACTIVE,

FLAGGED,

BLOCKED

portrait_image_url

string | null

Предварительно подписанный URL портретного фото пользователя (срок действия истекает через несколько часов)

session_count

integer

Общее количество сессий верификации для этого пользователя

approved_count

integer

Количество одобренных сессий

declined_count

integer

Количество отклонённых сессий

in_review_count

integer

Количество сессий на проверке

issuing_states

string[]

Коды стран выдачи по стандарту ISO 3166-1 alpha-3, указанные в одобренных документах, удостоверяющих личность этого пользователя, например ["USA", "ESP"]. Пустой массив, если таких кодов нет.

approved_emails

string[]

Подтверждённые адреса электронной почты, собранные из одобренных сессий этого пользователя, например ["john@example.com"].

approved_phones

string[]

Подтверждённые номера телефонов, собранные из одобренных сессий этого пользователя, например ["+14155551234"].

features

object

Агрегированный статус по функциям среди всех сессий этого пользователя. Возможные ключи: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Возможные значения: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list

object[]

Те же данные, что и features, в виде упорядоченного массива объектов {feature, status}.

Show child attributes

last_session_at

string<date-time> | null

Временная метка последней сессии

first_session_at

string<date-time> | null

Временная метка первой сессии

last_activity_at

string<date-time> | null

Временная метка последней активности по этому пользователю (сессия, транзакция, смена статуса, редактирование данных и т. д.).

​Обзор

​Когда использовать

​Примечания

​Применение статусов

​Разрешения

​Связанные разделы

Авторизации

Параметры пути

Тело

Ответ

Обзор

Когда использовать

Примечания

Применение статусов

Разрешения

Связанные разделы