POST /certificate-forms

Метод позволяет создать форму на выпуск сертификата. Форма представляет собой набор данных, которые необходимы удостоверяющему центру для идентификации личности владельца и выпуска сертификата.

Заголовки

Название Описание
Content-Type Тип контента
Authorization Заголовок авторизации

Content-Type

Допустимые значения Content-Type:

  • Application/json

Тело запроса

Название Тип Формат Обязательность Описание
externalId string ^\w{1,256}$ false Клиентский идентификатор формы. Заполняется клиентом. Система контролирует уникальность идентификатора.
person string Guid true Идентификатор физического лица, либо индивидуального предпринимателя
organization string Guid false Идентификатор юридического лица
documents array Document false Документы, которые необходимы для выпуска сертификата.

Владелец сертификата

Сертификат может быть выпущен:

  • на физическое лицо

Если сертификат выпускается на физическое лицо, то необходимо заполнить параметр person. В описании заполняется идентификатор субъекта с типом физическое лицо, на которого выпускается сертификат.

  • на индивидуального предпринимателя

Если сертификат выпускается на ИП, то необходимо заполнить параметр person. В описании заполняется идентификатор субъекта с типом индивидуальный предприниматель, на которого выпускается сертификат.

  • на юридическое лицо

Если сертификат выпускается на юридическое лицо, то необходимо заполнить параметры organization и person. В описании organization необходимо указать идентификатор субъекта с типом юридическое лицо, на которого выпускается сертификат. В описании person необходимо указать идентификатор субъекта с типом физическое лицо, который является представителем организации.

Перед созданием формы необходимо создать всех субъектов методом POST /subjects и представителей методом POST /representatives.

Важно

В адресе создаваемого субъекта должен обязательно присутствовать адресный уровень улицы street или любой уровень ниже

Документы на выпуск сертификата

Для выпуска сертификата определен список документов:

Название Тип Обязательность Описание Для какого типа формы нужен
Документ удостоверяющий личность Любое значение из списка "Документы, удостоверяющие личность физического лица" true Если указывается паспорт, то необходим только разворот с фотографией. Скан/фотография оригинала или заверенной по образцу копии. на физическое и юридическое лицо, ИП
Выписка из ЕГРЮЛ Значение 008002008000 из списка "Документы, идентифицирующие юридическое лицо" true Выписка должна быть юридически значима. Дата получения выписки должна быть не позднее 3-х месяцев от текущей даты. Получить выписку можно методом GET /subjects/{subjectId}/egrul. на юридическое лицо
СНИЛС Значение 100 из списка "Документы для выпуска сертификата" false Скан СНИЛС на физическое и юридическое лицо, ИП
ИНН Значение 200 из списка "Документы для выпуска сертификата" false Если получить свидетельство нет возможности, тогда можно использовать заверенный по образцу скриншот экрана с сайта налог.ру. на физическое лицо, ИП
Фотография Значение 5300 из списка "Документы для выпуска сертификата" false Фотография владельца сертификата с паспортом. Необходимость прикладывать данный документ определяется условиями подключения к сервису на физическое и юридическое лицо, ИП
Выписка из ЕГРИП Значение 800 из списка "Документы для выпуска сертификата" true Выписка из ЕГРИП. Дата получения выписки должна быть не позднее 3-х месяцев от текущей даты. на индивидуального предпринимателя

Документы можно приложить во время создания формы или после добавить необходимые документы методом PATCH /certificate-forms/{formId}.

Допустимые форматы документов:

  • pdf;
  • png;
  • jpg;
  • jpeg;
  • tiff.

Важно

Размер документа не должен превышать 10 мб. Сканы документов должны быть цветными. Если скан черно-белый, то он должен быть заверен по образцу.

Как заверить документ по образцу

Документ необходимо заверить лицом, которое выпускает сертификат. Заверительная надпись должна содержать: должность заверяющего, его подпись и расшифровку (фамилию и инициалы), дату заверки и печать.

Примеры

  1. Создание формы на выпуск сертификата на физическое лицо
