{"openapi":"3.0.3","info":{"title":"1.19. API ЕСИА. Импорт учетных записей пользователя","description":"Программный интерфейс, основанный на архитектурном стиле REST, в целях обеспечения импорта в ЕСИА учетных записей других ИС, обеспечивает возможность проверки наличия учетной записи пользователя, а в случае её отсутствия, регистрации пользователя в ЕСИА.","termsOfService":"https://esia.gosuslugi.ru","contact":{"name":"Федеральный ситуационный центр","email":"sd@sc.minsvyaz.ru","url":"https://sc.minsvyaz.ru"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"version":"1.0.0"},"servers":[{"url":"https://esia.gosuslugi.ru","description":"url продуктивной среды"},{"url":"https://esia-portal1.test.gosuslugi.ru","description":"url тестового стенда"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Сервис импорта учётных записей пользователей"}],"paths":{"/esia-rs/api/public/v2/prns/import":{"post":{"tags":["Сервис импорта учётных записей пользователей"],"summary":"Импорт учетной записи пользователя","description":"Импорт учетной записи пользователя в ЕСИА","operationId":"userImportUsingPost","requestBody":{"description":"Данные об импортируемой учетной записи пользователя","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountImportRequest"}}}},"parameters":[{"in":"header","name":"Request-Data","description":"Тело параметров запроса (JSON), закодированное в base64","schema":{"type":"string","maxLength":8200,"example":"ew0KICAiZmlyc3ROYW1lIjoiw5DCmMOQwrLDkMKw..."},"required":true},{"in":"query","name":"confirmWay","required":true,"schema":{"type":"string","enum":["REST_API"]}},{"in":"header","name":"Request-Data-Sign","description":"Подпись запроса в формате PKCS#7 detached signature в кодировке UTF-8 от от JSON с параметрами запроса. Request-Data-Sign должен быть закодирован в формате base64 url safe. Используемый для проверки подписи сертификат должен быть предварительно зарегистрирован в ЕСИА и привязан к учетной записи системы-клиента в ЕСИА. ЕСИА поддерживает сертификаты в формате X.509. ЕСИА поддерживает алгоритм формирования электронной подписи ГОСТ Р 34.10-2012 и алгоритм криптографического хэширования ГОСТ Р 34.11-2012.","schema":{"type":"string","maxLength":8200,"example":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkg..."},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountImportResponse"},"examples":{"personAlreadyHasTrustedAccountInEsia":{"description":"Пользователь уже зарегистрирован в ЕСИА, учетная запись уже подтверждена ранее","value":{"code":"0","description":"Person already has trusted account in ESIA"}},"personSuccessfullyConfirmedAsTrustedInEsia":{"description":"Учетная запись пользователя успешно подтверждена в ЕСИА","value":{"code":"1","description":"Person successfully confirmed as trusted in ESIA"}},"personSuccessfullyReconfirmedAsTrustedInEsia":{"description":"Учетная запись пользователя успешно переподтверждена в ЕСИА","value":{"code":"1","description":"Person successfully reconfirmed as trusted in ESIA"}},"requestToRegisterPersonAsTrustedInEsiaHasBeenAcceptedSuccessfully":{"description":"Запрос на регистрацию успешно отправлен, создана заявка на регистрацию","value":{"requestId":"AAAAF3A1379F965664CB56FCE55BD8CCA2F38368985607E75E23","code":"2","description":"Request to register person as trusted in ESIA has been accepted successfully"}},"requestToConformSimplifiedPersonAsTrustedInEsiaHasBeenAcceptedSuccessfully":{"description":"Найдена упрощенная учетная запись, создана заявка на подтверждение","value":{"requestId":"AAAAF3A1379F965664CB56FCE55BD8CCA2F38368985607E75E23","code":"3","description":"Request to conform simplified person as trusted in ESIA has been accepted successfully"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountImportResponse"},"examples":{"importAccountError":{"description":"Ошибка импорта, некоторые атрибуты запроса не совпадают с учетной записью в ЕСИА – требуется корректировка параметров запроса или учетной записи в ЕСИА","value":{"code":"ESIA-03200","description":"Import account error. Person have to check entered data or fill in the data in his account in ESIA."}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/rs/reqs/{requestId}":{"get":{"tags":["Сервис импорта учётных записей пользователей"],"summary":"Проверка статуса заявки на регистрацию пользователя","description":"Проверка статуса обработки (валидации) заявки на импорт учётной записи пользователя в ЕСИА","operationId":"getRequestStatusUsingGet","parameters":[{"name":"requestId","in":"path","description":"requestId","required":true,"style":"simple","schema":{"maxLength":8200,"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestStatusResponse"},"examples":{"importRequestSuccedded":{"description":"Успешная регистраци учетной записи при импорте в ЕСИА","value":{"stateFacts":["Identifiable"],"status":"SUCCEEDED","personOid":1000352622}},"snilsValidatioFailed":{"description":"Регистрация учетной записи при импорте в ЕСИА не выполнена – ошибка при проверке ФИО, СНИЛС и даты рождения в ПФР России","value":{"stateFacts":["Identifiable"],"status":"VALIDATION_FAILED","flowDetails":[{"name":"raRegistrationEndorsement","status":"S"},{"name":"validateSnils","status":"F","error":{"code":"ESIA-910001","message":"Пенсионный фонд Российской Федерации не подтвердил существование СНИЛС с указанными реквизитами"}},{"name":"sendSMS","status":"C"}],"errorStatusInfo":{"code":"ESIA-910001","message":"Пенсионный фонд Российской Федерации не подтвердил существование СНИЛС с указанными реквизитами"}}},"rFpassportValidationFailed":{"description":"Регистрация учетной записи при импорте в ЕСИА не выполнена – ошибка при проверке паспортных данных в МВД России","value":{"stateFacts":["Identifiable"],"status":"VALIDATION_FAILED","flowDetails":[{"name":"validateRfPassport","status":"F","error":{"code":"ESIA-910100","message":"В автоматическом режиме не удалось произвести проверку вашего паспорта"}}],"errorStatusInfo":{"code":"ESIA-910100","message":"В автоматическом режиме не удалось произвести проверку вашего паспорта"}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"AccountImportRequest":{"required":["birthDate","contacts","documents","firstName","gender","lastName","snils"],"type":"object","additionalProperties":false,"properties":{"addresses":{"title":"AddressCollectionContainer","type":"object","additionalProperties":false,"properties":{"elements":{"type":"array","description":"Коллекция типа Address","items":{"$ref":"#/components/schemas/Address"}}},"description":"Контейнер коллекции дженерифицированного типа Address"},"birthDate":{"type":"string","pattern":"^\\d{2}\\.\\d{2}\\.\\d{4}$","maxLength":10,"description":"Дата рождения (формат: ДД.ММ.ГГГГ); обязательное поле","example":"01.01.1999"},"birthPlace":{"maxLength":700,"type":"string","description":"Место рождения (текстовая строка, содержащая не более 700 символов; необязательное поле)","example":"Москва"},"citizenship":{"maxLength":3,"minLength":3,"type":"string","description":"Гражданство по классификатору ОКСМ (используется трехбуквенный код страны, например, для России он должен принимать значение RUS; по умолчанию принимается значение “RUS”; обязателен в случае, если указанный документ отличен от паспорта РФ)","example":"RUS"},"contacts":{"title":"ContactCollectionContainer","type":"object","additionalProperties":false,"properties":{"elements":{"type":"array","description":"Коллекция типа Contact","items":{"$ref":"#/components/schemas/Contact"},"example":[{"type":"EML","value":"test@test.ts"},{"type":"MBT","value":"+7(999)9999999"}]}},"description":"Контейнер коллекции дженерифицированного типа Contact"},"documents":{"title":"DocumentCollectionContainer","type":"object","additionalProperties":false,"properties":{"elements":{"type":"array","description":"Коллекция типа Document","items":{"$ref":"#/components/schemas/Document"}}},"description":"Контейнер коллекции дженерифицированного типа"},"firstName":{"maxLength":60,"type":"string","description":"Имя (текстовая строка, содержащая не более 60 символов; обязательное поле)","example":"Иван"},"gender":{"type":"string","description":"Пол (обязательное поле).\nПеречень допустимых значений:\n- “M” – мужской;\n- “F” – женский.","enum":["F","M"],"example":"M"},"lastName":{"maxLength":60,"type":"string","description":"Фамилия (текстовая строка, содержащая не более 60 символов; обязательное поле)","example":"Иванов"},"middleName":{"maxLength":60,"type":"string","description":"Отчество (текстовая строка, содержащая не более 60 символов; необязательно, в случае если отчество отсутствует в паспорте)","example":"Иванович"},"snils":{"pattern":"^\\d{3}-\\d{3}-\\d{3} \\d{2}$","type":"string","maxLength":14,"description":"СНИЛС (формат: ХХХ-ХХХ-ХХХ ХХ; обязательное поле).\n","example":"000-000-000 07"}},"description":"Тело запроса на импорт учетной записи пользователя"},"AccountImportResponse":{"required":["code"],"type":"object","additionalProperties":false,"properties":{"code":{"type":"string","maxLength":14,"description":"Код завершения операции.\nПеречень допустимых значений:\n- “0” – выполнен импорт учётной записи;\n- “1” – выполнен импорт учётной записи;\n- “2” – создана заявка на импорт (регистрацию) учётной записи;\n- “3” – найдена упрощенная учетная запись, создана заявка на импорт (регистрацию) учётной записи;\n- код ошибки в формате ESIA-XXXXXX.","example":"ESIA-039810"},"description":{"type":"string","maxLength":1000,"description":"Текстовое описание кода завершения операции.\nОписание для кодов успешного импорта учётной записи в ЕСИА (code = 0, 1, 2 или 3) и для\ncode = ESIA-03200.","example":"Номер мобильного телефона уже используется в другой учетной записи.\nЕсли вы уже регистрировались, попробуйте войти в свою учетную запись.\nЕсли вы не регистрировались, укажите другой номер мобильного телефона или удалите номер\nтелефона из формы регистрации."},"message":{"type":"string","maxLength":1000,"description":"Текстовое описание кода ошибки выполнения операции.\nОписание для кодов ошибок при импорте учётной записи в ЕСИА (за исключением кода\nESIA-03200)."},"requestId":{"type":"string","maxLength":8200,"description":"Код заявки на регистрацию.\nВозвращается в случае создания заявки на регистрацию."}},"description":"Ответ на запрос импорта учетной записи пользователя"},"Address":{"required":["addressStr","type"],"type":"object","additionalProperties":false,"properties":{"additionArea":{"maxLength":256,"type":"string","description":"Уточнение по региону проживания. Текстовая строка, содержащая не более 256 символов."},"additionAreaStreet":{"maxLength":256,"type":"string","description":"Уточнение по улице.\nТекстовая строка, содержащая не более 256 символов."},"addressStr":{"maxLength":2000,"type":"string","description":"Адресная строка (обязательное поле).\nТекстовая строка, содержащая элементы адреса (перечисляютсячерез разделитель «,», не более 2000 символов","example":"Кемеровская область, Таштагольский район, Шерегеш поселок городского типа, Усть-Анзас поселок, Советская улица"},"area":{"maxLength":256,"type":"string","description":"Район.\nТекстовая строка, содержащая не более 256 символов.","example":"Таштагольский Район"},"building":{"maxLength":256,"type":"string","description":"Строение.\nТекстовая строка, содержащая не более 256 символов."},"city":{"maxLength":256,"type":"string","description":"Город.\nТекстовая строка, содержащая не более 256 символов.","example":"Шерегеш Поселок городского типа"},"countryId":{"maxLength":3,"minLength":3,"type":"string","description":"Трехбуквенный код страны (формат: XXX).","example":"RUS"},"district":{"maxLength":256,"type":"string","description":"Округ.\nТекстовая строка, содержащая не более 256 символов."},"fiasCode":{"maxLength":256,"type":"string","description":"Код ФИАС.\nФормат: ХХХХХХХХ-ХХХХ-ХХХХ-ХХХХ-ХХХХХХХХХХХХ.","example":"5bf5ddff-6353-4a3d-80c4-6fb27f00c6c1"},"flat":{"maxLength":256,"type":"string","description":"Квартира.\nТекстовая строка, содержащая не более 256 символов."},"frame":{"maxLength":256,"type":"string","description":"Корпус.\nТекстовая строка, содержащая не более 256 символов."},"house":{"maxLength":256,"type":"string","description":"Дом.\nТекстовая строка, содержащая не более 256 символов.","example":"Дом 19"},"region":{"maxLength":256,"type":"string","description":"Область.\nТекстовая строка, содержащая не более 256 символов.","example":"Кемеровская Область"},"settlement":{"maxLength":256,"type":"string","description":"Населенный пункт.\nТекстовая строка, содержащая не более 256 символов.","example":"Усть-Анзас Поселок"},"street":{"maxLength":256,"type":"string","description":"Улица.\nТекстовая строка, содержащая не более 256 символов."},"type":{"type":"string","description":"Тип адреса (обязательное поле).\nПеречень допустимых значений:\n- “PLV” – адрес проживания;\n- “PRG” – адрес регистрации.","enum":["PLV","PRG"],"example":"PLV"},"zipCode":{"maxLength":256,"type":"string","description":"Индекс.\nТекстовая строка, содержащая не более 256 символов.","example":"652975"}},"description":"Адрес пользователя"},"Contact":{"required":["type","value"],"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","description":"Тип контакта (обязательное поле).\nПеречень допустимых значений:\n- “MBT” – мобильный телефон (обязательный параметр);\n- “EML” – электронная почта (необязательный параметр).","enum":["EML","MBT"],"example":"MBT"},"value":{"type":"string","maxLength":254,"description":"Значение (обязательное поле).\nФормат:\n- “+X(XXX)XXXXXXX” (для type = “ MBT”);\n- текстовая строка в формате адреса электронной почты (для type = “ EML”).","example":"+7(999)9999999"}},"description":"Контакт пользователя"},"Document":{"required":["issueDate","type"],"type":"object","additionalProperties":false,"properties":{"expireDate":{"type":"string","pattern":"^\\d{2}\\.\\d{2}\\.\\d{4}$","maxLength":10,"description":"Дата окончания срока действия документа.\nТолько для заграничного паспорта гражданина РФ.\nФормат: ДД.ММ.ГГГГ","example":"01.12.2022"},"issueDate":{"type":"string","pattern":"^\\d{2}\\.\\d{2}\\.\\d{4}$","maxLength":10,"description":"Дата выдачи паспорта (формат: ДД.ММ.ГГГГ); обязательное поле","example":"18.03.2016"},"issueId":{"type":"string","maxLength":6,"description":"Номер подразделения, выдавшего паспорт.\nТолько для паспорта гражданина РФ.\nНеобязательный для документа иностранного гражданина и заграничного паспорта гражданина РФ.","example":"111001"},"issuedBy":{"type":"string","maxLength":233,"description":"Наименование подразделения, выдавшего паспорт.\nТолько для паспорта гражданина РФ.\nНеобязательно для документа иностранного гражданина и заграничного паспорта гражданина РФ.","example":"РУВД г.Москвы"},"latinFirstName":{"type":"string","maxLength":60,"description":"Имя (латиницей).\nТолько для заграничного паспорта гражданина РФ.","example":"Ivan"},"latinLastName":{"type":"string","maxLength":60,"description":"Фамилия (латиницей).\nТолько для заграничного паспорта гражданина РФ.","example":"Ivanov"},"number":{"type":"string","maxLength":7,"description":"Номер.\nДля паспорта гражданина РФ в формате XXXXXX.\nДля заграничного паспорта гражданина РФ в формате XXXXXXX.","example":"889999"},"series":{"type":"string","maxLength":4,"description":"Серия.\nДля паспорта гражданина РФ в формате XXXX (обязательое поле).\nДля заграничного паспорта гражданина РФ в формате XX (обязательое поле).\nНеобязательный для документа иностранного гражданина.","example":"2222"},"type":{"type":"string","description":"Тип докумета (обязательное поле).\nПеречень допустимых значений:\n- “RF_PASSPORT” – паспорт гражданина РФ;\n- “FID_DOC” – документ иностранного гражданина, удостоверяющий личность на территории РФ;\n- “FRGN_PASS” – заграничный паспорт гражданина РФ.\n","enum":["FID_DOC","FRGN_PASS","RF_PASSPORT"],"example":"RF_PASSPORT"}},"description":"Документ пользователя"},"FlowDetail":{"required":["name","status"],"type":"object","additionalProperties":false,"properties":{"error":{"$ref":"#/components/schemas/RequestStatusError"},"name":{"type":"string","enum":["raRegistrationEndorsement","sendSMS","validateSnils","validateRfPassport"],"example":"raRegistrationEndorsement","description":"Имя задачи"},"status":{"type":"string","enum":["C","F","I","P","S","W"],"example":"C","description":"Статус задачи"}},"description":"Данные о задаче, ее статус и – при наличии – об ошибке."},"RequestStatusError":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string","maxLength":14,"example":"ESIA-910001","description":"Код ошибки"},"message":{"type":"string","maxLength":1000,"example":"Пенсионный фонд Российской Федерации не подтвердил существование СНИЛС с указанными реквизитами","description":"Описание ошибки"}},"description":"Детальная информация по ошибке при запросе статуса заявки на импорт УЗ пользователя в ЕСИА"},"RequestStatusResponse":{"type":"object","additionalProperties":false,"description":"Детальная информации о статусе заявки на импорт УЗ пользователя в ЕСИА","properties":{"errorStatusInfo":{"$ref":"#/components/schemas/RequestStatusError"},"flowDetails":{"type":"array","items":{"$ref":"#/components/schemas/FlowDetail"},"description":"Данные о задачах, их статусы и – при наличии – об ошибке."},"personOid":{"type":"integer","format":"int64","description":"Идентификатор зарегистрированной учётной записи (возвращается в случае успешно выполненной\nоперации импорта учетной записи в ЕСИА). Предельное ограничение - Long.MAX_VALUE"},"stateFacts":{"type":"array","description":"Служебное поле","items":{"type":"string","maxLength":8200},"example":["Identifiable"]},"status":{"type":"string","enum":["SUCCEEDED","VALIDATING","VALIDATION_FAILED"],"description":"Статус заявки на регистрацию пользователя"}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}}}