Terms and Conditions accepted event

1. About the event

This event is sent when a user has accepted terms and conditions for a BankID service. The event is emitted after a successful approval through the terms and conditions API.

2. Types

no.bankid.user.agreement.v1

3. Definitions

Terms and conditions accepted event

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Data Schema for no.bankid.user.agreement.v1",
  "type": "object",
  "properties": {
    "issuer": {
      "type": "string",
      "description": "Originator, issuing bank number",
      "pattern": "[0-9]{4}",
      "examples": [
        "1830"
      ]
    },
    "agreementId": {
      "type": "string",
      "description": "Composite identifier for the agreement: <agreementType>-<agreementVersion>",
      "examples": [
        "bankid-agreement-2022-05-18.1"
      ]
    },
    "agreementType": {
      "type": "string",
      "description": "The type of agreement",
      "examples": [
        "bankid-agreement"
      ]
    },
    "agreementVersion": {
      "type": "string",
      "description": "The version of the agreement",
      "examples": [
        "2022-05-18.1"
      ]
    },
    "time": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp of the approval in UTC",
      "examples": [
        "2024-01-15T09:30:00Z"
      ]
    },
    "idType": {
      "type": "string",
      "enum": [
        "nnin",
        "subject_id"
      ],
      "description": "Type of user identifier"
    },
    "idValue": {
      "type": "string",
      "description": "The actual identifier value corresponding to idType. Norwegian national identity number when idType is nnin.",
      "examples": [
        "01018011345"
      ]
    },
    "correlationIds": {
      "type": "object",
      "description": "Correlation identifiers for tracing. Keys may be absent if not available.",
      "properties": {
        "tokenId": {
          "type": "string",
          "description": "JWT jti claim from the access token"
        },
        "keyId": {
          "type": "string",
          "description": "DPoP cnf.jkt thumbprint"
        },
        "azureRef": {
          "type": "string",
          "description": "Azure Front Door reference from x-azure-ref header"
        }
      }
    }
  },
  "required": [
    "issuer",
    "agreementId",
    "agreementType",
    "agreementVersion",
    "time",
    "idType",
    "idValue",
    "correlationIds"
  ]
}

Identifier Type (idType) Values

The idType field indicates the type of user identifier provided:

nnin: Norwegian national identity number (11 digits)
subject_id: An opaque subject identifier

Example: Approval with NNIN

{
  "issuer": "1830",
  "agreementId": "bankid-agreement-2022-05-18.1",
  "agreementType": "bankid-agreement",
  "agreementVersion": "2022-05-18.1",
  "time": "2024-01-15T09:30:00Z",
  "idType": "nnin",
  "idValue": "01018011345",
  "correlationIds": {
    "tokenId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
    "keyId": "NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs",
    "azureRef": "0HM4AAAAAABCRPD..."
  }
}

Example: Approval with subject_id

{
  "issuer": "1830",
  "agreementId": "bankid-agreement-2022-05-18.1",
  "agreementType": "bankid-agreement",
  "agreementVersion": "2022-05-18.1",
  "time": "2024-01-15T09:30:00Z",
  "idType": "subject_id",
  "idValue": "sub-abc123-def456",
  "correlationIds": {
    "tokenId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
    "keyId": "NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs"
  }
}