POST /realty/crypto/v2/certificate-forms
Content-Type: Application/json
Authorization: ReestroAuth apiKey=235dc85c-f7f9-4dc0-8bbf-dad9e0185afd&portal.orgid=1748b89b-7d34-4d47-b479-b06b40ab1a30
{
  "person": "70f78249-dc69-450f-ab38-19974a310020",
  "documents":
  [
    {
      "documentId": "f15596cf-b8f1-45a9-a674-20acb334a2f4",
      "documentInfo":
      {
        "documentType": "008001001000",
        "number": "123456",
        "series": "1111",
        "issueDate": "2018-12-12",
        "issuer":
        {
           "issuerCode": "123-123",
            "issuerName": "кем-то"
        }
      },
      "content":
      {
        "contentInfo":
        {
          "contentId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
          "contentType":"pdf",
          "md5":"7E0D44C48AF788657EA6F5C4C87589E8"
        }
      }
    },     
    {
      "documentId": "3e605336-a34d-4f34-93dc-b5fd78c21d6a",
      "documentInfo":
      {
        "documentType": "100"
      },
      "content":
      {
        "contentInfo":
        {
          "contentId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
          "contentType":"pdf",
          "md5":"7E0D44C48AF788657EA6F5C4C87589E8"
        }
      }
    },
    {
      "documentId": "f0478c91-a93e-45cc-81f6-482a4e0d3443",
      "documentInfo":
      {
        "documentType": "200"
      },
      "content":
      {
        "contentInfo":
        {
          "contentId": "cb351abb-36fb-43be-9194-639be38b5617",
          "contentType":"pdf",
          "md5":"F7415E33F972C03ABD4F3FED36748F7A"
        }
      }
    }
  ]
}
  1. Создание формы на выпуск сертификата на юридическое лицо
POST /realty/crypto/v2/certificate-forms
Content-Type: Application/json
Authorization: ReestroAuth apiKey=235dc85c-f7f9-4dc0-8bbf-dad9e0185afd&portal.orgid=1748b89b-7d34-4d47-b479-b06b40ab1a30
{
  "person": "70f78249-dc69-450f-ab38-19974a310020",
  "organization": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
  "documents":
  [
    {
      "documentId": "f15596cf-b8f1-45a9-a674-20acb334a2f4",
      "documentInfo":
      {
        "documentType": "008001001000",
        "number": "123456",
        "series": "1111",
        "issueDate": "2018-12-12",
        "issuer":
        {
           "issuerCode": "123-123",
            "issuerName": "кем-то"
        }
      },
      "content":
      {
        "contentInfo":
        {
          "contentId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
          "contentType":"pdf",
          "md5":"7E0D44C48AF788657EA6F5C4C87589E8"
        }
      }
    },
    {
      "documentId": "cfe23e98-96a6-44e0-9563-34e4fed03401",
      "documentInfo":
      {
        "documentType": "008002008000",
        "number": "123456",
        "issueDate": "2018-12-12",
        "content":
        {
          "contentInfo":
          {
            "contentId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
            "contentType":"pdf",
            "md5":"7E0D44C48AF788657EA6F5C4C87589E8"
          }
        }
      }
    },
    {
      "documentId": "f0478c91-a93e-45cc-81f6-482a4e0d3443",
      "documentInfo":
      {
        "documentType": "200"
      },
      "content":
      {
        "contentInfo":
        {
          "contentId": "cb351abb-36fb-43be-9194-639be38b5617",
          "contentType":"pdf",
          "md5":"F7415E33F972C03ABD4F3FED36748F7A"
        }
      }
    }
  ]
}

Ответы

201

Тело ответа

Форма успешно создана. В теле ответа содержится описание созданной формы CertificateForm.

Заголовки ответа

Название Описание
ETag Метка последнего изменения формы
Content-Type Тип содержимого

