Обзор API Reference

Всё, что нужно, чтобы пройти путь от нуля до первого humanToken.

Markdown

Human Token имеет три эндпоинта. На этой странице показано, как они взаимодействуют, чтобы вы могли сразу приступить к интеграции.

Базовый URL

Среда	Базовый URL
Продакшен	https://humantoken.unico.app

Все запросы требуют заголовок x-unico-accesskey. См. Аутентификация, чтобы сгенерировать ключ.

---

Быстрый старт

---

Шаг 1 — Аутентификация

Сгенерируйте x-unico-accesskey в Human Dashboard или через Authentication API. Все запросы ниже используют этот ключ.

x-unico-accesskey: uip_ak.prod.a1b2c3d4.e5f6g7h8.i9j0k1l2

---

Шаг 2 — Создать процесс

Вызовите Create Process, чтобы начать верификацию. Выберите одну из двух моделей:

Модель	Потоки	Как это работает
API Only	api+humantoken, api+liveness+humantoken, api+liveness+humantoken+revalidation	Ваш бэкенд отправляет селфи как imageBase64. humanToken возвращается в том же ответе.
Human Token Journey	humantoken, humantoken+revalidation	Пользователь завершает захват на платформе Unico. Вы получаете token и link для показа journey, затем получаете результат через Get Process.

Пример API Only:

curl -X POST https://humantoken.unico.app/client/v1/process \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "api+humantoken",
    "imageBase64": "<base64-encoded-selfie>",
    "companyBranchId": "<your-branch-id>"
  }'

Пример Human Token Journey:

curl -X POST https://humantoken.unico.app/client/v1/process \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "humantoken",
    "callbackUri": "https://yourapp.com/callback",
    "companyBranchId": "<your-branch-id>"
  }'

См. Create Process для описания всех потоков, параметров и деталей ответа.

---

Шаг 3 — Показать journey пользователю (только потоки Journey)

Для потоков humantoken и humantoken+revalidation ответ Create Process включает:

• token — инициализирует Web SDK или нативную интеграцию
• link — URL для перенаправления пользователя

Выберите интеграцию, подходящую для вашей платформы:

Платформа	Подход
Web — SDK	Встройте journey с помощью idpay-b2b-sdk → Web Integration
Web — Redirect	Перенаправьте пользователя на link → Web Integration
Android	Custom Tabs → Android
iOS	ASWebAuthenticationSession → iOS
Ionic	Capacitor plugin → Ionic
React Native	Native module → React Native
Flutter	Platform Channels → Flutter

Когда journey завершается, пользователь возвращается на ваш callbackUri. Перейдите к шагу 4.

Потоки API Only

Пропустите этот шаг — результат уже содержится в ответе Create Process.

---

Шаг 4 — Получить результат (только потоки Journey)

Вызовите Get Process с id процесса, чтобы получить результат:

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY"

Ответ включает data.humanToken.value (стандартные потоки) или data.humanTokenMatch (потоки ревалидации). См. Get Process для полной схемы ответа и значений состояний.

---

Шаг 5 — Использовать humanToken

humanToken — это стабильный непрозрачный идентификатор (до 100 символов). Один и тот же человек всегда разрешается в одно и то же значение.

const { humanToken } = process.data;

if (!humanToken?.value) {
  // Inconclusive — retry or reject per your business rules
  return;
}

const existing = await db.persons.findByHumanToken(humanToken.value);

if (existing) {
  // Same person seen before — returning user or duplicate
} else {
  // First time — create a new record
  await db.persons.create({ humanToken: humanToken.value });
}

предупреждение

Всегда проверяйте, что data.humanToken.value не пуст, прежде чем сохранять или сопоставлять его.

---

Шаг 6 — Получить селфи (необязательно)

Вызовите Get Selfie, чтобы скачать захваченное изображение. Селфи доступно в течение 24 часов после завершения процесса — после этого оно удаляется безвозвратно.

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID/selfie \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY"

См. Get Selfie для деталей ответа и кодов ошибок.

---

Эндпоинты обзорно

Метод	Эндпоинт	Описание
POST	/client/v1/process	Create Process — начать верификацию
GET	/client/v1/process/{processId}	Get Process — получить результат
GET	/client/v1/process/{processId}/selfie	Get Selfie — скачать селфи (24 ч)

Что дальше

• Create Process — полный справочник параметров для всех пяти потоков
• Authentication — генерация и управление ключами доступа
• Build With LLM — вставьте промпт в ваш AI-ассистент для генерации полной интеграции