Перейти к содержанию

Регистрация

Предпроверка

Перед созданием заявки можно проверить, создавалась ли уже такая заявка ранее по параметрам:
phone, email, snils, inn - пользователь;
cinn, cogrn, ckpp (только вместе с cinn или cogrn) - компания.
Мы рекомендуем отправлять как один запрос сразу со всем набором данных, так и несколько запросов с каждым типом данных.

URL https://server_name/register/precheck

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • api_key = полученный ключ доступа
    • phone = номер телефона
    • snils = снилс
    • email = электронная почта
    • inn = ИНН
    • cinn = ИНН компании или ИП
    • cogrn = ОГРН
    • ckpp = КПП

Response

  • Success
    • Content-type application/json
    • Body JSON array of
      • phone | snils | email | inn | cinn | cogrn
        • id = номер заявки нового пользователя или компании (возвращает АПИ регистрации)
        • approved = прошел идентификацию или нет (УСТАРЕЛ)
        • created = активировался или нет (пользователь создал ли пароль, активирован ли кабинет компании)
        • active_at = дата и время последней активности устройства
        • rejected = отклонена ли анкета
        • reject_comment = причина отказа
        • keys = array of ключи ЭП
          • id = идентификатор ключа
          • mobile = есть ли мобильный ключ или нет
          • esia = выпущен с помощью ГосУслуг или нет
          • alg = алгоритм
          • qualified = квалифицированный или нет
          • link = файл заявления с сертификатом этого ключа
          • org_id = ид компании, если ключ на компанию
          • expired_at = дата и время окончания действия ключа
        • requests = array of заявки на выпуск ключей подписи
          • id = внутренний номер заявки на выпуск ключа
          • num = номер заявки в УЦ
          • mobile
            • true - есть выпущенный ключ с заявкой в мобиле
            • false - нет (втч серверный)
          • error = сообщение об ошибке при выпуске сертификата (может быть пустой строкой)
          • ca = имя УЦ заявки
          • apprtype = 0 не подтвержден, 1 подтвержден удаленно, 2 подтвержден лично
        • auths = array of заявления на аутентификацию (только для пользователя)
          • id = внутренний номер заявления
          • num = номер заявки в УЦ
          • pdf = base64 заявления на аутентификацию
          • error = сообщение об ошибке при выпуске сертификата (может быть пустой строкой)
          • active_at = дата и время последней активности устройства
          • apprtype = как прошел идентификацию (только для пользователя)
            • 1 дистанционно (для НКЭП или если отвязал устройство)
            • 2 лично (для УКЭП)
            • 0 не прошел
        • auth_keys = array of ключи аутентификации (безопасности)
          • gak_id = id из auths
          • qualified = квалифицированный или нет
          • expired_at = дата и время окончания действия ключа аутентификации
        • mine = принадлежит пользователь вашему ключу или нет
        • apprtype = как прошел идентификацию (только для пользователя) (УСТАРЕЛ)
          • 1 дистанционно (для НКЭП или если отвязал устройство)
          • 2 лично (для УКЭП)
          • 0 не прошел
        • smev = array of (только для пользователя)
          • snils | inn | passport
          • status
            • SUCCESS — прошел проверку в СМЭВ (или отключено)
            • NOT_REGISTERED — не запрашивался в СМЭВ
            • IN_PROGRESS — проверяется в СМЭВ
            • NOT_FOUND — не найден в СМЭВ
            • REJECT — проверка не пройдена по данным
            • FAILED — проверка не пройдена по внутренней ошибке 500 в СМЭВ
          • details - описание
          • date - дата проверки
        • blacklist = true если компания заблокирована (опционально для компаний)
      • fullhouse = если одновременно нашли активные ключи по ФЛ и ИП/ЮЛ

Первичная регистрация ФЛ

URL https://server_name/register/api

