Skip to main content

BankID client for Python

Project description Documentation Status

PyBankID is a client for performing BankID signing.

The Swedish BankID solution for digital signing uses a SOAP connection solution, and this module aims at providing a simplifying client for making authentication, signing and collect requests to the BankID servers.

For more details about BankID implementation, see the official documentation. There, one can find information about how the BankID methods are defined, how to set up the test environment and obtain the SSL certificate for the test server.

An example web application using PyBankID exists and can be found in deployed state on Heroku.


Since version 0.5.1, PyBankID depends on `Zeep <>`_ instead of `suds-jurko <>`_.

PyBankID can be installed though pip:

pip install pybankid

The remedy to the InsecurePlatformWarning problem detailed below ( Python 2, urllib3 and certificate verification), you can install pybankid with the security extras:

pip install pybankid[security]

This installs the pyopenssl, ndg-httpsclient and pyasn1 packages as well. This does however require the installation of some additional system packages:

sudo apt-get install build-essential libssl-dev libffi-dev python-dev

See the cryptography package’s documentation for details.


First, create a BankIDClient:

>>> from bankid import BankIDClient
>>> client = BankIDClient(certificates=('path/to/certificate.pem',

Connection to production server is the default in the client. If test server is desired, send in the test_server=True keyword in the init of the client.

A sign order is then placed by

>>> client.sign(user_visible_data="The information to sign.",
{u'autoStartToken': u'798c1ea1-e67a-4df6-a2f6-164ac223fd52',
 u'orderRef': u'a9b791c3-459f-492b-bf61-23027876140b'}

and an authentication order is initiated by

>>> client.authenticate(personal_number="YYYYMMDDXXXX")
{u'autoStartToken': u'798c1ea1-e67a-4df6-a2f6-164ac223fd52',
 u'orderRef': u'a9b791c3-459f-492b-bf61-23027876140b'}

The status of an order can then be studied by polling with the collect method using the received orderRef:

>>> client.collect(order_ref="a9b791c3-459f-492b-bf61-23027876140b")
{u'progressStatus': u'OUTSTANDING_TRANSACTION'}
>>> client.collect(order_ref="a9b791c3-459f-492b-bf61-23027876140b")
{u'progressStatus': u'USER_SIGN'}
>>> client.collect(order_ref="a9b791c3-459f-492b-bf61-23027876140b")
{u'ocspResponse': u'MIIHfgoBAKCCB3cw[...]',
 u'progressStatus': u'COMPLETE',
 u'signature': u'PD94bWwgdmVyc2lvbj0[...]',
 u'userInfo': {u'givenName': u'Namn',
              u'ipAddress': u'',
              u'name': u'Namn Namnsson',
              u'notAfter': datetime.datetime(2016, 9, 9, 22, 59, 59),
              u'notBefore': datetime.datetime(2014, 9, 9, 23, 0),
              u'personalNumber': u'YYYYMMDDXXXX',
              u'surname': u'Namnsson'}}

The collect should be used sparingly, as not to burden the server unnecessarily.

Python 2, urllib3 and certificate verification

An InsecurePlatformWarning is issued when using the client in Python 2 (See urllib3 documentation). This can be remedied by installing pybankid with the security extras as described above, or to manually install pyopenssl according to this issue and docstrings in requests.

Optionally, the environment variable PYBANKID_DISABLE_WARNINGS can be set to disable these warnings.


The PyBankID solution can be tested with pytest:

py.test tests/

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pybankid, version 0.5.2
Filename, size File type Python version Upload date Hashes
Filename, size pybankid-0.5.2-py2.py3-none-any.whl (15.5 kB) File type Wheel Python version 3.5 Upload date Hashes View hashes
Filename, size pybankid-0.5.2.tar.gz (11.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page