`irmajs` is a Javascript client of the RESTful JSON API offered by the [`irma server`](https://github.com/privacybydesign/irmago/tree/master/irma). It allows you to use the `irma server` to:
Last updated 13 days ago by sringers .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @privacybydesign/irmajs 
SYNC missed versions from official npm registry.


irmajs is a Javascript client of the RESTful JSON API offered by the irma server. It allows you to use the irma server to:

  • Verify IRMA attributes. You specify which attributes, the library handles the user interaction and the communication with the irma server and the IRMA app).
  • Issue IRMA attributes.
  • Create IMRA attribute-based signatures: signature on a string to which IRMA attributes are verifiably attached.

irmajs supports all major browsers (Firefox, Chrome, Safari, Edge, Internet Explorer 11).


Technical documentation of irmajs can be found at irma.app/docs.


Compile the library:

npm run build

This writes irma.js to the dist folder, which you can include in your website in a <script> tag

Browser example

If you have included irma.js (e.g. <script src="irma.js" defer></script>) you can start an IRMA disclosure session as follows:

const request = {
    'type': 'disclosing',
    'content': [{
        'label': 'Over 18',
        'attributes': [ 'irma-demo.MijnOverheid.ageLower.over18' ]

irma.startSession(server, request)
    .then(({ sessionPtr, token }) => irma.handleSession(sessionPtr, {server, token}))
    .then(result => console.log('Done', result));

This assumes you have an irma server that is configured to accept unauthenticated session requests listening at the URL indicated by server.

For complete examples, see the examples folder.

Current Tags

  • 0.1.4                                ...           latest (13 days ago)

4 Versions

  • 0.1.4                                ...           13 days ago
  • 0.1.3                                ...           3 months ago
  • 0.1.2                                ...           3 months ago
  • 0.1.0                                ...           4 months ago
Maintainers (1)
Today 0
This Week 0
This Month 19
Last Day 0
Last Week 0
Last Month 3
Dependencies (7)
Dev Dependencies (18)
Dependents (0)

Copyright 2014 - 2016 © taobao.org |