WizePass TypeScript Library

TypeScript client for WizePass API – enrolment, authentication, signing, revoke & more.

Requirements

• Node.js 18, 20, 22, or 24+
• npm 9+
• WizePass Enrolment service v3.0.0+
• WizePass Relying party service v3.0.0+

Installation

npm install wizepass-ts

Getting Started

Configure the connection:

import { configManager } from 'wizepass-ts'

configManager.setConfig({
  apiUrl: 'https://api.wizepass.com',
  instanceId: '0',
  esId: 'your-es-id'
  // key/cert for backend (optional)
})

Enrolment Example

import { enrol, EnrolmentRequestInput } from 'wizepass-ts'

const enrolmentRequest: EnrolmentRequestInput = {
  user_attributes: {
    common_name: ['Kalle Testare'],
    given_name: ['Kalle'],
    surname: ['Testare'],
    user_id: ['kate'],
    email_address: ['[email protected]']
  },
  tags: [
    {
      key: 'description',
      value: 'This is the description tag',
      input_source: 'USER',
      required: false,
      allow_change: true,
      hidden: false
    }
  ],
  enroler_sub: 'Mr enrolment officer',
  user_id: 'kate'
}

const result = await enrol(enrolmentRequest)
console.log(result) // { deepLink, token }

Authentication Example

import { startAuthRequest, AuthRequest } from 'wizepass-ts'

const authRequest: AuthRequest = {
  rp_id: 'your-rp-id',
  visible_tbs: 'Authentication request from WizePass-TS',
  hidden_tbs: 'Hidden info',
  user_id: 'kate',
  requested_content: ['USER_PHOTO'],
  requested_attributes: [
    'CERT_INFO',
    'COMMON_NAME',
    'BASIC_PROFILE',
    'EMAIL_ADDRESS'
  ]
}

const result = await startAuthRequest(authRequest)
console.log(result) // { deepLink, token }

Signing Example

import { startSignRequest, SignRequest } from 'wizepass-ts'

const signRequest: SignRequest = {
  rp_id: 'your-rp-id',
  visible_tbs: 'Signing request from WizePass-TS',
  hidden_tbs: 'Document ID',
  user_id: 'kate',
  requested_content: ['USER_PHOTO'],
  requested_attributes: [
    'CERT_INFO',
    'COMMON_NAME',
    'BASIC_PROFILE',
    'EMAIL_ADDRESS',
    'ORGANIZATION_NAME'
  ]
}

const result = await startSignRequest(signRequest)
console.log(result) // { deepLink, token }

Status & Cancel Examples

import {
  enrolmentStatus,
  cancelEnrolment,
  getAuthStatus,
  cancelAuthRequest,
  getSignStatus,
  cancelSignRequest
} from 'wizepass-ts'

// Enrolment status
const status = await enrolmentStatus('token', 'userId')
// Cancel enrolment
await cancelEnrolment('token', 'userId')

// Auth status
const authStatus = await getAuthStatus('token', 'userId')
// Cancel auth
await cancelAuthRequest('token', 'userId')

// Sign status
const signStatus = await getSignStatus('token', 'userId')
// Cancel sign
await cancelSignRequest('token', 'userId')

Revoke Example

import { revoke, RevokeRequest } from 'wizepass-ts'

const revokeRequest: RevokeRequest = {
  wizepass_id: 'your-wizepass-id',
  revoke_comment: 'privilege_withdrawn',
  revoker_sub: 'Mr enrolment officer'
}

await revoke(revokeRequest)

Error Handling

All methods throw errors with status, error_code, and message properties for easy debugging.

API Reference

Full API documentation – coming in future!