BankID

This element allows signing and identification using BankID services.

Requirements for production environment

  • BankID agreement
  • SSL Certificate
  • Issuer certificate

Configuration

In ‘BankID.json’ file located in XT /bin/config folder you can:

  • define production and test URL for BankID services
  • set test mode on/off

Element properties

Here is the list of BankID element attributes

AttributeDescriptionDefaultExample
idThe elements id. It will be used to access internal fields of the component"id":"mybankid"
typeElement’s type must be “bankid”"type":"bankid"
actionThe action to run when signing/identification is succesfull. Response fields (completionData) from BankID service may be used as parameters inside the action.<action>
modeAuthorization or signing: auth / sign“sign”"sign":"auth"

Internal fields

Before signing

Set ‘userData’ field with text that will be shown to the user, example: "mybankid.userData": "'Your transaction\\nDocument: ' + document + '\\nInvoice: ' + invoice + '\\nCustomer: ' + customer"

After successful signing

The fields from succesful signing are accessed using the ‘completionData’ field: "mybankid.completionData.<field-name>" The completion data field has the following fields (see BankID documentation for more info and latest list) :

  • user
    • perosnalNumber
    • name
    • givenName
    • surname
  • device
    • ipAddress
  • cert
    • notBefore
    • notAfter
  • signature
  • ocspResponse

Example

{ "id": "mybankid", "type": "bankid", "action": {
    "method": "onSignMethod.sign",
    "params": {
        "customer": "mybankid.completionData.user"
    }
}}