Request

  • Method POST
  • Content-type application/json
  • Body JSON

    • api_key = полученный ключ доступа
    • name = Имя //только русские буквы в этих 3 полях
    • surname = Фамилия
    • lastname = Отчество
    • bdate = Дата рождения (yyyy-mm-dd)
    • citizenship = Гражданство (код страны)
      • ru по умолчанию
      • by итд
    • gender = Пол
      • M = мужской
      • F = женский
    • snils = СНИЛС, без дефисов и пробелов, только цифры
    • inn = ИНН
    • ps = серия паспорта (Если не передаем гражданство или передаем ru, то серия обязательна. Если передаем гражданство иностранца, то необязательна)
    • pn = номер паспорта (Для иностранцев пишем с буквами сюда слитно)
    • pdate = дата получения паспорта (yyyy-mm-dd)
    • issued = кем выдан паспорт
    • pcode = код подразделения - три цифры дефис три цифры
    • country = Код страны
      • ru по умолчанию
    • region = Название региона (обязательно, для Москвы - Москва, полностью, вместе с типом региона, например Ленинградская Область)
    • city = Город или населенный пункт
    • street = улица
    • house = дом
    • building = корпуc
    • room = квартира
    • phone = телефон человека в формате +79123456789 (смс можем отправлять только на номера РФ)
    • email = email

    • regtype = one of

      • 1 - если возвращать ошибку (когда данные уже есть в системе) по умолчанию
      • 2 - если возвращать id уже существующей заявки с таким же телефоном, СНИЛС, ИНН, емейлом
      • 3 - если редактировать данные (работает только на своих заявках и до активации пользователя)
    • Если нужна выездная идентификация, в тело добавляются параметры для доставки:
    • delivery = 1 если заказывать доставку курьером
    • delivery_comment = комментарий для службы доставки
    • deliverytype = 2 (Финдоставка) если нужно указать фиксированную службу, иначе не добавлять ключ
    • extra_documents = массив дополнительных документов на доставку
      • name = имя файла
      • content = base64(содержимое)
    • postregion = регион доставки сертификата, если не указан - будет взят region, для достоверной работы доставки желательно дублировать при совпадении, но подавать только название, например Иркутская или Ямало-Ненецкий
    • postcity = город доставки сертификата, если не указан - будет взят city
    • postaddr = адрес доставки в строчку, наиболее подробно
    • Если пользователь будет проходить идентификацию в офисе самого УЦ или другой компании:
    • verified_by = идентификатор компании из метода https://server_name/register/verifiers/ , которая будет проводить идентификацию клиента
    • Если нужно передать нам уникальный ID сотрудника внутри вашей системы:
    • external = ваш внутрисистемный ид
    • Если необходимо выпустить мобильный ключ:
    • mobile = 1
    • Если не нужно отправлять пользователю емейл о регистрации его данных:
    • noemail = 1
    • Если подпись сертификата будет осуществляться сторонними средствами:
    • external_ident = 1

Response

  • Success

    • Content-type application/json
    • Body JSON
      • id = id заявки
      • qr = если создана заявка на мобильное устройство
      • pdf = base64 pdf файл на созданного пользователя
      • cid = id компании, если создавалась
  • Error

    • Content-type application/json
    • Body
      • error 0: wrong method необходимо использовать POST запрос
      • error 1: wrong json неправильный формат пакета (чаще всего структурная ошибка)
      • error 2: wrong key неправильный ключ доступа (чаще всего путаница в боевой и тестовой среде - разные ключи доступа)
      • error 3: wrong data неизвестная ошибка в данных, заявка не создалась. Сообщите по контактам Sign.Me
      • error 3: wrong data on key “k”: “e” ошибка данных типа e в ключе k (чаще всего неправильный формат или недопустимые символы. Для доставки может быть not exists - в данный город нет доставки, либо cant - доставка для ключа не включена)
      • error 3: Can not use external ident at this certificate type нельзя использовать external_ident с НКЭП
      • error 4: key not created не создался сертификат, проблема на нашей стороне, свяжитесь с Sign.Me
      • error 5: ca error \d ошибка на стороне УЦ
        • 1 - Для данного типа сертификата не задан УЦ, обратитесь в техподдержку
        • 2 - УЦ отключен, обратитесь в техподдержку
        • 3 - УЦ КЭП, а тип сертификата НКЭП, или наоборот, измените подаваемые параметры
        • 4 - Нельзя создать КЭП серверный ключ, измените подаваемые параметры
        • 5 - Неправильный алгоритм для УЦ, обратитесь в техподдержку
        • 6 - В этом УЦ нельзя выпускать ЕСИА, или наоборот, измените подаваемые параметры
        • 7 - УЦ не может выпускать такой тип сертификата, обратитесь в техподдержку
        • 8 - Для этого УЦ нет связи с api_key, обратитесь в техподдержку
        • 9 - Ошибка на стороне УЦ, текст в строке
      • error 6: forbidden to change data

