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

Получение существующего процесса по его идентификатору. Согласно API-контракту, результат уже возвращается синхронно при создании процесса — используйте этот эндпоинт для повторных запросов, аудита и поддержки.

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

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

Эндпоинт

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

Запрос

Заголовки

Заголовок	Значение
Authorization	Bearer <access_token>
APIKEY	Предоставленный API-ключ.

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

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

Пример

cURL

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

Node.js

import fetch from 'node-fetch';

const res = await fetch(
  `https://api.id.unico.app/processes/v1/${processId}`,
  {
    headers: {
      Authorization: `Bearer ${accessToken}`,
      APIKEY: apiKey
    }
  }
);
const result = await res.json();

Ответы

200 OK

Контракт единый — поле idCloud.result содержит консолидированный вердикт используемых возможностей.

Unico консолидирует результаты выполненных возможностей в единое поле idCloud.result, готовое для принятия решения о следующем шаге вашего флоу — без необходимости оркестрировать отдельные результаты.

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "idCloud": {
    "result": "approved"
  }
}

Возможные значения результата

idCloud.result	Meaning	Recommended action
approved	Real person and validated identity.	Proceed with the flow.
denied	Identity not validated, liveness check failed, or extreme risk identified.	End the flow or redirect to an alternative flow.
critical-risk	Critical risk level identified.	End the flow or route to manual review.
high-risk	High risk level identified.	Route to manual review or an alternative flow.
retry	Insufficient capture or score to evaluate.	Ask the user for a new capture.
inconclusive	Not enough evidence for a verdict.	Route to manual review or an alternative flow.

Возвращаемые значения зависят от рецепта, настроенного в вашем APIKey. См. Потоки — значения результата, которые может вернуть каждый рецепт.

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

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

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

Коды ошибок

400 Bad Request

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

404 Not Found

Код	Сообщение	Описание
50001	O processo informado não foi encontrado.	Процесс не существует в базе данных.

403 Forbidden

Код	Сообщение	Описание
30017	User does not have permission to perform this action.	Некорректный JWT или пользователь без разрешения на выполнение этой операции.
10502	O token informado está expirado.	Использованный access-token истёк.
10501	O token informado é inválido.	Токен аутентификации недействителен.
10201	O AppKey informado é inválido.	Параметр APIKEY не был указан или не существует.

410 Gone

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

429 Too Many Requests

Rate limit reached. When your system receives an HTTP 429 error, you must implement mechanisms to prevent cascading failures and avoid worsening the restriction.

Best practices:

• Cool-down period (backoff): Immediately halt or throttle subsequent requests from your system. Do not continuously retry failed requests in a tight loop.
• Queueing & throttling: Buffer or queue outgoing requests on your end to control the traffic flow before re-sending them.
• Exponential backoff with jitter: When retrying, increase the waiting time exponentially between attempts (e.g., 1 s, 2 s, 4 s, 8 s) and add a small random delay ("jitter") to prevent a herd effect where all queued requests retry at the exact same millisecond.

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

Continuously hitting a rate-limited endpoint without backing off can prolong the restriction period and severely impact your system's operational throughput. Properly throttling requests on your side ensures a smoother, more resilient integration.

For default limits, increase requests and additional details, see Rate Limits.

500 Internal Server Error

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

Потоки

Рецепт — это комбинация возможностей (проверка живости, проверка личности, сигналы риска, документы...), настроенных в APIKey вашего проекта. Он определяет, что именно Unico выполняет в каждом процессе и как результаты консолидируются в единое поле result — вам не нужно ничего оркестровать на своей стороне.

Unico поддерживает каталог предустановленных рецептов, именованных и версионированных (например, byunico-idlive-idunico-oneresponse-std). Некоторые доступны только в Бразилии — например, включающие Риск-скор, Serpro или проверку возраста.

Какие возможности выполняются в вашем процессе?

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