Validācijas API

Darbības joma
To receive validation data of signed document.

Apraksts

Par norādīto failu tiek atgriezta validācijas informācija;
Ja fails nav parakstīts, tiek atgriezts kļūdas ziņojums.

Pieprasījums
Pakalpojuma sniedzēja lietojumprogramma, izmantojot TLS, nosūta šādu GET pieprasījumu:

GET /api-validation/v1.0/{sessionId}/{documentId}/validate

Paramters	Tips	Lietošana	Apraksts
`sessionId`	Virne (64) (String (64))	Obligāts	Failu apstrādes sesijas identifikators
`documentId`	Virne (64) (String (64))	Obligāts	Document identifier, received from upload or list operation as id property

Autorizācija

Pieprasījumā jāiekļauj Authorization galvene ar OAuth Introspekta piekļuves marķieri (Introspect access token), kas iegūts no e-Identitātes platformas, izmantojot pakalpojumu sniedzēja akreditācijas datu piešķiršanas plūsmu (credentials grant flow).

Piemērs

GET /api-validation/v1.0/965af52843d969ab6011c6ba8effbdc307e26517280566ce18a807f37a9029aa/c97823faa1a54658e75207e1a791da2c/validate HTTP/1.1
Authorization: Bearer a477b3a3366768c07e4c458f518711b4b351e8d2c2f0f78a1524e4d3efd00603
Host: signapi-prep.eparaksts.lv

Atbilde
General structure of validation response (JSON object):

{
    "data": {
        "includedFiles": [
            {
                "filename": {String}
            }
        ],
        "signatureForm": {String},
        "signaturesExt": [
            {
                "id": {String},
                "info": {
                    "bestSignatureTime": {Datetime},
                    "timestampCreationTime": {Datetime},
                    "ocspResponseCreationTime": {Datetime},
                    "timeAssertionMessageImprint": {String},
                    "signingReason": {String},
                    "signerRole": [
                        {
                            "claimedRole": {String}
                        }
                    ],
                    "signatureProductionPlace": {
                        "countryName": {String},
                        "stateOrProvince": {String},
                        "city": {String},
                        "postalCode": {String}
                    }
                },
                "errors": [
                    {
                        "content": {String}
                    }
                ],
                "signedBy": {String},
                "warnings": [
                    {
                        "content": {String}
                    }
                ],
                "indication": {String},
                "subIndication": {String},
                "signatureLevel": {String},
                "signatureFormat": {String},
                "signerSerialNumber": {String},
                "registrationNumber": {String}
            }
        ],
        "validationTime": {Datetime},
        "signaturesCount": {Number},
        "validationLevel": {String},
        "validatedDocument": {
            "filename": {String}
        },
        "validSignaturesCount": {Number}
    }
}

