Установить документ процесса

Устанавливает идентификационный документ (CPF, CURP, SSN или другой duiType) для процесса, созданного без него. После установки документ становится неизменным.

Доступно только для процессов, Custom Flow которых допускает создание без документа — то есть для процессов в состоянии AWAITING_FOR_DOCUMENT.

Endpoint

Окружение	URL
Production	POST https://api.idcloud.unico.app/client/v1/process/{processId}/document
Sandbox	POST https://api.idcloud.uat.unico.app/client/v1/process/{processId}/document

Запрос

Заголовки

Заголовок	Значение
Authorization	Bearer <access_token> (см. Authentication)
Content-Type	application/json

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

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

Параметры тела запроса

Поле	Тип	Обязательное	Описание
duiType	enum	да	Тип документа. Значения: DUI_TYPE_BR_CPF, DUI_TYPE_MX_CURP, DUI_TYPE_US_SSN. Этот endpoint поддерживает подмножество типов документов, принимаемых в Create Process — Custom Flow, допускающие создание с необязательным документом, в настоящее время проверяются по этому сокращённому списку.
duiValue	string	да	Номер документа без форматирования. Максимум 320 символов (вмещает закодированные или составные идентификаторы; стандартные номера документов, такие как CPF или CURP, значительно короче).

Пример

cURL

curl -X POST https://api.idcloud.unico.app/client/v1/process/abc-123/document \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "duiType": "DUI_TYPE_BR_CPF",
    "duiValue": "12345678901"
  }'

Node.js

import fetch from 'node-fetch';

const res = await fetch(
  'https://api.idcloud.unico.app/client/v1/process/abc-123/document',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${process.env.UNICO_ACCESS_TOKEN}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      duiType: 'DUI_TYPE_BR_CPF',
      duiValue: '12345678901',
    }),
  }
);

const { process: proc } = await res.json();
// proc.id, proc.person.duiType, proc.person.duiValue

Ответы

200 OK

{
  "process": {
    "id": "abc-123",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "12345678901"
    }
  }
}

Поле	Тип	Описание
process.id	string	Идентификатор процесса.
process.person.duiType	string	Тип документа, установленный для процесса.
process.person.duiValue	string	Значение документа, установленное для процесса.

400 Bad Request

Возвращается, когда тело запроса некорректно, обязательные поля отсутствуют или состояние процесса не допускает выполнение операции.

401 Unauthorized

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

404 Not Found

Процесс не найден.

429 Too Many Requests

Достигнут лимит запросов. Подробный код ошибки не предоставляется — только HTTP-статус.

Коды ошибок

400 Bad Request

Код	Сообщение	Описание
3	process id is invalid	Когда идентификатор процесса недействителен.
3	dui_type is required	Когда тип документа не указан.
3	dui_value is required	Когда номер документа не указан.
3	dui_value exceeds maximum length	Когда номер документа превышает максимально допустимое количество символов.
9	process is not awaiting for document	Когда указанный процесс не принимает отправку документа.
9	process expired	Когда указанный процесс истёк.
9	document already set, cannot be modified	Когда процесс уже содержит привязанный документ.
9	process already finished	Когда процесс уже завершён.
9	flow does not allow optional document	Когда документ является обязательным для потока, выполняемого процессом.

401 Unauthorized

Сообщение	Описание
Jwt header is an invalid JSON	Когда использованный токен доступа содержит некорректные символы.
Jwt is expired	Когда использованный токен доступа истёк.

404 Not Found

Код	Сообщение	Описание
5	error getting process: rpc error: code = NotFound desc = process not found	Когда идентификатор процесса не найден.

429 Too Many Requests

Для этого статуса подробный код ошибки не предоставляется — только HTTP-статус.

500 Internal Server Error

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

Что дальше

• После установки документа процесс продолжает свой пайплайн. Вызовите Get Process для получения результата или дождитесь webhook.