Загрузить скан-копию паспорта

Внимание

Новые ключи временно не выпускаются в связи с обновлением продукта.

Загружает скан-копию паспорта подписанта в сервис Яндекс ОФД.

Требования к загружаемому файлу:

  • Формат: jpeg, jpg, png, pdf, tif.
  • Размер: до 5 Мб.

Формат запроса

POST https://api.ofd.yandex.net/{v1}/applications/sign_regs/{sign_reg_id}/documents/passport
  • v1
    Номер версии API ОФД.
  • sign_reg_id
    Идентификатор заявки на создание КСКПЭП.

Заголовок запроса

Заголовки запроса должны содержать ключи (см. раздел Доступ к API):

Заголовок Описание
X-Yandex-Key <аутентификационный ключ>
X-OFD-Key <авторизационный ключ>
Content-Type multipart/form-data

Тело запроса

Укажите в теле запроса путь к загружаемому файлу.

Формат ответа

Если запрос выполнен успешно, сервер возвращает HTTP-статус выполнения операции «201 CREATED».

В случае возникновения ошибок при обработке запроса ответ сервера содержит код и описание ошибки.

Коды ответа

Список кодов, которые поддерживаются в API ОФД см. в разделе Коды ответов и ошибки.

Пример запроса

Метод и адрес:

POST https://api.ofd.yandex.net/v1/applications/sign_regs/359/documents/passport

Заголовки:

x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Content-Type: multipart/form-data
Пример запроса в формате cURL
curl -X POST \
  https://api.ofd.yandex.net/v1/applications/sign_regs/359/documents/passport \
  -H 'Content-Type: application/json' \
  -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca' \
  -F 'file=@C:\Work\ofd\359passport.jpg'