Пример ответа

  HTTP 201
  ETag: 686897696a7c876b7e
  Content-Type: Application/json
  {
    "formId": "c8fbe843-3ae2-4266-8fb7-7bf24bfd0704",
    "person":
    {

        "subjectId": "70f78249-dc69-450f-ab38-19974a310020",
        "person": {
          "name": "Анастасия",
          "surname": "Тарасова",
          "patronymic": "Константиновна",
          "dateBirth": "2018-01-01",
          "birthPlace": "Где то",
          "snils": "000-000-000 55",
          "inn": "121212121212",
          "email": "imya@yandex.ru",
          "phone": "79699999999",
          "gender": "Female",
          "identityDocument":
          {
            "documentType": "008001001000",
            "number": "123456",
            "series": "1111",
            "issueDate": "2018-12-12",
            "issuer":
            {
              "issuerCode": "123-123",
              "issuerName": "кем-то"
            }
          },
          "citizenship": "848000000643",
          "address":
          {
            "structuralAddress":
            {
              "region": "54",
              "city":
              {
                "name": "Новосибирск",
                "abbreviation": "г"
              },
              "street":
              {
                "name": "Челюскинцев",
                "abbreviation": "ул"
              },
              "house":
              {
                "name": "14",
                "abbreviation": "д"
              }
            }
          }
        }
    },
    "documents":
    [
      {
        "documentId": "f15596cf-b8f1-45a9-a674-20acb334a2f4",
        "documentInfo":
        {
          "documentType": "008001001000",
          "number": "123456",
          "series": "1111",
          "issueDate": "2018-12-12",
          "issuer":
          {
            "issuerCode": "123-123",
            "issuerName": "кем-то"
          }
        },
        "content":
        {
          "contentInfo":
          {
            "contentId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
            "contentType":"pdf",
            "md5":"7E0D44C48AF788657EA6F5C4C87589E8"
          }
        }
      },
      {
        "documentId": "3e605336-a34d-4f34-93dc-b5fd78c21d6a",
        "documentInfo":
        {
          "documentType": "100"
        },
        "content":
        {
          "contentInfo":
          {
            "contentId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
            "contentType":"pdf",
            "md5":"7E0D44C48AF788657EA6F5C4C87589E8"
          }
        }
      },
      {
        "documentId": "f0478c91-a93e-45cc-81f6-482a4e0d3443",
        "documentInfo":
        {
          "documentType": "200"
        },
        "content":
        {
          "contentInfo":
          {
            "contentId": "cb351abb-36fb-43be-9194-639be38b5617",
            "contentType":"pdf",
            "md5":"F7415E33F972C03ABD4F3FED36748F7A"
          }
        }
      }
    ],
    "state": "Created"
  }

400

Ошибки валидации запроса. В теле ответа содержится описание ошибки Error. Для данного метода возможны следующие ошибки:

Код ошибки Описание Содержимое контекста
WrongFieldValue Значение поля не соответствует требуемому формату. Поле, формат которого не соответствует, указано в описании ошибки в message
AbsenceOfRequiredField Не указано одно из обязательных полей
DuplicatedExternalId Указанный в запросе внешний идентификатор уже был использован ранее
DuplicateDocument Указано более одного документа, удостоверяющего личность Массив документов, которые дублируют друг друга по смыслу Document[]
MismatchDocumentRequisites Реквизиты документа удостоверяющего личность в описании субъекта и в приложенном документе не совпадают
UnexistentRepresentative Представитель для пары физическое лицо и организация не был создан
UnexistentSubject Не удалось найти указанного субъекта Идентификатор субъекта, которого не удалось найти
BigContentSize Размер контента превышает 10 мб Описание неправильного контента ContetnIfo
UnsupportedContentType Указан контент, формат которого не поддерживается методом Описание неправильного контента ContetnIfo
UnexistentContent Не удалось найти контент в базе по указанному идентификатору Описание ненайденного контента ContetnIfo
WrongAddress Адрес субъекта указан в неправильном формате Описание неправильного адреса Address

Пример ответа

  HTTP 400
  Content-Type Application/json
  {
      "code": "validation",
      "message": "Failed to validate request",
      "target": "api"
      "errors":
      [
        {
          "code": "BigContentSize",
          "message": "content 978a9fda-e2e8-415d-bf25-31487ffb8bf1  is bigger than 10 mb ",
          "target": "CryptoApi",
          "context":
          {
            "contentId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
            "contentType":"pdf",
            "contentName": "Договор купли-продажи",
            "md5":"7E0D44C48AF788657EA6F5C4C87589E8"
          }
        }
      ]
    }

401

Ошибка авторизации: пользователь не авторизован

403

Ошибка аутентификации: пользователь не имеет доступа к ресурсам организации, которая указана в заголовке авторизации

415

В заголовке Content-Type указан тип контента, который не поддерживается для данного метода