Получение процессаGET

Получите процесс Human Token по его идентификатору — после возвращения пользователя из Human Token Journey или для повторного запроса результата API Only.

Markdown

Эндпоинт

Среда	URL
Production	GET https://humantoken.unico.app/client/v1/process/{processId}

Запрос

Заголовки

Заголовок	Значение
x-unico-accesskey	<your_access_key> (см. Аутентификация)

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

Параметр	Тип	Обязательно	Описание
processId	string (UUID)	да	Идентификатор процесса, возвращённый Создать процесс.

Пример

cURL

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

Node.js

import fetch from 'node-fetch';

const res = await fetch(
  `https://humantoken.unico.app/client/v1/process/${processId}`,
  { headers: { 'x-unico-accesskey': process.env.UNICO_ACCESS_KEY } }
);
const result = await res.json();
// result.data.humanToken.value

Ответы

200 OK

Ответ имеет тот же формат, что и в Создать процесс. Структура data зависит от потока, использованного при создании процесса.

Стандартные потоки (api+humantoken, api+liveness+humantoken, humantoken):

{
  "id": "6ed74799-4c2f-4023-b43f-a73cf7c847b2",
  "state": "PROCESS_STATE_FINISHED",
  "data": {
    "humanToken": {
      "value": "3f9a1c7e5b2d4086a1e3c5f7092b4d6e8a0c2e4f6183a5c7e9b1d3f5072a4c6e",
      "status": "validated"
    }
  }
}

Потоки ревалидации (api+liveness+humantoken+revalidation, humantoken+revalidation):

{
  "id": "cb0472c0-6dbc-46c6-b830-2be7edc35424",
  "state": "PROCESS_STATE_FINISHED",
  "data": {
    "humanTokenMatch": "true"
  }
}

Поле	Тип	Описание
id	string (UUID)	Идентификатор процесса.
state	string	Состояние процесса — см. значения state.
data.​humanToken.​value	string	Только стандартные потоки. Стабильный непрозрачный идентификатор лица (до 100 символов). Один и тот же человек всегда соответствует одному и тому же значению.
data.​humanTokenMatch	string	Только потоки ревалидации. "true", если селфи совпадает с указанным humanToken, "false" в противном случае.

Значения state

Значение	Описание
PROCESS_STATE_UNSPECIFIED	Состояние не задано.
PROCESS_STATE_CREATED	Процесс создан и всё ещё принимает новые сессии. data равно {}.
PROCESS_STATE_FINISHED	Процесс завершён и больше не принимает новые сессии. Для стандартных потоков data.humanToken присутствует, если Human Token был сгенерирован; для потоков ревалидации data.humanTokenMatch показывает, совпало ли селфи с указанным токеном. Иначе data равно {}.
PROCESS_STATE_FAILED	Процесс завершился ошибкой. data равно {}.
PROCESS_STATE_CANCELED	Процесс отменён. data равно {}.
PROCESS_STATE_AWAITING_FOR_DOCUMENT	Процесс ожидает документ, удостоверяющий личность. data равно {}.

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

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

Коды ошибок

400 Bad Request

Код	Сообщение	Описание
3	process id is invalid	Когда идентификатор процесса недействителен.

401 Unauthorized

Ключ доступа отсутствует или недействителен в заголовке x-unico-accesskey. См. Аутентификация.

404 Not Found

Код	Сообщение	Описание
5	error getting process: rpc error: code = NotFound desc = process not found	Когда процесс с указанным идентификатором не найден.

429 Too Many Requests

Достигнут лимит запросов. Когда ваша система получает ошибку HTTP 429, необходимо реализовать механизмы для предотвращения каскадных сбоев и избежания усугубления ограничения.

Лучшие практики:

• Период ожидания (backoff): Немедленно остановите или снизьте частоту последующих запросов из вашей системы. Не повторяйте неудачные запросы непрерывно в тесном цикле.
• Очередь и ограничение (Queueing & throttling): Буферизируйте или ставьте в очередь исходящие запросы на вашей стороне для контроля потока трафика перед их повторной отправкой.
• Экспоненциальный backoff с джиттером: При повторных попытках увеличивайте время ожидания экспоненциально между попытками (например, 1 с, 2 с, 4 с, 8 с) и добавляйте небольшую случайную задержку ("джиттер"), чтобы предотвратить эффект стада, когда все запросы из очереди повторяются в одну и ту же миллисекунду.

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

Непрерывная отправка запросов к эндпоинту с ограничением частоты без применения backoff может продлить период ограничения и серьезно снизить операционную пропускную способность вашей системы. Правильное ограничение запросов на вашей стороне обеспечивает более плавную и устойчивую интеграцию.

Информацию о лимитах по умолчанию, увеличении запросов и дополнительные сведения см. в разделе Лимиты запросов.

500 Internal Server Error

Код	Сообщение	Описание
99999	Internal failure! Try again later	Когда возникает внутренняя ошибка.

Что дальше

• Вернитесь к Создать процесс, чтобы отправить новое селфи.
• Чтобы понять, что представляет собой humanToken и когда он не генерируется, см. обзор Human Token.