Первичная регистрация ФЛ+ИП/ЮЛ

URL https://server_name/register/api

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • key = полученный ключ доступа
    • mobile = 1 //если выпускать мобильный ключ, не обязательно
    • external_ident = 1 //если подпись сертификата фл будет сторонними средствами
    • name = Имя //только русские буквы в этих 3 полях
    • surname = Фамилия,
    • lastname' = 'Отчество'
    • bdate = Дата рождения (YYYY-mm-dd)
    • citizenship = Гражданство (код страны)
      • ru по умолчанию
      • by итд
    • gender = Пол
      • M = мужской
      • F = женский
    • snils = СНИЛС, без дефисов и пробелов, только цифры
    • inn = ИНН
    • ps = серия паспорта (Если не передаем гражданство или передаем ru, то серия обязательна. Если передаем гражданство иностранца, то необязательна)
    • pn = номер паспорта (Для иностранцев пишем с буквами сюда слитно)
    • pdate = дата получения паспорта (YYYY-mm-dd)
    • issued = кем выдан паспорт
    • pcode = код подразделения, три цифры дефис три цифры
    • country = Код страны
      • ru по умолчанию
    • region = Название региона (обязательно, для Москвы - Москва, полностью, вместе с типом региона, например Ленинградская Область)
    • city = Город или населенный пункт
    • street = улица
    • house = дом
    • building = корпуc
    • room = квартира
    • postregion = регион доставки сертификата, если не указан - будет взят region, для достоверной работы доставки желательно дублировать при совпадении, но подавать только название, например Иркутская или Ямало-Ненецкий
    • postcity = город доставки сертификата, если не указан - будет взят city
    • postaddr = адрес доставки в строчку, наиболее подробно
    • phone = телефон человека, в формате +79914512345
    • email = email
    • delivery = 1 если заказывать доставку курьером
    • verified_by = идентификатор компании из метода https://server_name/register/verifiers/ , которая будет проводить идентификацию клиента
    • delivery_comment = комментарий для службы доставки
    • deliverytype = 2 (Финдоставка) или 4 (Fexpress) если нужно фиксированную службу, иначе не добавлять ключ
    • external = ваш внутрисистемный ид
    • regtype = one of
      • 1 - если возвращать ошибку по умолчанию
      • 2 - если возвращать id уже существующей заявки с таким же телефоном или СНИЛС
      • 3 - если перезаписывать данные,
    • noemail = 1 если не посылать email при регистрации, иначе не добавлять ключ
    • esia = 1 Идентификация пользователя через ГосУслуги
    • company = 1,
    • cname = сокращенное наименование (ООО ...)
    • cfullname = полное наименование (Общ с огрн отв ...)
    • ceo_surname = фамилия директора (может не совпадать с пользователем)
    • ceo_name = имя директора
    • ceo_lastname = отчество директора
    • ccountry = ru|by
    • ccity = город
    • cregion = необходимо подавать для того, чтобы поле S сертификата содержало код региона, подавать название, например Иркутская или Ямало-Ненецкий, без обл.
    • caddr = юр адрес
    • cfaddr = фактический адрес. если не передавать, то будет взят юр адрес
    • cinn = ИНН
    • cogrn = ОГРН
    • ckpp = КПП
    • ckey = 1 если создавать ключ на компанию сразу и шифровать тем же паролем, что и ключ пользователя, иначе создается при активации. С mobile:1 не актуально
    • cbank = название банка
    • cbik = БИК
    • crass = Расс счет
    • ckorr = Корр счет
    • cexternal= ваш внутрисистемный ид компании
    • cjob = должность, не обязательно, но тогда будет гендир или доверенное лицо

