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

Acronym	Description
BIDJSERVER	BankID Java Server
CA	Certification Authority
COI	Common Operational Infrastructure
CP	Certificate Policy
CPS	Certification Practice Statement
CRL	Certificate Revocation List
DN	Distinguished Name
DNS	Domain Name System
FIPS	Federal Information Processing Standard
HAT	HSM Activation Tool
HSM	Hardware Security Module
JAR	Java Archive
JVM	Java Virtual Machine
MGMFE	Mobile Gateway Merchant Front End
OCSP	Online Certificate Status Protocol
ODS	Order Distribution System
PAdES	PDF Advanced Electronic Signature, restrictions and extentions to PDF and ISO 32000-1 standard regarding electronic signatures, EU regulation 910/2014 (eiDAS)
PIN	Personal Identification Number
PKCS#11	Public Key Cryptography Standards #11
PKI	Public Key Infrastructure
PSE	Personal Security Environment
RA	Registration Authority
RNG	Random Number Generator
SDM	Session Data Manager
SDO	Signed Data Object
SEID	Samarbeidsprosjekt om eID og eSignatur
SSL	Secure Sockets Layer
TLS	Transport Layer Security
URI	Uniform Resource Identifier
VA	Validation Authority

Referenced documents

Document Type	Name	Reference
Implementation	BankID Implementation Guide	[IMPL]
Implementation	BankID Web-client Implementation Guide	[IMPLW]
User-guide	BankID Activation Tool User Guide	[HAT]
Upgrade Guide	BankID Upgrade Guide BankID J Server	[UGJSRV]

Browser not supported