Перейти до основного вмісту

Отримати інформацію про ключ

URI: /api/v1/key/:serial

Метод використовується для отримання інформації про ключ ЕЦП.

Запит виконується методом GET у json форматі.

⚠️ Запит повинен містити заголовок Accept: application/json

Параметри URI​

Для пошуку ключа необхідно передати в запиті один з наступних параметрів:

  • serial — серійний номер сертифіката ЕЦП;
  • drfo — реєстраційний номер облікової картки платника податків;
  • uuid — унікальний ідентифікатор ключа ЕЦП;
  • public_key — відкритий ключ, який використовується для перевірки електронного підпису.

Приклад запиту​

/api/v1/key/58E2D9E7F900307B040000000CAB2500DA8A7A00

Параметри відповіді​

Ім'яТипОпис
uuidstringУнікальний ідентифікатор ключа ЕЦП
certslist[object]Містить файли сертифіката, які були додані при завантаженні ключа ЕЦП на сервер
certs.original_namestringОригінальна назва файлу сертифіката
certs.namestringВнутрішня назва файлу сертифіката
certs.contentstringЗміст файлу сертифіката
serialstringСерійний номер сертифіката
public_keystringВідкритий ключ, який використовується для перевірки електронного підпису
drfostringРеєстраційний номер облікової картки платника податків
infoobjectМістить всю інформацію, яка наявна в сертифікаті
info.isFilledbooleanВідмітка про заповненість сертифіката
info.versionintegerВерсія структури з сертифікатом
info.issuerstringРеквізити ЦСК, що видав сертифікат
info.issuerCNstringІм'я ЦСК, що видав сертифікат
info.serialstringСерійний номер сертифіката
info.subjectstringРеквізити власника сертифіката
info.subjCNstringІм'я власника сертифіката
info.subjOrgstringОрганізація до якої належить власник сертифіката
info.subjOrgUnitstringПідрозділ організації до якої належить власник сертифіката
info.subjTitlestringПосада власника сертифіката
info.subjStatestringНазва області до якої належить власник сертифіката
info.subjLocalitystringНазва населеного пункту до якого належить власник сертифіката
info.subjFullNamestringПовне ім'я власника сертифіката
info.subjAddressstringАдреса власника сертифіката
info.subjPhonestringНомер телефона власника сертифіката
info.subjEMailstringE-mail власника сертифіката
info.subjDNSstringDNS-ім`я технічного засобу
info.subjEDRPOUCodestringКод ЕДРПОУ власника сертифіката
info.subjDRFOCodestringКод ДРФО власника сертифіката
info.subjNBUCodestringІдентифікатор НБУ власника сертифіката
info.subjSPFMCodestringІдентифікатор СПФМ власника сертифіката
info.subjOCodestringКод організації власника сертифіката
info.subjOUCodestringКод підрозділу власника сертифіката
info.subjUserCodestringКод користувача власника сертифіката
info.certBeginTimestringЧас введення сертифіката в дію в форматі MM.DD.YYYY HH:ii:ss
info.certEndTimestringЧас закінчення дії сертифіката в форматі MM.DD.YYYY HH:ii:ss
info.isPrivKeyTimesAvailbooleanОзнака наявності строку дії особистого ключа
info.privKeyBeginTimestringЧас введення в дію особистого ключа в форматі MM.DD.YYYY HH:ii:ss
info.privKeyEndTimestringЧас виведення з дії особистого ключа в форматі MM.DD.YYYY HH:ii:ss
info.publicKeyBitsintegerДовжина відкритого ключа в бітах
info.publicKeystringВідкритий ключ у вигляді строки
info.publicKeyIDstringІдентифікатор відкритого ключа у вигляді строки
info.issuerPublicKeyIDstringІдентифікатор відкритого ключа ЦСК у вигляді строки
info.keyUsagestringВикористання ключів у вигляді строки
info.extKeyUsagesstringУточнене призначення ключів
info.policiesstringПравила сертифікації
info.crlDistribPoint1stringТочка доступу до повних СВС
info.crlDistribPoint2stringТочка доступу до часткових СВС
info.isPowerCertbooleanОзнака того, що сертифікат посилений
info.isSubjTypeAvailbooleanОзнака наявності типу власника сертифіката
info.isSubjCAbooleanОзнака того, що власник сертифікату ЦСК
info.chainLengthbooleanОбмеження на довжину ланцюжка сертифікатів
info.UPNstringUPN-ім`я власника сертифіката
info.publicKeyTypeintegerТип відкритого ключа
info.keyUsageTypeintegerТип використання ключів
info.RSAModulstringМодуль RSA у вигляді строки
info.RSAExponentstringЕкспонента RSA у вигляді строки
info.OCSPAccessInfostringТочка доступу до OCSP-сервера
info.issuerAccessInfostringТочка доступу до сертифікатів
info.TSPAccessInfostringТочка доступу до TSP-сервера
info.isLimitValueAvailablebooleanПризнак наявності обмеження на транзакцію
info.limitValueintegerМаксимальне обмеження на транзакцію
info.limitValueCurrencystringВалюта максимального обмеження на транзакцію
info.subjTypeintegerТип власника сертифіката
info.subjSubTypeintegerПідтип власника сертифіката
info.subjUNZRstringНомер УНЗР власника сертифіката
info.subjCountrystringКод країни власника сертифіката
info.fingerprintstringВідбиток сертифіката
info.isQSCDbooleanОзнака генерації ключа на захищений носій
info.subjUserIDstringІдентифікатор власника сертифіката
created_atstringДата та час завантаження ключа на сервер
updated_atstringДата та час останнього оновлення ключа на сервері
messagestringПовідомлення з текстом помилки

