--- title: Получение процесса description: Получение текущего состояния и результата процесса верификации. canonical: https://developer.unico.io/ru/developers/api-reference/get-process locale: ru generated_by: markdown-export --- - [/ru/](/ru/) - Справочник API - Получение процесса **На этой страницеПолучение процессаGETПолучение существующего процесса по его идентификатору. Согласно контракту API, результат уже возвращается синхронно при создании процесса — используйте этот эндпоинт для повторных запросов, аудита и поддержки. предупреждениеПеред получением процесса ознакомьтесь с настройкой вебхуков и стратегиями резервного варианта — [нажмите здесь](/ru/developers/webhooks-and-events/setup). ### Эндпоинт​ СредаURL**Production**`GET https://api.idcloud.unico.app/client/v1/process/{processId}`**Sandbox**`GET https://api.idcloud.uat.unico.app/client/v1/process/{processId}` ### Запрос​ Заголовки ЗаголовокЗначение`Authorization``Bearer ` Параметры пути ПараметрТипОбязателенОписание`processId`string (UUID)даИдентификатор процесса, возвращённый [Создать процесс](/ru/developers/api-reference/post-processes). ### Пример​ cURLNode.js``` curl -X GET https://api.idcloud.unico.app/client/v1/process/$PROCESS_ID \ -H "Authorization: Bearer $TOKEN" ``` ``` import fetch from 'node-fetch';const res = await fetch( `https://api.idcloud.unico.app/client/v1/process/${processId}`, { headers: { Authorization: `Bearer ${accessToken}` } });const { process: proc } = await res.json(); ``` ### Ответы​ 200 OK ``` { "process": { "id": "226fd950-4b80-4da6-a476-ba9d397ddc91", "flow": "id_r2", "callbackUri": "/", "userRedirectUrl": "https://cadastro.uat.unico.app/flow?collect-data=true&dynamic-wrapper=true&id=226fd950-4b80-4da6-a476-ba9d397ddc91", "state": "PROCESS_STATE_FINISHED", "result": "PROCESS_RESULT_APPROVED", "createdAt": "2026-08-06T01:42:21.693615Z", "finishedAt": "2026-08-06T01:43:03.080508Z", "person": { "duiType": "DUI_TYPE_BR_CPF", "duiValue": "40*******50", "friendlyName": "teste", "email": "", "phone": "5511999999999", "notifications": [ { "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP" } ], "phoneCountryCodeAlpha3": "" }, "purpose": "personAuthentication", "services": [], "authenticationInfo": { "authenticationId": "55cba227-9828-49df-a16f-bcdaa7bdaa4d" }, "capacities": ["PROCESS_CAPACITY_IDCLOUDONE"], "expiresAt": "2026-08-13T01:42:21.536500Z", "token": "", "companyData": { "branchId": "", "countryCode": "BRA" }, "simulated": false }} ``` Поля процесса ПолеЗначение`id`UUID процесса; ключ, используемый для запроса и отслеживания потока.`flow`Тип выполненного сценария (например, `id_r2`, `idlivetrust_r2`, `idtrust_r2` и т. д.).`callbackUri`Callback URI, на который перенаправляется клиентское приложение в конце потока.`userRedirectUrl`Полный URL страницы CbU, которую пользователь открывает для выполнения сценария (содержит `id` и флаги поведения).`state`Состояние жизненного цикла процесса. Значения `PROCESS_STATE_*` (например, `CREATED`, `FAILED`, `FINISHED`, `AWAITING_FOR_DOCUMENT`, `UNSPECIFIED`).`result`Итоговый вердикт оценки. Значения `PROCESS_RESULT_*` (например, `APPROVED`, `AUTHENTICATED`, `NOT_APPROVED` и т. д.). Является окончательным только когда `state = PROCESS_STATE_FINISHED`.`createdAt`Метка времени создания процесса (UTC).`finishedAt`Метка времени завершения процесса (UTC).`person`Подобъект с данными проверяемого лица.`purpose`Цель процесса (например, `personAuthentication`, регистрация лица).`services`Список дополнительных сервисов, прикреплённых к процессу; пуст, если их нет.`authenticationInfo.​authenticationId`ID события аутентификации личности, сгенерированного потоком.`capacities`Использованные возможности/продукты. Значения `PROCESS_CAPACITY_*` (например, `IDCLOUDONE`).`expiresAt`Метка времени истечения процесса/ссылки (UTC).`token`Токен сессии/доступа, связанный с процессом (может быть пустым).`companyData`Подобъект с данными компании/тенанта, владеющего процессом.`simulated`Логическое значение; является ли этот процесс симуляцией/песочницей (`true`) или настоящим (`false`). Поля person ПолеЗначение`duiType`Тип уникального документа, удостоверяющего личность. Значения `DUI_TYPE_*` (например, `BR_CPF`).`duiValue`Значение документа (например, номер CPF).`friendlyName`Отображаемое имя/псевдоним человека (произвольный текст, не проверяется).`email`Email человека; может быть пустым.`phone`Номер телефона в формате E.164 (код страны + код региона + номер).`notifications`Список каналов уведомлений. Каждый элемент содержит `notificationChannel` со значениями `NOTIFICATION_CHANNEL_*` (например, `WHATSAPP`, `SMS`, `EMAIL`).`phoneCountryCodeAlpha3`Код страны ISO alpha-3 для номера телефона (например, `BRA`); может быть пустым. Поля данных компании ПолеЗначение`branchId`Идентификатор филиала тенанта; пуст, если сегментация по филиалам не используется.`countryCode`Страна компании в формате ISO alpha-3 (например, `BRA`). Типы документов и поля OCR Типы документов, использующие унифицированную схему — `unified_schema` в [справочнике полей](/ru/assets/files/document-content-fields-0e4663f2ade946e901bbc7523c21f032.json) — сообщаются как тип, определённый во время захвата, в верхнем регистре: `IDCARD`, `DRIVERLICENSE`, `PASSPORT` или `VOTERID`. Паспорта США сохраняют свой вариант вместо объединения в `PASSPORT`, поэтому также возвращаются значения `POLYCARBONATEPASSPORT`, `PASSPORTCARD` и `PAPERPASSPORT`. Например, `unico.moja.dictionary.ar.generic.v1.IdCard` и `unico.moja.dictionary.us.generic.v1.PolycarbonatePassport` сообщаются как `IDCARD` и `POLYCARBONATEPASSPORT`. `process.services[].documents[].doc.code` сообщает тип документа в виде короткого кода в верхнем регистре. `unico.moja.dictionary.br.cnh.v2.Cnh` становится `CNH`. Код не содержит ни страну, ни версию схемы; версия возвращается отдельно в `doc.version`. Специфичные схемы Типы документов, использующие собственную схему полей — перечисленные в `specific_document_schemas` в [справочнике полей](/ru/assets/files/document-content-fields-0e4663f2ade946e901bbc7523c21f032.json) — показаны в таблице ниже. Используйте dictionary type, чтобы найти каждую схему в этом файле. Страна`doc.code`Dictionary typeДокументBR`RG``unico.​moja.​dictionary.​br.​rg.​v2.​Rg`RGBR`CNH``unico.​moja.​dictionary.​br.​cnh.​v2.​Cnh`CNH (водительское удостоверение)BR`CIN``unico.​moja.​dictionary.​br.​cin.​v1.​Cin`CINBR`PASSAPORTE``unico.​moja.​dictionary.​br.​passaporte.​v1.​Passaporte`ПаспортMX`INE``unico.​moja.​dictionary.​mx.​ine.​v1.​Ine`Избирательное удостоверение INEMX`LPC``unico.​moja.​dictionary.​mx.​lpc.​v1.​Lpc`Licencia para conducir (водительское удостоверение)MX`PASAPORTE``unico.​moja.​dictionary.​mx.​pasaporte.​v1.​Pasaporte`Паспорт—`UNKNOWN``unico.​moja.​dictionary.​other.​unknown.​v1.​Unknown`Тип не удалось определить — `doc.data` пуст `PASSAPORTE` и `PASAPORTE` — разные документыБразильский паспорт — это `PASSAPORTE` (двойная S), а мексиканский — `PASAPORTE` (одна S), каждый отражает написание в своём словаре. Это не опечатка — не считайте эти два значения эквивалентными. Когда `doc.code` равен `UNKNOWN`, извлечение OCR не выполняется, и в `doc.data` не сообщается ни одно поле. Клиенты в Бразилии могут получать полную полезную нагрузку процессаОбщая структура ответа остаётся такой же — единый результат используется по умолчанию.Интеграции в Бразилии могут получать полный объект процесса, показанный ниже, с результатами по каждой возможности в authenticationInfo.``` { "process": { "id": "53060f52-f146-4c12-a234-5bb5031f6f5b", "flow": "iddocs_r2", "callbackUri": "https://example.com/callback", "userRedirectUrl": "https://example.com/redirect", "state": "PROCESS_STATE_FINISHED", "result": "PROCESS_RESULT_OK", "createdAt": "2024-01-01T10:00:00Z", "finishedAt": "2024-01-01T10:15:00Z", "expiresAt": "2024-01-08T10:00:00Z", "purpose": "VERIFICATION", "clientReference": "client-ref-abc", "useCase": "USE_CASE_LOGIN", "capacities": ["liveness", "face_match"], "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "person": { "duiType": "DUI_TYPE_BR_CPF", "duiValue": "12345678909", "friendlyName": "Luke Skywalker", "notifications": [ { "notificationChannel": "email" } ] }, "authenticationInfo": { "authenticationId": "auth-123", "livenessResult": "LIVENESS_RESULT_LIVE", "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE", "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED", "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED", "smartRevalidationResult": "SMART_REVALIDATION_RESULT_UNSPECIFIED", "idAgeResult": "ID_AGE_RESULT_UNSPECIFIED", "scoreEngineResult": { "scoreEnabled": "SCORE_ENABLED_TRUE", "score": 85.5 } }, "companyData": { "branchId": "branch-123", "countryCode": "BR" }, "bioTokenData": { "referenceProcessId": "ref-proc-123", "authenticationId": "auth-ref-123" }, "services": [ { "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47", "documentIds": ["doc-abc-123"], "consent_granted": true, "documents": [ { "doc_id": "doc-abc-123", "typified": true, "cpf_match": true, "face_match": true, "validate_doc": true, "reused_doc": false, "signed_url": "https://example.com/doc?token=xyz", "doc": { "version": 1, "code": "CNH", "data": { "numero": "044589731564", "cpfNumero": "12345678909", "nomeCivil": "Luke Skywalker", "dataNascimento": "1990-05-12T00:00:00Z", "dataExpiracao": "2027-12-07T00:00:00Z", "categoria": "B" } } } ] } ] }} ``` Поля верхнего уровняПолеТипОписание`process.id`string (UUID)Идентификатор процесса.`process.flow`stringИдентификатор потока, отправленный при создании.`process.callbackUri`stringCallback URL, настроенный для событий процесса.`process.​userRedirectUrl`stringURL для перенаправления пользователя после завершения сценария.`process.state`enumТекущее состояние процесса. См. значения ниже.`process.result`enumРезультат верификации. Присутствует только когда `state = PROCESS_STATE_FINISHED`.`process.createdAt`string (datetime)Метка времени ISO 8601, когда процесс был создан.`process.finishedAt`string (datetime)Метка времени ISO 8601, когда процесс завершился. Присутствует только когда `state = PROCESS_STATE_FINISHED`.`process.expiresAt`string (datetime)Метка времени ISO 8601, когда процесс истекает.`process.purpose`stringЦель процесса, настроенная в потоке.`process.​clientReference`stringОпциональная ссылка на стороне клиента для индексации в портале.`process.useCase`stringИдентификатор сценария, связанного с потоком.`process.capacities`array of stringsСписок возможностей, активированных в этом процессе.`process.token`stringПодписанный JWT для интеграции SDK.`process.person`objectИдентификационные данные, предоставленные при создании.`process.​person.​notifications`arrayКаналы уведомлений, настроенные для сценария (например, `email`).`process.​authenticationInfo`objectРезультаты по каждой возможности. См. ниже.`process.companyData`objectКонтекст компании и филиала.`process.​companyData.​branchId`stringИдентификатор филиала.`process.​companyData.​countryCode`stringКод страны ISO 3166-1 alpha-2.`process.​bioTokenData`objectИнформация о референсном процессе — присутствует только в потоках валидации 1:1 и умной ревалидации.`process.services`arrayПодписанные конверты, захваченные документы и другие результаты сервисов. См. ниже.Значения `process.state`ЗначениеОписание`PROCESS_STATE_CREATED`Процесс создан; пользователь ещё не завершил сценарий.`AWAITING_FOR_DOCUMENT`Процесс создан без документа, удостоверяющего личность. Присутствует только когда пользовательский поток (Custom Flow) допускает опциональный документ. Отправьте документ через [Передача документа процесса](/ru/developers/api-reference/set-process-document).`PROCESS_STATE_FINISHED`Сценарий завершён. Проверьте `result` и `authenticationInfo`.`PROCESS_STATE_FAILED`Ошибка обработки.Несогласованность в наименовании состояния`AWAITING_FOR_DOCUMENT` не соответствует соглашению о префиксе `PROCESS_STATE_*`, используемому для остальных состояний. Это известная несогласованность в наименовании в текущем API.Значения `process.result`ЗначениеОписание`PROCESS_RESULT_OK`Все возможности вернули положительный результат.`PROCESS_RESULT_INVALID_IDENTITY`Как минимум одна возможность вернула однозначно отрицательный результат (например, проверка живости не пройдена, личность не подтверждена).`PROCESS_RESULT_ERROR`Ошибка при обработке результата.`PROCESS_RESULT_EXPIRED`Процесс истёк до завершения сценария.`PROCESS_RESULT_UNSPECIFIED`Процесс ещё не завершён.Результаты возможностей в authenticationInfoВсе поля всегда возвращаются независимо от потока. Поля для возможностей, не используемых в потоке, возвращают `*_UNSPECIFIED`.Сокращённые значения перечисленийСокращённые значения (например, `livenessResult = LIVE`, `authenticationResult = INCONCLUSIVE`) напрямую соответствуют полным значениям перечислений, документированным здесь (`LIVENESS_RESULT_LIVE`, `AUTHENTICATION_RESULT_INCONCLUSIVE` и т. д.) — префикс опущен для краткости.ПолеВозможностьВозможные значения`authenticationId`—Уникальный идентификатор этой попытки аутентификации.`livenessResult`[Проверка живости](/ru/capabilities/liveness)`LIVENESS_RESULT_LIVE`, `LIVENESS_RESULT_NOT_LIVE`, `LIVENESS_RESULT_UNSPECIFIED``authenticationResult`[Проверка личности](/ru/capabilities/identity-verification)`AUTHENTICATION_RESULT_POSITIVE`, `AUTHENTICATION_RESULT_NEGATIVE`, `AUTHENTICATION_RESULT_INCONCLUSIVE`, `AUTHENTICATION_RESULT_UNSPECIFIED``identityFraudstersResult`[Классификация рисков мошенничества](/ru/capabilities/fraud-risk-classification)`TRUST_RESULT_YES`, `TRUST_RESULT_INCONCLUSIVE`, `TRUST_RESULT_UNSPECIFIED``bioTokenEngineResult`[Валидация 1:1](/ru/capabilities/1-1-validation)`BIO_TOKEN_ENGINE_RESULT_POSITIVE`, `BIO_TOKEN_ENGINE_RESULT_NEGATIVE`, `BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED``smartRevalidationResult`[Умная ревалидация](/ru/capabilities/smart-revalidation)`SMART_REVALIDATION_RESULT_POSITIVE`, `SMART_REVALIDATION_RESULT_NEGATIVE`, `SMART_REVALIDATION_RESULT_UNSPECIFIED``idAgeResult`[Проверка возраста](/ru/capabilities/age-verification)`ID_AGE_RESULT_POSITIVE`, `ID_AGE_RESULT_NEGATIVE`, `ID_AGE_RESULT_INCONCLUSIVE`, `ID_AGE_RESULT_UNSPECIFIED``scoreEngineResult.​scoreEnabled`[Риск-скор](/ru/capabilities/risk-score)`SCORE_ENABLED_TRUE`, `SCORE_ENABLED_FALSE`, `SCORE_ENABLED_UNSPECIFIED``scoreEngineResult.​score`[Риск-скор](/ru/capabilities/risk-score)Число от -100 до +100. Присутствует, когда `authenticationResult = AUTHENTICATION_RESULT_INCONCLUSIVE` и включён «Риск-скор».`serproResult.score`[Сходство Serpro](/ru/capabilities/serpro-similarity-return)`0`–`100` (сходство); `-1` (нет фото лица в базе для этого CPF); `-2` (ошибка интеграции).Поля `process.services`Смешанные соглашения об именовании в `services`Массив `services` использует camelCase для полей уровня конверта (`envelopeId`, `documentIds`) и snake_case для полей уровня документа (`doc_id`, `consent_granted`, `face_match` и т. д.). Это отражает фактический ответ API — оба соглашения являются намеренными, а не ошибкой документации.ПолеТипОписание`envelopeId`string (UUID)Идентификатор подписанного конверта.`documentIds`array of stringsID захваченных документов в этом сервисе.`consent_granted`booleanДал ли пользователь согласие на передачу данных.`documents`arrayЗахваченные документы с данными OCR и результатами валидации.`documents[].doc_id`stringИдентификатор документа.`documents[].​typified`booleanБыл ли тип документа успешно определён.`documents[].​cpf_match`booleanСовпадает ли CPF в документе с предоставленным CPF (только Бразилия).`documents[].​face_match`booleanСовпадает ли селфи с фотографией в документе.`documents[].​validate_doc`booleanПрошёл ли документ проверку подлинности.`documents[].​reused_doc`booleanБыл ли этот документ повторно использован из предыдущего процесса.`documents[].​signed_url`stringПредварительно подписанный URL для скачивания PDF документа (действителен 5 минут — запросите заново для продления).`documents[].​doc.​version`integerВерсия схемы OCR.`documents[].​doc.​code`stringКороткий код типа документа (например, `CNH`). Все значения и способ формирования кода см. в разделе [Типы документов и поля OCR](#document-type-values).`documents[].​doc.​data`objectИзвлечённые поля OCR. Содержимое зависит от типа документа — полный каталог см. в [полном справочнике полей](/ru/assets/files/document-content-fields-0e4663f2ade946e901bbc7523c21f032.json). Названия полей внутри `doc.data` (например, `nomeCivil`, `dataNascimento`) возвращаются на португальском языке — это фактические значения, формируемые движком OCR. ### Коды ошибок​ 400 Bad Request401 Unauthorized404 Not Found429 Too Many Requests500 Internal Server ErrorКодСообщениеОписание`3`process id is invalidКогда ID процесса недействителен.КодСообщениеОписание—Jwt header is an invalid JSONКогда использованный токен доступа содержит некорректные символы.—Jwt is expiredКогда использованный токен доступа истёк.КодСообщениеОписание`5`error getting process: rpc error: code = NotFound desc = process not foundКогда ID процесса не был найден.Достигнут лимит запросов. Когда ваша система получает ошибку HTTP 429, необходимо реализовать механизмы для предотвращения каскадных сбоев и избежания усугубления ограничения. **Лучшие практики:** **Период ожидания (backoff):** Немедленно остановите или снизьте частоту последующих запросов из вашей системы. Не повторяйте неудачные запросы непрерывно в тесном цикле. **Очередь и ограничение (Queueing & throttling):** Буферизируйте или ставьте в очередь исходящие запросы на вашей стороне для контроля потока трафика перед их повторной отправкой. **Экспоненциальный backoff с джиттером:** При повторных попытках увеличивайте время ожидания экспоненциально между попытками (например, 1 с, 2 с, 4 с, 8 с) и добавляйте небольшую случайную задержку ("джиттер"), чтобы предотвратить эффект стада, когда все запросы из очереди повторяются в одну и ту же миллисекунду. предупреждениеНепрерывная отправка запросов к эндпоинту с ограничением частоты без применения backoff может **продлить период ограничения** и серьезно снизить операционную пропускную способность вашей системы. Правильное ограничение запросов на вашей стороне обеспечивает более плавную и устойчивую интеграцию. Информацию о лимитах по умолчанию, увеличении запросов и дополнительные сведения см. в разделе [Лимиты запросов](/ru/developers/start/rate-limits).КодСообщениеОписание`99999`Internal failure! Try again laterКогда произошла внутренняя ошибка. ### Опрос или вебхук​ Вы можете опрашивать этот эндпоинт для проверки прогресса, но рекомендуемый паттерн — **подписаться на вебхук** и вызывать этот эндпоинт только как резервный вариант. См. [Вебхуки и события](/ru/developers/webhooks-and-events). ### Что дальше​ Для захваченного селфи см. [Получение селфи](/ru/developers/api-reference/get-selfie). Для набора доказательств для аудита см. [Получение набора доказательств](/ru/developers/api-reference/get-evidence-set). Последнее обновление 8 окт. 2026 г.**