Response

  • Success

    • Content-type application/json
    • Body JSON
      • id = id заявки
      • qr = если создана заявка на мобильное устройство
      • pdf = base64 pdf файл на созданного пользователя
      • cid = id компании, если создавалась
  • Error

    • Content-type application/json
    • Body
      • error 0: wrong method необходимо использовать POST запрос
      • error 1: wrong json неправильный формат пакета (чаще всего структурная ошибка)
      • error 2: wrong key неправильный ключ доступа (чаще всего путаница в боевой и тестовой среде - разные ключи доступа)
      • error 3: wrong data неизвестная ошибка в данных, заявка не создалась. Сообщите по контактам
      • error 3: wrong data on key “k”: “e” ошибка данных типа e в ключе k (чаще всего неправильный формат или недопустимые символы, для доставки может быть not exists - в данный город нет доставки)
      • error 4: key not created не создался сертификат, проблема на нашей стороне, свяжитесь с нами
      • error 5: ca error \d ошибка на стороне УЦ
        • 1 - Для данного типа сертификата не задан УЦ, обратитесь в техподдержку
        • 2 - УЦ отключен, обратитесь в техподдержку
        • 3 - УЦ КЭП, а тип сертификата НКЭП, или наоборот, измените подаваемые параметры
        • 4 - Нельзя создать КЭП серверный ключ, измените подаваемые параметры
        • 5 - Неправильный алгоритм для УЦ, обратитесь в техподдержку
        • 6 - В этом УЦ нельзя выпускать ЕСИА, или наоборот, измените подаваемые параметры
        • 7 - УЦ не может выпускать такой тип сертификата, обратитесь в техподдержку
        • 8 - Для этого УЦ нет связи с api_key, обратитесь в техподдержку
        • 9 - Ошибка на стороне УЦ, текст в строке

Добавление ИП/компании к ранее созданному пользователю

URL https://server_name/register/api

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • newid = номер заявки нового пользователя, который возвращает метод «Предпроверка»
    • company = 1
    • cname = название
    • cfullname = полное наименование
    • ceo_surname = фамилия директора (может не совпадать с пользователем)
    • ceo_name = имя директора
    • ceo_lastname = отчество директора
    • ccountry = ru|by
    • ccity = город
    • cregion = регион //необходимо подавать для того, чтобы поле S сертификата содержало код региона, подавать название, например Иркутская или Ямало-Ненецкий, без обл., доступная таблица в конце
    • caddr = юр адрес
    • cfaddr = фактический адрес, если нет, то будет юр адрес
    • cinn = ИНН
    • cogrn = ОГРН
    • ckpp = КПП
    • ckey = 1 если создавать ключ на компанию сразу и шифровать тем же паролем, что и ключ пользователя, иначе создается при активации
    • cbank = название банка
    • cbik = БИК
    • crass = Расс счет
    • ckorr = Корр счет
    • cexternal = 1-0a-z ваш внутрисистемный ид компании
    • cjob = Генеральный директор должность, не обязательно, но тогда будет гендир или доверенное лицо

Response

  • Success

    • Content-type application/json
    • Body JSON
      • id = id заявки
      • qr = если создана заявка на мобильное устройство
      • pdf = base64 pdf файл на созданного пользователя
      • cid = id компании, если создавалась
  • Error

    • Content-type application/json
    • Body
      • error 0: wrong method необходимо использовать POST запрос
      • error 1: wrong json неправильный формат пакета (чаще всего структурная ошибка)
      • error 2: wrong key неправильный ключ доступа (чаще всего путаница в боевой и тестовой среде - разные ключи доступа)
      • error 3: wrong data неизвестная ошибка в данных, заявка не создалась. Сообщите по контактам
      • error 3: wrong data on key “k”: “e” ошибка данных типа e в ключе k (чаще всего неправильный формат или недопустимые символы, для доставки может быть not exists - в данный город нет доставки)
      • error 4: key not created не создался сертификат, проблема на нашей стороне, свяжитесь с нами
      • error 5: ca error \d ошибка на стороне УЦ
        • 1 - Для данного типа сертификата не задан УЦ, обратитесь в техподдержку
        • 2 - УЦ отключен, обратитесь в техподдержку
        • 3 - УЦ КЭП, а тип сертификата НКЭП, или наоборот, измените подаваемые параметры
        • 4 - Нельзя создать КЭП серверный ключ, измените подаваемые параметры
        • 5 - Неправильный алгоритм для УЦ, обратитесь в техподдержку
        • 6 - В этом УЦ нельзя выпускать ЕСИА, или наоборот, измените подаваемые параметры
        • 7 - УЦ не может выпускать такой тип сертификата, обратитесь в техподдержку
        • 8 - Для этого УЦ нет связи с api_key, обратитесь в техподдержку
        • 9 - Ошибка на стороне УЦ, текст в строке

