About this document

This document describes the BankID Java Server Interface. The intention is to describe how merchants install, integrate, configure and interact with BankID Java Server to access the services offered.  It is strongly recommend that the reader is familiar with the contents of the implementation guides [IMPL] and [IMPLW] before addressing this document.

The specifications in this document may be updated in future releases to allow for extended services offered by the BankID Java Server (BIDJSERVER). The interfaces will, when possible, retain backward compatibility.

An extract of the API changes from last version can be found in [UGJSRV]. 

Organisation of this document

This document is organised as follows:

• Section 2 explains what BIDJSERVER is and the files BIDJSERVER depends on.
• Section 3 shows how to integrate BIDJSERVER with merchant applications.
• Section 4 explains how to configure and use BIDJSERVER.
• Section 5 explains how to configure BIDJSERVER to use merchant keys stored in a HSM.
• Section 6 describes the BIDJSERVER API (Application Progamming Interface).
• Section 7 contains a full description of the BIDJSERVER error codes.

Target audience

The target audience of this document are the BankID developers in banks and merchants.

Limitations

This document focuses primarily on how application developers should integrate the BIDJSERVER library. It does not describe the process of applying for BankID certificates, key generation, test and activation of certificates. Neither does it describe the overall BankID infrastructure.

Prerequisites

It is essential that the reader understands the basic functionality of BankID. 

Acronyms

Referenced documents