Перейти к основному содержимому
Получение процессаGET

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

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

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

Эндпоинт​

Окружение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

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

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

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "idCloud": {
    "result": "approved"
  }
}
ПолеТипОписание
idstring (UUID)Идентификатор процесса.
statusinteger1 (обработка), 2 (расхождение), 3 (завершён успешно), 4 (отменён), 5 (ошибка).
Возможные значения результата
idCloud.resultЗначениеРекомендуемое действие
approvedРеальный человек и подтверждённая личность.Продолжить флоу.
deniedЛичность не подтверждена, проверка живости не пройдена или выявлен экстремальный риск.Завершить флоу или перенаправить на альтернативный флоу.
critical-riskВыявлен критический уровень риска.Завершить флоу или направить на ручную проверку.
high-riskВыявлен высокий уровень риска.Направить на ручную проверку или альтернативный флоу.
retryНедостаточно данных захвата или скора для оценки.Запросить у пользователя новый захват.
inconclusiveНедостаточно доказательств для вынесения вердикта.Направить на ручную проверку или альтернативный флоу.

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

BrazilКлиенты в Бразилии могут получать ответ по возможностям

Общая структура ответа остаётся прежней — единый результат используется по умолчанию.

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

{
  "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,
  "idAge": {
    "result": "yes"
  },
  "cardholderVerification": {
    "result": "approved"
  }
}
ПолеТипОписание
unicoId.resultstringyes, no, inconclusive — см. Проверку личности.
riskLevel.resultstringnot_approved, critical_risk, high_risk, inconclusive — см. Классификацию рисков мошенничества.
idFace.resultstringFOUND — см. Идентификатор лица.
idFace.personIdstringСтабильный непрозрачный идентификатор лица, возвращается вместе с idFace.result = FOUND. Если лицо не удаётся идентифицировать на изображении, процесс возвращает ошибку 20532 вместо блока idFace.
identityFraudsters.resultstringУстарело. Используйте вместо него riskLevel. Клиенты с текущими интеграциями могут продолжать использовать это поле, согласовывая миграцию с командой проекта.
government.serprointegerОценка сходства Serpro (0–100, -1, -2). Доступно только в Бразилии. См. Результат проверки сходства Serpro.
livenessinteger1 (пройдено), 2 (не пройдено) — см. Проверку живости.
idAge.resultstringyes, no, inconclusive — см. Проверку возраста. Доступно только в Бразилии.
scoreintegerВероятностная оценка риска. Присутствует, когда unicoId.result = inconclusive и оркестрация риск-скора активна. Положительные значения указывают на более высокую вероятность того, что это держатель; отрицательные значения указывают на более высокий риск. Доступно только в Бразилии.
cardholderVerification.resultstringapproved, unsure — см. Cardholder Verification. Отсутствует, пока status не станет равным 3 (завершён). Доступно только в Бразилии.
MexicoКлиенты в Мексике могут получать блок RENAPO Verification

Структура ответа остаётся прежней, добавляется блок idGov.

Интеграции в Мексике с включённой RENAPO Verification получают дополнительный блок idGov с записью, которую RENAPO хранит по CURP пользователя. Это отдельный ответ, не связанный с результатом проверки личности.

{
  "id": "11111111-2222-3333-4444-555555555555",
  "status": 3,
  "idCloud": { "result": "approved" },
  "idGov": {
    "government_valid": true,
    "curp": "PUEA880304MDFRJN04",
    "government_name": "ANA PRUEBA EJEMPLO",
    "date_of_birth": "1988-03-04",
    "age": 38,
    "gender": "F",
    "deceased": false,
    "is_mexican": true,
    "citizenship": "MEXICO",
    "state_of_birth": "Ciudad de México",
    "state_iso": "MX-CMX",
    "issuing_entity_code": "DF",
    "municipality_registration": ""
  }
}
ПолеТипОписание
idGovobjectЗапись RENAPO по CURP. Отсутствует, если возможность не включена. {}, если RENAPO не ответил. Только Мексика. См. RENAPO Verification.

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

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.Параметр токена интеграции отсутствует в заголовке запроса.

Потоки​

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

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

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

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

Последнее обновление