Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Запит служить для отримання результату перевірки ЕП. Запит є блокуючим, то результат буде отримано лише після завершення процесу перевірки ЕП, якщо такий був раніше запущено. Якщо ЕП дійсна, то буде повернуто HTTP статус код 200. Якщо ЕП не дійсний чи у процесі її безпосередньої перевірки виникають помилки, буде повернуто HTTP статус код 406. При появі інших типів помилок, повертаються HTTP статус коди 503 чи 400.

URL-адреса запиту

Запрос служит для получения результата проверки ЭП. Запрос является блокирующим, то есть результат будет получен только после завершения процесса проверки ЭП, если такой был ранее запущен. Если ЭП действительна, будет возвращен HTTP статус код 200. Если в ЭП недействительна или в процессе ее непосредственной проверки возникли ошибки, будет возвращен HTTP статус код 406. При возникновении других типов ошибок, возвращаются HTTP статус коды 503 или 400.

...

https://local.cipher.kiev.ua:9090/api/v1/ticket/{uuid}/ds/verifier

Метод

GET

...

Параметри запиту
uuidStringИдентификатор сессииІдентифікатор сесії

...

Налаштовувані заголовки

...

запиту

ОтсутствуетВідсутні

...

Відповідь
Код ответавідповідіContent-typeДопустимые параметрыДопустимі параметриПриклад вмістуПример содержимого
200application/jsonmessage
verifyResults 
{
"message" : "ЭлектроннаяЕлектронний подписьпідпис действительнадійсний.",
"verifyResults" : Array
}
503application/jsonmessage
{
       "message" : "СервисСервіс выполнениявиконання криптографическихкриптографічних операцийоперацій не запущензапущено."
}
400application/jsonmessage
{
       "message" : "СессияСесія отсутствуетвідсутня."
}
406application/jsonmessage
verifyResults
failureCause
{
       "message" : "ЭлектроннаяЕлектронний підпис подписьне недействительнадійсний.",
"failureCause" : "",
"verifyResults" : Array
}

...

Параметри JSON

...

обʼєкта відповіді
ПараметрТип данныхданихОписаниеОпис
messageStringОписание результата проведения операцииОпис результату проведення операції
failureCause StringОписание причины возникновения ошибки, которая возникла при выполнении запроса на проверку ЭПОпис причини виникнення помилки, яка виникла при виконанні запиту на перевірку ЕП
verifyResultsArrayРезультаты проверки отдельно по каждой из ЭПРезультати перевірки окремо по кожній з ЕП

Поля елемента масиву Поля элемента массива verifyResults

проверка ЭП произведена без ошибок процессе проверки ЭП возникли ошибкиОписание причины возникновения ошибки, которая возникла при непосредственной проверке ЭПИнформация из сертификата владельца ЭПВремя выработки ЭП ЭП действительна ЭП недействительна проверки электронной метки (ЭМВ) времени данных, для которых была выработана ЭПРезультаты проверки электронных меток времени электронной подписи проверки подписи использовалось время создания подписи, которое не заверено электронной меткой времени ЭП действительна ЭП недействительна
ПолеТип данныхданихОписаниеОпис
statusString"SUCCESS" - перевірка ЕП здійснена без помилок
"FAILURE" - в
процесі перевірки ЕП виникли помилки
failureCauseStringОпис причини виникнення помилки, яка виникла при безпосередній перевірці ЕП
signerInfoObjectІнформація з сертифіката власника ЕП
signingDateTimeStringЧас створення ЕП
isValidBooleantrue - ЕП дійсний
false -
ЕП не дійсний
contentTimestampObjectРезультат перевірки електронної позначки часу (ЕПЧ) даних для яких було створено ЕП
signatureTimestampsArrayРезультати перевірки ЕПЧ електронного підпису
isUntrustedValidBooleanДля перевірки ЕП використовується час створення ЕП, яке не завірено ЕПЧ.
true -
ЕП дійсна
false -

Поля объекта contentTimestamp, элемента массива signatureTimestamps

