API Versions
The Web PKI provides an API version requirement parameter, in case the developer intends to use a specific feature set and avoid any unnecessary update on the user Web PKI components.
In order to do so, use the requiredApiVersion parameter on init() method, e.g.:
pki.init({
ready: onWebPkiReady,
requiredApiVersion: pki.apiVersions.v1_2
});
In the example above, we defined that we are going to use the feature set of API 1.2 (and lower), thus any Web PKI component update will only be required for users with lower versions than the ones defined by API 1.2. No unnecessary update will be required for users with satisfying versions, even though it is not the latest one.
If the parameter is not set, the default requested version is API 1.3.
API changelog
1.8.8 (2026-11-06)
Since lib 2.20.0. Requires native components 2.17.0 (Windows, macOS, Linux).
- Add
nomeSocialandisSeloEletronicotoPkiBrazilModel - Add the ICP-Brasil certificate types
SE_S,SE_H,AE_SandAE_H(CG ICP-Brasil Resolution 211/2024) toCertificateTypes - Read
cpfandcnpjfrom the subject DN's serialNumber (OID 2.5.4.5) when present; electronic seal certificates haveisPessoaJuridicatrue andresponsavelnull
1.8.7 (2026-10-17)
Since lib 2.19.0. Requires native components 2.15.0 (Windows, macOS, Linux).
- Require a valid license (outside localhost) for
showFolderBrowser,showFileBrowser,downloadToFolder,openFile,openFolder,listTokensandencrypt - Sanitize the file names given to
downloadToFolder; files with an executable, script or installer extension are saved as.bin
1.8.6 (2026-02-03)
Since lib 2.18.0. Requires native components 2.14.0 (Windows, macOS, Linux).
- Add
userNameandmachineNametoGenerateKeyPairResponseandGenerateTokenKeyPairResponse - Add support for the
caCertificatesoption ofimportCertificateandimportTokenCertificateon macOS and Linux
1.8.5 (2026-01-26)
Since lib 2.17.0. Requires Windows native component 2.13.2.
- Add the
caCertificatesoption toimportCertificateandimportTokenCertificate, which also imports the CA certificate chain into the system CA store and into the token or PFX file (Windows only)
1.8.4 (2025-11-10)
Since lib 2.16.5. Requires Windows native component 2.12.7.
- Require .NET Framework 4.6 or later on Windows (previously 4.0)
1.8.3 (2025-10-02)
Since lib 2.16.4. Requires Windows native component 2.12.6 and macOS native component 2.13.5.
- Treat
*.localhostdomains (RFC 6761) as localhost, so they can use Web PKI without a license (Windows and macOS) - Fix
importCertificateon Windows failing when an unrelated key container could not be opened, and fix saving its PKCS#12 (PFX) backup - Fix
listCertificateson macOS failing entirely when a PKCS#11 token cannot be read
1.8.2 (2023-11-23)
Since lib 2.16.3.
- Improve method
importCertificatesupporting multiple calls
1.8.1 (2022-12-17)
- Add methods encrypt and decrypt
- Add Extended Key Usage info to CertificateModel
- Add parameter
nonExportableKeyon method generateSoftwareRsaKeyPair
1.7.2 (2022-07-03)
- Add support to unrestricted size native responses
- Add CertificateModel international PKI fields:
PkiArgentinaModel,PkiEcuadorModel,PkiParaguayModel,PkiPeruModel - Add CertificateModel fields:
certificatePolicies,subjectDN,issuerDN
1.6.1 (2020-05-23)
- Add
downloadToFolder* command with TLS 1.2 forced support
1.6 (2019-10-13)
- Add methods
keySignDataandkeySignHashfor signing with a generated private key Id. - Add
privateKeyIdparameter to the generate key pair response:GenerateKeyPairResponse - Fix bug on
sendAuthenticatedRequestresponse payload when it comes without content length header property.
1.5.2 (2019-07-19)
- Add option for returning the signed document content on local signature commands without the 1MB size limit:
returnContent - Add certificate validation levels on local signature commands:
CertificateValidationLevels - Add vertical and horizontal direction control on PAdES (PDF) visual representation:
PadesVisualAutoPositioning - Add native app life cycle control on
initmethod:useDomainNativePool
1.5 (2018-11-27)
- Add more efficient batch signature command:
signHashBatch - Add license v3
- Add mobile integration
1.4.1 (2018-06-15)
- Fix
sendAuthenticatedRequest* empty buffer bug
1.4 (2018-02-23)
- Add XML local signature features:
- Add authenticated request feature:
- Add user error message field on exception object:
1.3 (2017-11-10)
- Add improved error handler with exception model
1.2 (2017-06-19)
- Add local store and PKCS#11 certificate generation features:
1.1 (2016-08-19)
- Add license v2
- Add local signature features:
- Add PAdES local signature features:
- Add CAdES local signature features:
1.0 (2015-04-28)
- Add basic features:
- Add sign batch feature:
- Add download and directory selection features:
- Add RestPKI sign integration:
* Methods supported only on Windows. For more information see Web signatures article.