Подтверждение

После создания заявки, ее можно подтвердить (позволить пользователю завершить активацию, равносильно проверке модератором, или, если оговорена быстрая активация, активировать сразу. Это смогут делать только те апи-ключи, которым мы доверяем, и только в проектах с НКЭП)

Можно активировать только те заявки, которые созданы этим же ключом доступа
Пользователю будут высланы данные для активации аккаунта/компании по смс, а если ключ мобильный - PUSH-уведомление и уведомление по почте.

Подтверждение ФЛ

URL https://server_name/register/activate

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • api_key = полученный ключ доступа
    • uid = id заявки
    • noemail = true — посылать флаг только в случае, если не нужно отправлять email с инструкциями

Response

  • Success
    • Content-type text/html
    • Body HTML
      • 1 - успех
  • Error
    • Content-type text/html
    • Body HTML
      • 0 - ошибка, засеките точное время и сообщите нам

Подтверждение ЮЛ

URL https://server_name/register/comactivate

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • api_key = полученный ключ доступа
    • cid = id заявки
    • noemail = true — посылать флаг только в случае, если не нужно отправлять email с инструкциями

Response

  • Success
    • Content-type text/html
    • Body HTML
      • OK - компания уже активирована
      • 1234 - ID созданной компании(успех), или https://server_name/sysutils/comactivate/1234 - урл для перехода, куда пользователь должен ввести данные для активации. С мобильными ключами неактуально - переходить по урл не нужно
  • Error
    • Content-type text/html
    • Body HTML
      • 0 - ошибка, засеките точное время и свяжитесь с нами

Проверка возможности доставки по адресу

URL https://server_name/register/checkdelivery

Request

  • Method POST
  • Content-type: appplication/json
  • Body JSON
    • kladr = кладр адреса доставки

Response

  • Success
    • Content-type text/html
    • Body HTML
      • "1"
  • Error
    • Content-type text/html
    • Body HTML
      • "0"

Заказ доставки

Заказать доставку с актуальным заявлением если ранее она не создавалась или завершена с любым результатом

URL https://server_name/register/orderdelivery

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • api_key = полученный ключ доступа
    • uid = ид заявки
    • delivery_address = новый адрес, опционально
    • delivery_comment = комментарий, опционально

Response

  • Success
    • HTTP status
      • 200 - успех
  • Error
    • HTTP status
      • 404 — нет такого пользователя или апи ключа
      • 403 — доставка не была заказана (для уточнения причины обратитесь в техподдержку с точным временем и датой попытки заказа)

Отмена доставки

Если у пользователя была заказана доставка, и пользователь регистрировался с этого ключа, то можно отменить доставку (Работает пока что только с Финдоставкой).

URL https://server_name/register/canceldelivery

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • api_key = полученный ключ доступа
    • uid = ид заявки

Response

  • Success
    • HTTP status
      • 200 - успех
  • Error
    • HTTP status
      • 404 — нет такого пользователя или апи ключа
      • 403 — пользователь регистрировался с другого апи ключа или доставка не была заказана

Расширенная информация о пользователе (Статусы доставки и сканы документов)

Создатель заявки может просмотреть информацию о зарегистрированном собой пользователе.

URL https://server_name/register/userinfo

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • key = полученный ключ доступа
    • phone = телефон пользователя +79123456789 или
    • id = ид заявки или
    • snils = СНИЛС пользователя