Parametrs	Tips	Apraksts
`includedFiles`	Masīvs (Array)	Informācija par failiem, kas iekļauti ASiC-E konteinerā.
`includedFiles.filename`	Virkne (String)	ASiC-E konteinerā iekļautās kļūmes nosaukums.
`signatureForm`	Virkne (String)	Digitāli parakstīta dokumentu konteinera formāts (un izvēles versija).
`signaturesExt`	Masīvs (Array)	Digitāli parakstītā dokumentā atrodamo parakstu vākšana
`signaturesExt.id`	Virkne (String)	Paraksta ID atribūts
`signaturesExt.info`	Objekts (Object)	Objekts, kurā ir uzticama parakstīšanas laika informācija.
`signaturesExt.info.bestSignatureTime`	Datums	Laika vērtība, kas tiek uzskatīta par uzticamu parakstīšanas laiku, kas apzīmē agrāko laiku, kad validācijas lietojumprogramma var uzticēties (jo to pierāda kāds parakstā esošais esamības pierādījums), ka paraksts ir pastāvējis. Vērtības avots ir atkarīgs no paraksta profila (skatiet arī parametru SignatureFormat): Paraksts ar laika atzīmi (LT_TM līmenis) - parakstā esošās agrākās derīgās laika atzīmes (parakstītāja sertifikāta OCSP apstiprinājuma) producedAt vērtība. Paraksts ar laika zīmogu (LT vai LTA līmenis) - agrākā derīgā paraksta laika zīmoga marķiera vērtība parakstā. Paraksts ar BES vai EPES līmeni - vērtība ir tukša, t. i., nav pieejama uzticama parakstīšanas laika vērtība.
`signaturesExt.signedBy`	Virkne (String)	Paraksta/zīmoga veidotājs. CN (Common Name jeb kopējais nosaukums) vērtība no parakstītāja sertifikāta subjekta atšķirtā nosaukuma (Distinguished Name).
`signaturesExt.errors`	Masīvs (Array)	Informācija par validācijas kļūdu(-ām), kļūdu ziņojumu masīvs.
`signaturesExt.warnings`	Masīvs (Array)	Validācijas brīdinājumu bloķēšana, kas neietekmē vispārējo validācijas rezultātu.
`signaturesExt.indication`	Virkne (String)	Paraksta apstiprināšanas procesa kopējais rezultāts saskaņā ar ETSI EN 319 102-1 "5. tabula: Paraksta validācijas procesa statusa norādes". Ņemiet vērā, ka dažādu parakstu validācijas rezultāti vienā parakstītā dokumentā (parakstu konteinerā) var atšķirties. Iespējamās vērtības: `TOTAL-PASSED` `TOTAL-FAILED` `INDETERMINATE`
`signaturesExt.subindication`	Virkne (String)	Papildu apakšindikācija neveiksmīga vai nenoteikta validācijas rezultāta gadījumā saskaņā ar ETSI EN 319 102-1 "6. tabula: Validācijas ziņojuma struktūra un semantika"
`signaturesExt.signatureLevel`	Virkne (String)	Paraksta juridiskais līmenis saskaņā ar Regulu (ES) Nr.910/2014. Pozitīvā validācijas rezultāta iespējamās vērtības: `QESIG` `QESEAL` `QES` `QES\_EDL` – "ADES_QC" paraksts, kas saskaņā ar Latvijas Elektronisko dokumentu likumu ir pielīdzināms pašrocīgam parakstam. `ADESIG\_QC` `ADESEAL\_QC` `ADES\_QC` `ADESIG` `ADESEAL` `ADES` Iespējamās vērtības nenoteiktam validācijas rezultātam: Prefikss INDETERMINATE tiek pievienots līmenim, kas aprakstīts pozitīvajā rezultātā, piemēram, `INDETERMINATE\_QESIG`. Iespējamās vērtības negatīva validācijas rezultāta gadījumā (papildus iepriekšminētajam): `NOT\_ADES\_QC\_QSCD` `NOT\_ADES\_QC` `NOT\_ADES` `NA`
`signaturesExt.signatureFormat`	Virkne (String)	Paraksta formāts un profils (saskaņā ar bāzes profila profilu). Skatiet XAdES bāzes profila profilu, CAdES bāzes profila profilu un PAdES bāzes profila profilu, lai iegūtu detalizētu bāzes profila līmeņu aprakstu Iespējamās vērtības `XAdES_BASELINE_B` `XAdES_BASELINE_B_BES` `XAdES_BASELINE_B_EPES` `XAdES_BASELINE_T` `XAdES_BASELINE_LT` -ilgtermiņa līmeņa XAdES paraksts, kur laika zīmogs tiek izmantots kā uzticama parakstīšanas laika apliecinājums `XAdES_BASELINE_LT_TM` - ilgtermiņa līmeņa XAdES paraksts, kur laika atzīme tiek izmantota kā uzticama parakstīšanas laika apliecinājums. `XAdES_BASELINE_LTA` `CAdES_BASELINE_B` `CAdES_BASELINE_T` `CAdES_BASELINE_LT` `CAdES_BASELINE_LTA` `PAdES_BASELINE_B` `PAdES_BASELINE_T` `PAdES_BASELINE_LT` `PAdES_BASELINE_LTA`
`signaturesExt.signerSerialNumber`	Virkne (String)	SERIALNUMBER vērtības daļa parakstītāja (fiziskas personas) sertifikāta subjekta atšķirtspējas nosaukumā.
`signaturesExt.registrationNumber`	Virkne (String)	OID 2.5.4.97 (organizationIdentifier) vērtības daļa parakstītāja (juridiskās personas) sertifikāta subjekta atšķirtspējas nosaukumā.
`validationTime`	Datums	Laiks, kad pakalpojums apstiprina parakstu.
`signaturesCount`	Numurs (Number)	Digitāli parakstītā failā atrasto parakstu skaits.
`validSignaturesCount`	Numurs (Number)	Parakstu skaits, kas ir pārbaudīti līdz`TOTAL-PASSED`. Skatīt arī lauku SignatureExt.Indication.
`validationLevel`	Virkne (String)	Pārbaudes process, salīdzinot ar dokumenta pārbaudi, piemērojams tikai uz DSS balstītām pārbaudēm. Iespējamās vērtības: `ARCHIVAL_DATA`
`validatedDocument`	Objekts (Object)	Objekts, kas satur informāciju par pārbaudītu dokumentu.
`validatedDocument.filename`	Virkne (String)	Digitāli parakstīta dokumenta faila nosaukums.

Piemērs

{
    "data": {
        "signatureForm": "ASiC-E",
        "signaturesExt": [
            {
                "id": "S1",
                "info": {
                    "bestSignatureTime": "11.11.2019. 08:32:04"
                },
                "signedBy": "ANDRIS PARAUDZIŅŠ",
                "warnings": [
                    {
                        "content": "Signature warnings here"
                    }
                ],
                "indication": "TOTAL-PASSED",
                "subindication": "subindication details here"
                "signatureLevel": "QESIG",
                "signatureFormat": "XAdES_BASELINE_LT",
                "signerSerialNumber": "PNOLV-324954-21338"
            }
        ],
        "validationTime": "30.12.2019. 06:39",
        "signaturesCount": 1,
        "validationLevel": "ARCHIVAL_DATA",
        "validatedDocument": {
            "filename": "test.edoc"
        },
        "validSignaturesCount": 1
    }
}