...

ЕП не дійсний
signatureTypeString

Тип електронного підпису.
Можливі значення:

  • DETACHED
  • ATTACHED
  • ASIC_S
  • ASIC_E
signatureFormatString

Формат електронного підпису.
Можливі значення:

  • CADES_BES
  • CADES_C
  • CADES_T
  • CADES_X_LONG
  • XADES_B_B
  • XADES_B_T
  • XADES_B_LT
  • XADES_B_LTA

Поля обʼєкта contentTimestamp, елемента масиву signatureTimestamps

ПолеТип данихОпис
isValidBooleantrue - ЕПЧ дійсна
false - ЕПЧ не дійсна
isFailureBooleantrue - при перевірці ЕПЧ виникла помилка
false - при перевірці ЕПЧ помилок не виникло
dateTimeDateTimeЗначення дати та часу у форматі ISO 8601, яке завірено ЕПЧ
tsaCertificateSerialNumberObject*Серійний номер сертифікату TSP-серверу

Поля обʼєкта

Anchor
signerInfo
signerInfo
signerInfo

ПолеТип данихОпис
ownerCertificateInfoObject*Інформація про власника
issuerCertificateInfoObject*Інформація про видавця
publicKeyCertificateInfoObject*Інформація про відкритий ключ
certificateSerialNumberObject*Серійний номер сертифікату
notBeforeObject*Початок дії
notAfterObject*Кінець дії
extensionsCertificateInfoObject*Розширення

Поля обʼєкта

Anchor
ownerCertificateInfo
ownerCertificateInfo
signerInfo.ownerCertificateInfo.value

ПолеТип данихОпис
ownerSurnameObject*Прізвище
ownerGivennameObject*Імʼя по батькові
ownerFullNameObject*Повне імʼя
ownerCountryObject*Країна
ownerRegionObject*Область
ownerCityObject*Населений пункт
ownerAddressObject*Поштова адреса
ownerSerialNumberObject*Серійний номер власника
ownerPositionObject*Посада

Поля обʼєкта

Anchor
issuerCertificateInfo
issuerCertificateInfo
 signerInfo.issuerCertificateInfo.value

ПолеТип данихОпис
issuerOrganizationObject*Організація
issuerDepartmentObject*Підрозділ
issuerFullNameObject*Повне імʼя
issuerCountryObject*Країна
issuerRegionObject*Область
issuerCityObject*Населений пункт
issuerAddressObject*Поштова адреса
issuerSerialNumberObject*Серійний номер власника

Поля обʼєкта

Anchor
publicKeyCertificateInfo
publicKeyCertificateInfo
 signerInfo.publicKeyCertificateInfo.value

ПолеТип данихОпис
publicKeyObject*Відкритий ключ
dsAlgorismObject*Алгоритм ЕП

Поля обʼєкта

Anchor
extensionsCertificateInfo
extensionsCertificateInfo
 signerInfo.extensionsCertificateInfo.value

ПолеТип данихОпис
personalDataObject*Персональні дані
alternativeOwnerNameObject*Альтернативне імʼя власника
subjectKeyIdObject*Ідентифікатор ключа
issuerKeyIdObject*Ідентифікатор ключа видавця
subjectOwnerIdObject*Ідентифікатор власника
certificateProfileObject*Профіль сертифікату
keyUsageObject*Призначення сертифікату
isTemporaryObject*Ознака стартового сертифікату
isReinforcedObject*Ознака посиленого сертифікату
isQualifiedObject*Ознака кваліфікованого сертифікату
isPrivateKeyOnQSCDObject*Ознака засобу КЕП
qscdTypeNameObject*Тип засобу КЕП
isElectronicStampObject*Ознака електронної печатки

Поля обʼєкта

Anchor
personalData
personalData
 signerInfo.extensionsCertificateInfo.value.personalData.value   

ПолеТип данихОпис
customIdObject*Зовнішній ідентифікатор
passportObject*Паспортні дані
drfouObject*Реєстраційний номер облікової картки платника податків