Response

  • Success
    • Content-type application/json
    • Body JSON
      • id = id заявки,
      • fio = ФИО,
      • phone = телефон,
      • snils = СНИЛС,
      • pdf = url для скачивания заявления,
      • haspdf = ссылка на скан заявления,
      • haspas = приложен ли скан паспорта - true / false,
      • haspas2 = приложен ли скан прописки - true / false,
      • hasnils = приложен ли скан СНИЛС - true / false,
      • hasface = приложено ли фото - true / false,
      • keys = array of
        • id = id ключа
        • rid = id заявки
        • date = дата истечения ключа
      • delivery = array of
        • status = one of
          • None - неизвестен
          • created - создана
          • scheduled - назначена
          • rescheduled - перенесена
          • problem - проблема
          • recall - перезвон (клиенту не дозвонились и перезвонят немного позднее)
          • canceled - встреча отменена (уже на встрече)
          • failed - заказ отменен (на звонке)
          • completed - успех
        • reason = причина отказа или None
        • invoice = номер накладной
        • date = дата доставки или None
        • finished_at = дата завершения или None
        • interval = примерное время доставки или None
        • company = one of
          • 0 - не определено
          • 2 - Финдоставка
          • 3 - BC Express
          • 4 - Fexpress
          • 5 - Луч-сервис
        • address = согласованный адрес доставки
        • comment = комментарий
        • documents = array of
          • ссылка на дополнительный документ
      • identification = array of
        • verified_by = id компании
        • date_created = дата создания
        • status = one of
          • 0 - ожидание
          • 1 - успех
          • 2 - отказ
        • reject_comment = причина отказа
  • Error
    • Content-type application/json
    • Body JSON
      • error 1: wrong key неправильный апи ключ (также другой создатель у заявки с этим номером),
      • error 2: no user нет такого пользователя

Добавление сотрудника в ИП/компанию

Если источнику заявки разрешено, то он может добавить пользователя в компанию. Метод работает только в случае, если пользователь и компания были зарегистрированы с одного АПИ-ключа.

URL https://server_name/register/comstaff

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • key = полученный ключ доступа
    • phone = телефон пользователя +79001234567
    • cogrn = ОГРН компании

Response

  • Success
    • Content-type text/plain
    • Body TEXT
      • ID созданного сотрудника,
  • Error
    • Content-type text/plain
    • Body TEXT
      • error 1: wrong key неправильный апи ключ (также не разрешено добавление и другой источник у заявки с этим номером)
      • error 2: wrong phone неправильный формат телефона
      • error 3: wrong ogrn неправильный формат ОГРН
      • error 4: user not found пользователь не найден
      • error 5: company not found компания с таким ОГРН не найдена
      • error 6: internal error 500 ошибка, сообщите нам, мы проверим логи

Удаление

Если источнику заявки разрешено, то он может удалить свою заявку. Данный метод работает до момента подписания документов пользователем, либо до активации им компании.

URL https://server_name/register/delete

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • api_key = полученный ключ доступа
    • id = id заявки
    • snils = СНИЛС пользователя

Response

  • Success
    • Content-type text/html
    • Body HTML
      • OK - удалено
  • Error
    • Content-type text/html
    • Body HTML
      • error 1: wrong key неправильный апи ключ (также не разрешено удаление или другой источник у заявки с этим номером)
      • error 2: user not found нет такой заявки
      • error 3: cant delete user удаление именно этой заявки запрещено

Отображение QR-кода для перехода на мобильное приложение

В случае, если пользователь зарегистрирован, но еще не привязал свое мобильное устройство, источник может получить QR-код созданного собой пользователя.

URL https://server_name/register/qr

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • api_key = полученный ключ доступа
    • uid = ид заявки

Response

  • Success
    • Content-type application/json
    • Body JSON
      • code = символы qr для ручного ввода
      • url = адрес картинки с квадратом
  • Error
    • Content-type application/json
    • Body JSON
      • error 1: wrong key неправильный апи ключ (также другой источник у заявки с этим номером)
      • error 2: wrong uid нет такого пользователя
      • error 3: db ошибка сервера, сообщите точное время возникновения для просмотра логов
      • error 4: no requests у пользователя нет заявок на мобильные ключи, привязка возможна только из личного кабинета (возникнет только у тех, кто сам удалил все свои заявки)

