About this document

This document describes the BankID C Server Interface. It describes how merchants can install, integrate, configure and interact with BankID C Server to access the BankID services. It is recommended 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 in the BankID C Server. The interfaces will, when possible, retain backward compatibility.

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

Organisation of this document

This document is organised as follows:

Section 2 explains how to install BankID C Server.
Section 3 shows how to integrate BankID C Server with merchant applications.
Section 4 explains how to configure BankID C Server.
Section 5 concerns the use of BankID C. Server for authentication and signing, with supplied use cases and code examples.
Section 5.1 describes the use of HSM with BankID C Server.
Section 6 contains a description of the BankID C Server API.
Section 7 lists error codes including a textual explanation of each error code.

Target audience

The target audience for this document is the BankID developers in banks and merchants.

Limitations

This document focuses primarily on how application developers should integrate the BankID C Server library. It does not describe the processes of applying for BankID certificates, key generation, test and activation of certificates. Neither does it describe the overall BankID infrastructure. The BankID client interface description [IDC] is covered in a separate document.

Prerequisites

It is essential that the reader has an understanding of the basic functionality of BankID.

Acronyms

Acronym	Description
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
MGMFE	Mobile Gateway Merchant Frontend
OCSP	Online Certificate Status Protocol
ODS	Order Distribution System
OWF	One Way Function
PIN	Personal Identification Number
PKI	Public Key Infrastructure
PSE	Personal Security Environment
RA	Registration Authority
RNG	Random Number Generator
SDO	Signed Data Object
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	Bank ID Web-client Implementation Guide	[IMPLW]
Interface	BankID Interface Description Client	[IDC]
User Guide	BankID HSM Activation Tool User Guide	[HAT]
Upgrade Guide	BankID Upgrade Guide BankID C Server	[UGCSRV]
Interface	BankID RA Interface Specification	[RAIF] *

Restricted documents
See release notes for the exact location of all of the referenced documents.

Browser not supported