Приклад успішної відповіді​

Успішна операція​

200 OK

Відповідь: /api/v1/key/58E2D9E7F900307B040000000CAB2500DA8A7A00
{
    "uuid": "97210069-f458-41db-9ac2-982c71246257",
    "certs": [
        {
            "original_name": "Тестовий_Олександр_Максимович_(Тест)-8030938.cer",
            "name": "729a2d1b-a1a1-45b3-b61c-3e2c45bba9ee.cer",
            "content": "MIIF7zCCBZegAwIBAgIUWOLZ5/kAMHsEAAAADKslANqKegAwDQYLKoYkAgEBAQEDAQEwgg
            EWMVQwUgYDVQQKDEvQhtC90YTQvtGA0LzQsNGG0ZbQudC90L4t0LTQvtCy0ZbQtNC60L7QstC40Lkg0LTQ
            tdC/0LDRgNGC0LDQvNC10L3RgiDQlNCf0KExXjBcBgNVBAsMVdCj0L/RgNCw0LLQu9GW0L3QvdGPICjRht
            C10L3RgtGAKSDRgdC10YDRgtC40YTRltC60LDRhtGW0Zcg0LrQu9GO0YfRltCyINCG0JTQlCDQlNCf0KEx
            IzAhBgNVBAMMGtCa0J3QldCU0J8gLSDQhtCU0JQg0JTQn9ChMRkwFwYDVQQFDBBVQS00MzE3NDcxMS0yMD
            E5MQswCQYDVQQGEwJVQTERMA8GA1UEBwwI0JrQuNGX0LIwHhcNMTkxMDIyMjEwMDAwWhcNMjExMDIyMjEw
            MDAwWjCB0DFIMEYGA1UEAww/0JzQuNGA0L3QuNC5INCe0LvQtdC60YHQsNC90LTRgCDQnNCw0LrRgdC40L
            zQvtCy0LjRhyAo0KLQtdGB0YIpMRUwEwYDVQQEDAzQnNC40YDQvdC40LkxOzA5BgNVBCoMMtCe0LvQtdC6
            0YHQsNC90LTRgCDQnNCw0LrRgdC40LzQvtCy0LjRhyAo0KLQtdGB0YIpMRAwDgYDVQQFDAcyNDY4NjIwMQ
            swCQYDVQQGEwJVQTERMA8GA1UEBwwI0JrQuNGX0LIwgfIwgckGCyqGJAIBAQEBAwEBMIG5MHUwBwICAQEC
            AQwCAQAEIRC+49tq6p4fhleMRcEllP+UI5Sn1zj5GH5lFQFylPTOAQIhAIAAAAAAAAAAAAAAAAAAAABnWS
            E68YLph9PhdxSQfUcNBCG2D9LY3OipNCPGEBvKkcR6AH5sMAsmzVVsmw59IO8pKgAEQKnW60XxPHCCgMSW
            eyMfXq32WOukwDcpHTjZa/Alyk4X+OlyDcYVtDool18Lwd6jZDi1ZOosF5/QEj5tuPrFeQQDJAAEIQu1LZ
            jSNCKDAmI4O6Q+3548jaJCw6/x9ol1QKqWdpZpAaOCAmcwggJjMCkGA1UdDgQiBCCmsfP/5XB0S/E+TQ8H
            2hWwhjUOyC04goUt1ySdiqtr/DArBgNVHSMEJDAigCDY4tnn+QAwezjycoi0BQLHp7P+ZVKQ6EnCkdBkpz
            OMXDAOBgNVHQ8BAf8EBAMCBsAwGQYDVR0gAQH/BA8wDTALBgkqhiQCAQEBAgIwDAYDVR0TAQH/BAIwADAe
            BggrBgEFBQcBAwEB/wQPMA0wCwYJKoYkAgEBAQIBMB4GA1UdEQQXMBWgEwYKKwYBBAGCNxQCA6AFDAMzOD
            QwSQYDVR0fBEIwQDA+oDygOoY4aHR0cDovL2Fjc2tpZGQuZ292LnVhL2Rvd25sb2FkL2NybHMvQ0EtRDhF
            MkQ5RTctRnVsbC5jcmwwSgYDVR0uBEMwQTA/oD2gO4Y5aHR0cDovL2Fjc2tpZGQuZ292LnVhL2Rvd25sb2
            FkL2NybHMvQ0EtRDhFMkQ5RTctRGVsdGEuY3JsMIGOBggrBgEFBQcBAQSBgTB/MDAGCCsGAQUFBzABhiRo
            dHRwOi8vYWNza2lkZC5nb3YudWEvc2VydmljZXMvb2NzcC8wSwYIKwYBBQUHMAKGP2h0dHA6Ly9hY3NraW
            RkLmdvdi51YS9kb3dubG9hZC9jZXJ0aWZpY2F0ZXMvYWxsYWNza2lkZC0yMDE5LnA3YjA/BggrBgEFBQcB
            CwQzMDEwLwYIKwYBBQUHMAOGI2h0dHA6Ly9hY3NraWRkLmdvdi51YS9zZXJ2aWNlcy90c3AvMCcGA1UdCQ
            QgMB4wHAYMKoYkAgEBAQsBBAEBMQwTCjEwMTAxMDEwMTcwDQYLKoYkAgEBAQEDAQEDQwAEQKomQkF0qEE+
            gxG+26nTe8FTFdBofQg9BIsSBoY3lQdOXzROqenvPO2Pt7kOHsUA3TwkIWqo/VF2igSNLl9gH3s="
        },
        {
            "original_name": "Тестовий_Олександр_Максимович_(Тест)-8030939.cer",
            "name": "e6300425-25fd-4240-862a-bd0644a3076c.cer",
            "content": "MIIGTzCCBfegAwIBAgIUWOLZ5/kAMHsEAAAADKslANuKegAwDQYLKoYkAgEBAQEDAQEwgg
            EWMVQwUgYDVQQKDEvQhtC90YTQvtGA0LzQsNGG0ZbQudC90L4t0LTQvtCy0ZbQtNC60L7QstC40Lkg0LTQ
            tdC/0LDRgNGC0LDQvNC10L3RgiDQlNCf0KExXjBcBgNVBAsMVdCj0L/RgNCw0LLQu9GW0L3QvdGPICjRht
            C10L3RgtGAKSDRgdC10YDRgtC40YTRltC60LDRhtGW0Zcg0LrQu9GO0YfRltCyINCG0JTQlCDQlNCf0KEx
            IzAhBgNVBAMMGtCa0J3QldCU0J8gLSDQhtCU0JQg0JTQn9ChMRkwFwYDVQQFDBBVQS00MzE3NDcxMS0yMD
            E5MQswCQYDVQQGEwJVQTERMA8GA1UEBwwI0JrQuNGX0LIwHhcNMTkxMDIyMjEwMDAwWhcNMjExMDIyMjEw
            MDAwWjCB0DFIMEYGA1UEAww/0JzQuNGA0L3QuNC5INCe0LvQtdC60YHQsNC90LTRgCDQnNCw0LrRgdC40L
            zQvtCy0LjRhyAo0KLQtdGB0YIpMRUwEwYDVQQEDAzQnNC40YDQvdC40LkxOzA5BgNVBCoMMtCe0LvQtdC6
            0YHQsNC90LTRgCDQnNCw0LrRgdC40LzQvtCy0LjRhyAo0KLQtdGB0YIpMRAwDgYDVQQFDAcyNDY4NjIwMQ
            swCQYDVQQGEwJVQTERMA8GA1UEBwwI0JrQuNGX0LIwggFRMIIBEgYLKoYkAgEBAQEDAQEwggEBMIG8MA8C
            AgGvMAkCAQECAQMCAQUCAQEENvPKQMZppNoXMUnKEsMtrhhrU6xrxjZZl96urorS2Ij5v9U0AWlO+cQnPY
            z+bcKPcGoPSRDOAwI2P///////////////////////////////////ujF1RYAJqMCnJPAvgaqKH8uvgNkM
            epURBQTPBDZ8hXyUxUM7/ZkeF8ImhAZYUKmiSe17wkmuWk6Hhon4cu961SQILsMDjprt57proTOB2Xm6Yh
            oEQKnW60XxPHCCgMSWeyMfXq32WOukwDcpHTjZa/Alyk4X+OlyDcYVtDool18Lwd6jZDi1ZOosF5/QEj5t
            uPrFeQQDOQAENpg6BXEIea7w+OXRZH60fb4xG6mJFDf+UaNG3CxwpBTDSSxQXf3Mmm5GhEmxbmk1MBDs7c
            2EcaOCAmcwggJjMCkGA1UdDgQiBCDYthRSmBW9ng2IoLIqs/UxjQUUDniV1KUpZ9VKujpT8zArBgNVHSME
            JDAigCDY4tnn+QAwezjycoi0BQLHp7P+ZVKQ6EnCkdBkpzOMXDAOBgNVHQ8BAf8EBAMCAwgwGQYDVR0gAQ
            H/BA8wDTALBgkqhiQCAQEBAgIwDAYDVR0TAQH/BAIwADAeBggrBgEFBQcBAwEB/wQPMA0wCwYJKoYkAgEB
            AQIBMB4GA1UdEQQXMBWgEwYKKwYBBAGCNxQCA6AFDAMzODQwSQYDVR0fBEIwQDA+oDygOoY4aHR0cDovL2
            Fjc2tpZGQuZ292LnVhL2Rvd25sb2FkL2NybHMvQ0EtRDhFMkQ5RTctRnVsbC5jcmwwSgYDVR0uBEMwQTA/
            oD2gO4Y5aHR0cDovL2Fjc2tpZGQuZ292LnVhL2Rvd25sb2FkL2NybHMvQ0EtRDhFMkQ5RTctRGVsdGEuY3
            JsMIGOBggrBgEFBQcBAQSBgTB/MDAGCCsGAQUFBzABhiRodHRwOi8vYWNza2lkZC5nb3YudWEvc2Vydmlj
            ZXMvb2NzcC8wSwYIKwYBBQUHMAKGP2h0dHA6Ly9hY3NraWRkLmdvdi51YS9kb3dubG9hZC9jZXJ0aWZpY2
            F0ZXMvYWxsYWNza2lkZC0yMDE5LnA3YjA/BggrBgEFBQcBCwQzMDEwLwYIKwYBBQUHMAOGI2h0dHA6Ly9h
            Y3NraWRkLmdvdi51YS9zZXJ2aWNlcy90c3AvMCcGA1UdCQQgMB4wHAYMKoYkAgEBAQsBBAEBMQwTCjEwMT
            AxMDEwMTcwDQYLKoYkAgEBAQEDAQEDQwAEQF8T0GreEmL5xhLo0Puyvau7zKgnYBocKoy6n5Z1+zAAo4Yo
            HsoxGTioDOuOO4+az7MEsJsmw3jNfce837bpFBw="
        }
    ],
    "serial": "58E2D9E7F900307B040000000CAB2500DA8A7A00",
    "public_key": "a6b1f3ffe570744bf13e4d0f07da15b086350ec82d3882852dd7249d8aab6bfc",
    "drfo": "1010101017",
    "info": {
        "isFilled": true,
        "version": 8,
        "issuer": "O=Інформаційно-довідковий департамент ДПС;OU=Управління (центр) сертифікації
         ключів ІДД ДПС;CN=КНЕДП - ІДД ДПС;Serial=UA-43174711-2019;C=UA;L=Київ",
        "issuerCN": "КНЕДП - ІДД ДПС",
        "serial": "58E2D9E7F900307B040000000CAB2500DA8A7A00",
        "subject": "CN=Тестовий Олександр Максимович (Тест);SN=Тестовий;GivenName=Олександр 
        Максимович (Тест);Serial=2468620;C=UA;L=Київ",
        "subjCN": "Тестовий Олександр Максимович (Тест)",
        "subjOrg": "",
        "subjOrgUnit": "",
        "subjTitle": "",
        "subjState": "",
        "subjLocality": "Київ",
        "subjFullName": "Тестовий Олександр Максимович (Тест)",
        "subjAddress": "",
        "subjPhone": "",
        "subjEMail": "",
        "subjDNS": "",
        "subjEDRPOUCode": "",
        "subjDRFOCode": "1010101017",
        "subjNBUCode": "",
        "subjSPFMCode": "",
        "subjOCode": "",
        "subjOUCode": "",
        "subjUserCode": "",
        "certBeginTime": "10.23.2019 00:00:00",
        "certEndTime": "10.23.2021 00:00:00",
        "isPrivKeyTimesAvail": false,
        "privKeyBeginTime": "10.23.2019 00:00:00",
        "privKeyEndTime": "10.23.2021 00:00:00",
        "publicKeyBits": 264,
        "publicKey": "0B B5 2D 98 D2 34 22 83 02 62 38 3B A4 3E DF 9E 3C 8D A2 42 C3 AF F1 F6 89
         75 40 AA 96 76 96 69 01 ",
        "publicKeyID": "A6 B1 F3 FF E5 70 74 4B F1 3E 4D 0F 07 DA 15 B0 86 35 0E C8 2D 38 82 85 
        2D D7 24 9D 8A AB 6B FC ",
        "issuerPublicKeyID": "D8 E2 D9 E7 F9 00 30 7B 38 F2 72 88 B4 05 02 C7 A7 B3 FE 65 52 90 
        E8 49 C2 91 D0 64 A7 33 8C 5C ",
        "keyUsage": "ЕЦП, Неспростовність",
        "extKeyUsages": "",
        "policies": "Правила посиленої сертифікації",
        "crlDistribPoint1": "http://acskidd.gov.ua/download/crls/CA-D8E2D9E7-Full.crl",
        "crlDistribPoint2": "http://acskidd.gov.ua/download/crls/CA-D8E2D9E7-Delta.crl",
        "isPowerCert": true,
        "isSubjTypeAvail": true,
        "isSubjCA": false,
        "chainLength": false,
        "UPN": "384",
        "publicKeyType": 1,
        "keyUsageType": 3,
        "RSAModul": "",
        "RSAExponent": "",
        "OCSPAccessInfo": "http://acskidd.gov.ua/services/ocsp/",
        "issuerAccessInfo": "http://acskidd.gov.ua/download/certificates/allacskidd-2019.p7b",
        "TSPAccessInfo": "http://acskidd.gov.ua/services/tsp/",
        "isLimitValueAvailable": false,
        "limitValue": 0,
        "limitValueCurrency": "",
        "subjType": 4,
        "subjSubType": 0,
        "subjUNZR": "",
        "subjCountry": "UA",
        "fingerprint": "",
        "isQSCD": false,
        "subjUserID": ""
    },
    "created_at": "2021-05-28T13:20:15.000000Z",
    "updated_at": "2021-05-28T13:20:15.000000Z"
}

Приклад неуспішної відповіді​

Ключ не знайдено​

404 Not Found

Відповідь: /api/v1/key/58E2D9E7F900307B040000000CAB2500DA8A7A00
{
    "message": "Key not found"
}