Перейти к основному содержимому

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

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

Перед получением процесса ознакомьтесь с настройкой вебхуков и стратегиями резервного варианта — нажмите здесь.

В контракте API ответ POST /processes/v1 уже является итоговым результатом. Этот endpoint предназначен для повторных запросов — например, когда нужно просмотреть ранее сохранённый процесс или провести аудит предыдущей транзакции. В API-контракте ответ POST /processes/v1 уже является финальным результатом. Этот эндпоинт существует для повторных запросов -- например, когда вам нужно проверить процесс, который вы сохранили ранее, или провести аудит предыдущей транзакции.

Эндпоинт​

ОкружениеURL
ProductionGET https://api.id.unico.app/processes/v1/{processId}
SandboxGET https://api.id.uat.unico.app/processes/v1/{processId}

Запрос​

Заголовки
ЗаголовокЗначение
AuthorizationBearer <access_token>
APIKEYПредоставленный API-ключ.
Параметры пути
ПараметрТипОбязательныйОписание
processIdstring (UUID)даИдентификатор процесса, возвращённый при Создании процесса.

Пример​

curl -X GET https://api.id.unico.app/processes/v1/$PROCESS_ID \
  -H "Authorization: Bearer $TOKEN" \
  -H "APIKEY: $API_KEY"

Ответы​

200 OK
{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "yes"
  },
  "riskLevel": {
    "result": "inconclusive"
  },
  "idFace": {
    "personId": "a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890",
    "result": "FOUND"
  },
  "identityFraudsters": {
    "result": "inconclusive"
  },
  "government": {
    "serpro": 87
  },
  "liveness": 1
}
Поля ответа зависят от вашего APIKey

В приведённом выше примере показаны все возможные поля возможностей. В реальном ответе будут только поля для возможностей, включённых в конфигурации вашего APIKey — поля для отключённых возможностей полностью отсутствуют. Свяжитесь с вашим менеджером проекта Unico для включения или изменения возможностей.

ПолеТипОписание
idstring (UUID)Идентификатор процесса.
statusinteger1 (обработка), 2 (расхождение), 3 (завершён успешно), 4 (отменён), 5 (ошибка).
unicoId.resultstringyes, no, inconclusive -- см. Проверка личности.
riskLevel.resultstringnot_approved, critical_risk, high_risk, inconclusive -- см. Классификация рисков мошенничества.
idFace.resultstringFOUND, NOT_FOUND -- см. Идентификатор лица.
idFace.personIdstringСтабильный непрозрачный идентификатор лица. Присутствует только при idFace.result = FOUND.
identityFraudsters.resultstringУстарело. Используйте вместо него riskLevel. Клиенты с текущими интеграциями могут продолжать использовать это поле, согласовывая миграцию с командой проекта.
government.serprointegerОценка сходства Serpro (0--100, -1, -2). Доступно только в Бразилии. См. Результат проверки сходства Serpro.
livenessinteger1 (пройдено), 2 (не пройдено) -- см. Проверка живости.
scoreintegerВероятностная оценка риска. Присутствует, когда unicoId.result = inconclusive и оркестрация Риск-скора активна. Положительные значения указывают на более высокую вероятность того, что это держатель; отрицательные значения указывают на более высокий риск. Доступно только в Бразилии.
400 Bad Request

Параметр пути processId отсутствует или имеет неверный формат. См. Коды ошибок ниже.

403 Forbidden

Bearer-токен или APIKEY отсутствует, истёк или недействителен.

404 Not Found

processId не существует или не принадлежит аутентифицированному тенанту.

410 Gone

Процесс существует, но завершился с ошибкой. Возвращает только id и status: 5.

429 Too Many Requests

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

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

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

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

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

500 Internal Server Error

Непредвиденная ошибка сервера.

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

API-контракт возвращает результаты синхронно, поэтому большинству интеграций этот эндпоинт не нужен. Используйте его, когда:

  • Вы сохранили только processId и позже хотите получить полный результат (аудит, поддержка).
  • Вы подозреваете, что оригинальный ответ был утерян при передаче (сетевая ошибка после того, как платформа завершила обработку).
  • Вы создаёте бэк-офисный инструмент для просмотра исторических процессов.

Коды ошибок​

КодСообщениеОписание
20023O parâmetro processId não foi informado.Параметр process id отсутствует.
20002O parâmetro APIKey não foi informado.Параметр APIKEY отсутствует в заголовке запроса.
20001O parâmetro authtoken não foi informado.Параметр токена интеграции отсутствует в заголовке запроса.
Последнее обновление