Повторная идентификация

URL https://server_name/register/verifyagain

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • key = полученный ключ доступа
    • phone = телефон пользователя +79123456789 или
    • id = ид заявки или
    • snils = СНИЛС пользователя
    • verified_by = идентификатор компании из метода https://server_name/register/verifiers/ , которая будет проводить идентификацию клиента

Response

  • Success

    • Content-type text/html
    • Body id заявки
  • Error

    • Content-type application/json
    • Body JSON
      • error 1: wrong key неправильный апи ключ
      • error 2: no user нет такого пользователя
      • error 3: no verificator нет такой компании

Сравнение данных пользователя

URL https://server_name/register/compare

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • key = полученный ключ доступа
    • Далее сверяемые данные, любые поля, обязательно одно из трех поисковых
    • phone = телефон пользователя +79123456789 (поиск по этому полю)
    • id = ид заявки (поиск по этому полю)
    • snils = СНИЛС пользователя (поиск по этому полю)
    • name = Имя
    • surname = Фамилия
    • lastname = Отчество
    • inn = ИНН
    • ps = серия паспорта
    • pn = номер паспорта (Для иностранцев пишем с буквами сюда слитно)
    • pdate = дата получения паспорта (yyyy-mm-dd)
    • issued = кем выдан паспорт
    • pcode = код подразделения - три цифры дефис три цифры
    • bdate = дата рождения (yyyy-mm-dd)
    • email = email

Response

  • Success

    • Content-type application/json
    • [{"phone": true}, {"surname": False}]
  • Error

    • Content-type application/json
    • Body JSON
      • error 1: wrong key неправильный апи ключ
      • error 2: no user нет такого пользователя
      • error 3: wrong data on key “k”: “e” ошибка данных типа e в ключе k (чаще всего неправильный формат или недопустимые символы)

Переотправка данных в УЦ

URL https://server_name/register/resendca

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • key = полученный ключ доступа
    • phone = телефон пользователя +79123456789 или
    • id = ид заявки или
    • snils = СНИЛС пользователя
    • auth = ид заявки из precheck auths

Response

  • Success "OK"

  • Error

    • Content-type application/json
    • Body JSON
      • error 1: wrong key неправильный апи ключ
      • error 2: no user пользователь с таким снилс/телефоном не найден
      • error 3: no auth заявки с таким ид auth нет
      • error 4: no error в заявке нет ошибок, переотправка недоступна

Приложить подпись заявления на выпуск сертификата обмена

URL https://server_name/register/crtsign

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • key = полученный ключ доступа
    • phone = телефон пользователя +79123456789 или
    • id = ид заявки или
    • snils = СНИЛС пользователя
    • auth = ид заявки из precheck auths
    • sign64 = base64(содержимое_файла_подписи)

Response

  • Success "OK"

  • Error

    • Content-type application/json
    • Body JSON
      • error 1: wrong key неправильный апи ключ
      • error 2: no user нет такого пользователя
      • error 3: no auth нет заявки с таким ид
      • error 4: wrong sign file неправильный или недействительный файл подписи
      • error 5: vicarious sign file файл подписи чужого человека

Закрыть невыполненную заявку на ключ ЭП

URL https://server_name/register/done

Request

  • Method POST
  • Content-type application/json
  • Body JSON
    • key = полученный ключ доступа
    • gk_id = ид заявки из requests
    • gak_id = опционально ид заявки из auths, если надо также закрыть заявку на ключ обмена того же устройства, что и заявка ЭП

Response

  • Success "OK"

  • Error

    • Content-type application/json
    • Body JSON
      • error 1: no gk нет заявки с таким ид
      • error 2: wrong gk source заявка от другого key
      • error 3: no gak если подано gak_id нет заявки с таким ид
      • error 4: wrong gak source если подано gak_id заявка от другого key
      • error 5: different device если подано gak_id заявка должна быть с того же устройства пользователя
      • error 6: db error ошибка сервера, сообщите точное время возникновения для просмотра логов