Получить процесс
Перед получением процесса ознакомьтесь с настройкой вебхуков и стратегиями резервного варианта — нажмите здесь.
В контракте API ответ POST /processes/v1 уже является итоговым результатом. Этот endpoint предназначен для повторных запросов — например, когда нужно просмотреть ранее сохранённый процесс или провести аудит предыдущей транзакции.
Endpoint
| Среда | 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) | да | Идентификатор процесса, возвращённый методом Create Process. |
Пример
- cURL
- Node.js
curl -X GET https://api.id.unico.app/processes/v1/$PROCESS_ID \
-H "Authorization: Bearer $TOKEN" \
-H "APIKEY: $API_KEY"
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();
Ответы
{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"unicoId": { "result": "yes" },
"identityFraudsters": { "result": "inconclusive" },
"government": { "serpro": 87 },
"liveness": 1
}
| Поле | Тип | Описание |
|---|---|---|
id | string (UUID) | Идентификатор процесса. |
status | integer | 1 (обработка), 2 (расхождение), 3 (успешно завершён), 4 (отменён), 5 (ошибка). |
unicoId.result | string | yes, no, inconclusive — см. Identity Verification. |
identityFraudsters.result | string | yes, inconclusive — см. Risk Fraud Classification. |
government.serpro | integer | Показатель сходства Serpro (0–100, -1, -2). См. Serpro Similarity. |
liveness | integer | 1 (прошёл), 2 (не прошёл) — см. Liveness. |
score | integer | Вероятностная оценка риска. Присутствует, когда unicoId.result = inconclusive и активна оркестрация Risk Score. Положительные значения указывают на более высокую вероятность того, что это владелец; отрицательные — на повышенный риск. |
Параметр пути processId отсутствует или имеет неверный формат. См. Коды ошибок ниже.
Bearer-токен или APIKEY отсутствуют, истекли или недействительны.
processId не существует или не принадлежит аутентифицированному тенанту.
Процесс существует, но завершился ошибкой. Возвращает только id и status: 5.
Достигнут лимит запросов. См. Rate limits.
Непредвиденная ошибка сервера.
Когда использовать этот endpoint
Контракт API возвращает результаты синхронно, поэтому большинству интеграций этот endpoint не нужен. Используйте его в следующих случаях:
- Вы сохранили только
processIdи хотите позже получить полный результат (аудит, поддержка). - Вы подозреваете, что исходный ответ был потерян при передаче (сетевая ошибка после завершения обработки на платформе).
- Вы разрабатываете внутренний инструмент для просмотра исторических процессов.
Коды ошибок
- 400 Bad Request
- 404 Not Found
- 403 Forbidden
- 410 Gone
- 500 Internal Server Error
| Код | Сообщение | Описание |
|---|---|---|
20023 | O parâmetro processId não foi informado. | Параметр идентификатора процесса отсутствует. |
20002 | O parâmetro APIKey não foi informado. | Параметр APIKEY отсутствует в заголовке запроса. |
20001 | O parâmetro authtoken não foi informado. | Параметр токена интеграции отсутствует в заголовке запроса. |
| Код | Сообщение | Описание |
|---|---|---|
50001 | O processo informado não foi encontrado. | Процесс не существует в базе данных. |
| Код | Сообщение | Описание |
|---|---|---|
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 не введён или не существует. |
Процесс существует, но завершился ошибкой. Возвращает только id и status: 5.
| Код | Сообщение | Описание |
|---|---|---|
99999 | Internal failure! Try again later | Внутренняя ошибка. |