edrpou

Object*Код ЄДРПОУ

eddrun

Object*

Унікальний номер запису в ЄДДР

Поля обʼєкта типу 

Anchor
CertObject
CertObject
Object* 

ПолеТип данихОпис
descriptionStringОпис поля на мові, який було вибрано у Сервісі
value[Object, String, Boolean, Number, Array, null]Значення поля

Приклад обʼєкта signerInfo

Code Block
{
    "message": "Електронний підпис дійсний.",
    "verifyResults": [

...

edrpou

...

eddrun

...

Уникальный номер записи в ЕГДР

...

Пример объекта signerInfo

Code Block
{
    "message": "Електронний підпис дійсний.",
    "verifyResults": [
        {
            "status": "SUCCESS",
            "failureCause": "",
            "isValid": true,
            "signingDateTime": "2020-03-05T13:25:36Z",
            "contentTimestamp": {},
            "signatureTimestamps": [
                {
                    "isValid": true,
                    "isFailure": false,
                    "dateTime": "2020-03-05T13:25:39Z",
                    "tsaCertificateSerialNumber": "3DB73E7BF0D575B20200000001000000BB000000"
                }
            ],
            "signerInfo": {
                "ownerCertificateInfo": {
                    "description": "Власник",
                    "value": {
        {
                "ownerSurnamestatus": {"SUCCESS",
            "failureCause": "",
               "descriptionisValid": "Прізвище"true,
            "signingDateTime": "2020-03-05T13:25:36Z",
               "valuecontentTimestamp": "Боровіков"{},
            "signatureTimestamps": [
           },
     {
                    "ownerGivennameisValid": {
         true,
                    "descriptionisFailure": "Імя по-батькові"false,
                            "value"dateTime": "Олександр Михайлович"2020-03-05T13:25:39Z",
                    "tsaCertificateSerialNumber": "3DB73E7BF0D575B20200000001000000BB000000"
   },
             }
           "ownerFullName": { ],
            "signerInfo": {
                "descriptionownerCertificateInfo": "Повне ім'я",
        {
                    "value": "Боровіков Олександр Михайлович"description": "Власник",
                        },"value": {
                        "ownerCountryownerSurname": {
                            "description": "КраїнаПрізвище",
                            "value": "UAБоровіков"
                        },
                        "ownerRegionownerGivenname": {
                            "description": "ОбластьІмя по-батькові",
                            "value": null"Олександр Михайлович"
                        },
                        "ownerCityownerFullName": {
                            "description": "МістоПовне ім'я",
                            "value": "КиївБоровіков Олександр Михайлович"
                        },
                        "ownerAddressownerCountry": {
                            "description": "Поштова адресаКраїна",
                            "value": null"UA"
                        },
                        "ownerSerialNumberownerRegion": {
                            "description": "Серійний номер власникаОбласть",
                            "value": "2423814"null
                        },
                        "ownerPositionownerCity": {
                            "description": "ПосадаМісто",
                            "value": null"Київ"
                        },
                        "ownerOrganizationownerAddress": {
                            "description": "ОрганізаціяПоштова адреса",
                            "value": null
                        },
                        "ownerOrganizationUnitownerSerialNumber": {
                            "description": "Відділ (підрозділ)Серійний номер власника",
                            "value": null"2423814"
                        },
                    }
    "ownerPosition": {
            },
                "issuerCertificateInfodescription": {
"Посада",
                            "descriptionvalue": "Видавник",
null
                       "value": { },
                        "issuerOrganizationownerOrganization": {
                            "description": "Організація",
                            "value": "Інформаційно-довідковий департамент ДФС"null
                        },
                        "issuerDepartmentownerOrganizationUnit": {
                            "description": "ПідрозділВідділ (підрозділ)",
                            "value": "Управління (центр) сертифікації ключів ІДД ДФС"": null
                        },
                    }
    "issuerFullName": {
           },
                 "descriptionissuerCertificateInfo": "Повне ім'я",
        {
                    "valuedescription": "Акредитований центр сертифікації ключів ІДД ДФС"Видавник",
                        },"value": {
                        "issuerCountryissuerOrganization": {
                            "description": "КраїнаОрганізація",
                            "value": "UAІнформаційно-довідковий департамент ДФС"
                        },
                        "issuerRegionissuerDepartment": {
                            "description": "ОбластьПідрозділ",
                            "value": "Управління (центр) сертифікації ключів ІДД "valueДФС": null
                        },
                        "issuerCityissuerFullName": {
                            "description": "МістоПовне ім'я",
                            "value": "КиївАкредитований центр сертифікації ключів ІДД ДФС"
                        },
                        "issuerAddressissuerCountry": {
                            "description": "Поштова адресаКраїна",
                            "value": null"UA"
                        },
                        "issuerSerialNumberissuerRegion": {
                            "description": "Серійний номер видавцяОбласть",
                            "value": "UA-39384476-2018"
                        }
   "value": null
                }
        },
        },
                "publicKeyCertificateInfoissuerCity": {
                            "description": "Інформація про відкритий ключ",
"Місто",
                            "value": {"Київ"
                        "publicKey": {
 },
                           "descriptionissuerAddress": "Відкритий ключ",{
                            "valuedescription": "C4 39 B0 5D 95 8A 6D 95 0E 4D F4 71 2A 62 59 6B A1 55 C9 6A 91 99 21 01 8E D3 7B B4 72 11 E6 F9 00"Поштова адреса",
                            "value": null
                        },
                        "dsAlgorismissuerSerialNumber": {
                            "description": "АлгоритмСерійний номер ЕПвидавця",
                            "value": "ДСТУ 4145-2002, ПБ, little-endianUA-39384476-2018"
                        }
                    }
                },
                "certificateSerialNumberpublicKeyCertificateInfo": {
                    "description": "Серійний номер сертифікату",
": "Інформація про відкритий ключ",
                    "value": {
                        "valuepublicKey": "20B4E4ED0D30998C0400000006FC24004DAD7500"{
                },
            "description": "Відкритий ключ",
  "notBefore": {
                          "descriptionvalue": "Початок дії",
                    "value": "2019-06-10T21:00:00ZC4 39 B0 5D 95 8A 6D 95 0E 4D F4 71 2A 62 59 6B A1 55 C9 6A 91 99 21 01 8E D3 7B B4 72 11 E6 F9 00"
                },
        },
          "notAfter": {
             "dsAlgorism": {
      "description": "Закінчення дії",
                    "valuedescription": "2021-06-10T21:00:00Z"Алгоритм ЕП",
                },
            "value": "ДСТУ 4145-2002, ПБ, "extensionsCertificateInfo": {
little-endian"
                       "description": "Розширення", }
                    "value": {}
                },
        "personalData": {
       "certificateSerialNumber": {
                    "description": "ПерсональніСерійний номер данісертифікату",
                            "value": {"20B4E4ED0D30998C0400000006FC24004DAD7500"
                },
                "customIdnotBefore": {
                    "description": "Початок дії",
                    "descriptionvalue": "Зовнішній ідентифікатор",
 "2019-06-10T21:00:00Z"
                },
                "notAfter": {
                    "valuedescription": null "Закінчення дії",
                    "value": "2021-06-10T21:00:00Z"
                },
                "extensionsCertificateInfo": {
                    "passportdescription": {"Розширення",
                    "value": {
               "description": "Паспортні дані",
       "personalData": {
                            "valuedescription": null"Персональні дані",
                                },"value": {
                                "drfoucustomId": {
                                    "description": "Реєстраційний номер облікової картки платника податківЗовнішній ідентифікатор",
                                    "value": "2031914098"null
                                },
                                "edrpoupassport": {
                                    "description": "КодПаспортні ЕДПРОУдані",
                                    "value": null
                                },
                                "eddrundrfou": {
                                    "description": "УнікальнийРеєстраційний номер записуоблікової картки вплатника ЄДДРподатків",
                                    "value": null "2031914098"
                                },
                                }  "edrpou": {
                            }
        "description": "Код ЕДПРОУ",
              },
                        "alternativeOwnerNamevalue": {null
                             "description": "Альтернативне ім'я власника"},
                                "valueeddrun": null{
                        },
            "description": "Унікальний номер запису в ЄДДР",
       "subjectKeyId": {
                            "descriptionvalue": "Ідентифікатор ключа",null
                            "value": "9E 03 BA B2}
 24 4C 3D 02 09 41 08 8E 7E A3 E8 81 CD C6 90 58 B5 9B 38 1F 90 98 DC 5D F3 EF 61 8E"}
                        },
                        "issuerKeyIdalternativeOwnerName": {
                            "description": "ІдентифікаторАльтернативне ключаім'я видавцявласника",
                            "value": "20 B4 E4 ED 0D 30 99 8C BE 30 6A 07 7D 69 9A 32 73 23 8A E9 09 08 71 D6 16 37 0E 18 E5 76 D4 7F"
 null
                        },
                        "subjectKeyId": {
                            "description": "Ідентифікатор }ключа",
                            "subjectOwnerIdvalue": {
"9E 03 BA B2 24 4C 3D 02 09 41 08 8E 7E A3 E8 81 CD C6 90 58 B5 9B 38 1F 90 98 DC 5D F3 "description": "Ідентифікатор власника",EF 61 8E"
                            "value": "00"
},
                         },"issuerKeyId": {
                            "certificateProfiledescription": {"Ідентифікатор ключа видавця",
                            "descriptionvalue": "Профіль сертифіката",
                            "value": null20 B4 E4 ED 0D 30 99 8C BE 30 6A 07 7D 69 9A 32 73 23 8A E9 09 08 71 D6 16 37 0E 18 E5 76 D4 7F"
                        },
                        "keyUsagesubjectOwnerId": {
                            "description": "ПризначеняІдентифікатор сертифікатавласника",
                            "value": "Електронний підпис, Невідрікаємість00"
                        },
                        "isTemporarycertificateProfile": {
                            "description": "СтартовийПрофіль сертифіката",
                            "value": "false"null
                        },
                        "isReinforcedkeyUsage": {
                            "description": "ПосиленийПризначення сертифіката",
                            "value": "trueЕлектронний підпис, Невідрікаємість"
                        },
                        "isQualifiedisTemporary": {
                            "description": "КваліфікованийСтартовий",
                            "value": "truefalse"
                        },
                        "isPrivateKeyOnQSCDisReinforced": {
                            "description": "Засіб КЕППосилений",
                            "value": "falsetrue"
                        },
                        "isQualified": {
                        "qscdTypeName": {
    "description": "Кваліфікований",
                            "value": "true"
               "description": "Тип засобу КЕП",
      },
                       "value": null
						},
						"isElectronicStamp" "isPrivateKeyOnQSCD": {
                            "description": "ЕлектроннаЗасіб печаткаКЕП",
                            "value": "false"
                        },
                    }    "qscdTypeName": {
                }            "description": "Тип засобу КЕП",
            }
        }
    ]
}
Пример кода на JavaScript + jQuery 2.2.4
Code Block
languagejs
$.ajax({
    url"value": "https://local.cipher.kiev.ua:9090/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/ds/verifier",
    type: "GET",
    dataType: "json",
    cache: false
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
    verifyResults = jsonResponse.verifyResults;
}).fail(function (xhr) {
    try {
null
						},
						"isElectronicStamp" : {
                            "description": "Електронна печатка",
                            "value": "false"
                     var jsonResponse = JSON.parse(xhr.responseText); }
        message = jsonResponse.message;
        failureCause = jsonResponse.failureCause; }
        verifyResults = jsonResponse.verifyResults;
    } catch (e) {}
        message = (xhr.responseText == undefined)}
 ? "Ошибка при получении результата проверки ЭП." : xhr.responseText;}
    }]
})