Разработчикам

POST/v3/create_proof

Прикрепление подтверждения личности или адреса

Свяжите загруженные файлы подтверждения с нужной записью о личности или адресе.

На этой странице
  1. Прикрепление подтверждения личности или адреса
  2. Создание подтверждения
  3. Сохраните идентификатор подтверждения
  4. Ошибки и загруженные файлы с истёкшим сроком действия

Прикрепление подтверждения личности или адреса

Выполните этот шаг после создания записи о личности или адресе и загрузки необходимых для неё файлов через create_encrypt_files с выбранным типом подтверждения. Используйте актуальный идентификатор из get_proof_types, соответствующий требованию и категории сущности.

Сохраните identity_id и address_id из create_document; UUID профиля — другой идентификатор. Совместимость последующего прикрепления подтверждения адреса с недавно созданными профилями всё ещё проверяется. Если адрес отклонён, проверьте информацию в портале или обратитесь в службу поддержки, прежде чем повторять попытку.

Создание подтверждения

Используйте активированную учётную запись API MultiTEL и разрешённый для неё IP-адрес. В примерах используются учётные данные для аутентификации HTTP Basic из переменных окружения; соблюдайте правила аутентификации для вашего типа учётной записи. Отправляйте запросы по HTTPS. Проверяйте как ответ HTTP, так и поле в JSON status.code; ошибки приложения могут приходить с кодом HTTP 200. Примеры ниже вымышлены.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @proof-request.json \
  https://api.multitel.net/v3/create_proof
{
  "entity_type": "identities",
  "entity_id": "33333333333333333333333333333333",
  "proof_type_id": "11111111111111111111111111111111",
  "encrypted_file_ids": [
    "22222222222222222222222222222222"
  ]
}
Поля запроса
ПолеЗначение
entity_typeИспользуйте identities или addresses. Выберите категорию, соответствующую как целевой записи, так и загруженным файлам.
entity_idИдентификатор записи о личности или адресе, принадлежащей вашей учётной записи. Используйте идентификатор, полученный в процессе работы с документами; не подставляйте вместо него номер телефона или идентификатор постороннего документа.
proof_type_idИдентификатор выбранного типа подтверждения. Он должен соответствовать типу, указанному при загрузке, и требованию.
encrypted_file_idsНепустой массив JSON с идентификаторами файлов, возвращёнными create_encrypt_files. Файлы должны принадлежать той же учётной записи, иметь неистёкший срок действия и соответствовать категории сущности. Это не список путей к локальным файлам.

Также принимаются данные формы с повторяющимися encrypted_file_ids[] полями. Предпочтительно использовать настоящий массив JSON или массив полей формы; не отправляйте массив, закодированный в JSON, как обычное скалярное значение поля формы.

Сохраните идентификатор подтверждения

{
  "status": {
    "code": 200,
    "msg": "Proof created successfully."
  },
  "response": {
    "id": "44444444444444444444444444444444",
    "entity_type": "identities",
    "entity_id": "33333333333333333333333333333333",
    "proof_type_id": "11111111111111111111111111111111",
    "proof_type_name": "Example identity proof"
  }
}

Успешный ответ подтверждает создание связи с подтверждающими файлами. Он не подтверждает одобрение личности или адреса, проверку выполнения всех требований страны или активацию телефонного номера.

Ошибки и загруженные файлы с истёкшим сроком действия

Код API 500 используется при отсутствии обязательных входных данных, сбоях оператора связи и некорректном ответе оператора связи. Код 404 используется, если целевая запись не связана с текущей учётной записью, тип подтверждения недопустим, загруженный файл не найден для этой учётной записи и категории либо срок его действия истёк, или не осталось пригодных для использования идентификаторов файлов. Читайте status.msg вместе с кодом.

Перед прикреплением повторно загрузите обязательный файл с истёкшим сроком действия, указав правильную категорию подтверждения. Если хотя бы один из переданных файлов недопустим, этот обработчик останавливается до отправки запроса на создание подтверждения. Ключ идемпотентности не предоставляется: после истечения времени ожидания проверьте существующий документ в портале, прежде чем повторять прикрепление.