OTP added event

1. About the event

This event is sent when a user has added BankID app as a new HA2 OTP device.
The event is emitted after a successful call to the RA /add endpoint.

2. Types

no.bankid.bapp.otp_added.v1

3. Definitions

3.1 OTP added event

{
  "$schema": "<https://json-schema.org/draft/2020-12/schema>",
  "title": "Data Schema for no.bankid.bapp.otp_added.v1",
  "type": "object",
  "properties": {
    "correlationId": {
      "type": "string",
      "description": "Unique identifier for the BankID app enrollment session. Can be used to correlate other events in context of the same session",
      "examples": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "time": {
      "type": "string",
      "format": "date-time",
      "description": "Time when the OTP was added to the BankID app",
      "examples": [
        "2021-01-01T12:00:00Z"
      ]
    },
    "nnin": {
      "type": "string",
      "format": "integer",
      "pattern": "^[0-9]{11}$",
      "description": "Norwegian national identity number",
      "examples": [
        "01010112345"
      ]
    },
    "originatorId": {
      "type": "string",
      "format": "integer",
      "pattern": "^[0-9]{4}$",
      "description": "Originator, issuing bank number",
      "examples": [
        "9980"
      ]
    },
    "authentication": {
      "type": "object",
      "description": "Identification data for the user",
      "properties": {
        "amr": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bid",
              "bim",
              "idc"
            ]
          },
          "description": "Authentication method used for identification"
        },
        "documentType": {
          "type": "string",
          "enum": [
            "passport",
            "idcard"
          ],
          "description": "Document type used for identification. Empty string if not applicable "
        },
        "documentNumber": {
          "type": "string",
          "description": "Document number used for identification. Empty string if not applicable"
        }
      },
      "required": [
        "amr",
        "documentType",
        "documentNumber"
      ]
    }
  },
  "required": [
    "correlationId",
    "time",
    "nnin",
    "originatorId",
    "authentication"
  ]
}