KISI Controller Wiegand Connections API

openapi: 3.1.0
info:
  version: 1.0.0
  title: Kisi Calendars Controller Wiegand Connections API
  description: "## Introduction\n\nWelcome to the Kisi API documentation. Before you read further, please read\nthe general [Kisi Docs portal](https://docs.kisi.io/).\n\n<!-- theme: info -->\n> If you want to be notified by email about updates to our API, please subscribe to our\n> [newsletter](https://2e2bc.share.hsforms.com/2OsdqtC8xRHGQ2yaS16AF7w).\n\n### Format\n\nThe Kisi API supports JSON only, so please set `Accept` and `Content-Type`\nto `application/json`. All requests and responses will use JSON as the\nformat for any data encompassed in the body of requests and responses.\n\n```http\n<METHOD> <URL> HTTP/1.1\nAccept: application/json\nContent-Type: application/json\n```\n\n### Authentication\n\nMost calls to the API will require an authenticated user. If such a user\nis not present, you will receive a 401 response.\nFor more information about authentication, see the [Kisi Docs portal](https://docs.kisi.io/api/get_started/add_necessary_headers).\n\nAPI calls must be made using HTTPS. Any calls made over plain HTTP will fail.\n\n### Rate limits\n\nFor authenticated API requests, you can make up to 5 requests per second,\nper user. Note that the limit applies per user, so requests made using\ndifferent logins for the same user share the same quota.\n\nFor unauthenticated requests, you can make up to 5 requests per second, per\nIP address.\n\nThe following endpoints have custom rate limits:\n\n| Endpoint                   | Limit            |\n|----------------------------|------------------|\n| `POST /event_sets`         | 1 per second     |\n| `POST /signed_upload_urls` | 1 per 10 seconds |\n\nIf you exceed the rate limit, a 429 response will be returned.\n\nSome best practices:\n- If you're making requests for a single user, do so serially, *not* concurrently.\n- If you're making a large number of requests for a single user, wait at least one second between each request.\n\nWe reserve the right to change these limits as needed to ensure availability.\n\n### Deprecations\n\nIn the event that some part of the API has to be deprecated, we do the following:\n\n  1. Return the `Deprecation` header with the date of when the endpoint is deprecated.\n  2. Return the `Sunset` header with the date of when the endpoint can be expected to not function anymore.\n  3. When the `Sunset` date is reached, the endpoint may go away at any time.\n\nWe recommend listening to these headers to avoid disruptions.\n\n### Error codes\n\nSome endpoints return an error code and a message. In the table below all error codes are listed.\n\n| Error code | Message                                                                                         |\n|------------|-------------------------------------------------------------------------------------------------|\n| `afc507`   | The authentication link is not valid.                                                           |\n| `afc546`   | Invalid Two Factor backup code.                                                                 |\n| `faa9ff`   | The card is not activated.                                                                      |\n| `faa9ef`   | The card was not found.                                                                         |\n| `afc496`   | Access denied.                                                                                  |\n| `f29aef`   | Your link is invalid.                                                                           |\n| `afc516`   | Wrong email address or password.                                                                |\n| `afc536`   | Invalid Two Factor verification code.                                                           |\n| `afc526`   | Please provide a Two Factor verification code.                                                  |\n| `afc516`   | The two factor pin is invalid                                                                   |\n| `ffffff`   | An unexpected issue occured.                                                                    |\n| `fcd8ef`   | Access denied.                                                                                  |\n| `fcd8ff`   | Access disabled.                                                                                |\n| `cabbeb`   | A card with the same identifiers was already enrolled.                                          |\n| `bb4fff`   | Please authorize Kisi for Bluetooth.                                                            |\n| `bb5bff`   | No nearby Kisi reader found. Try enabling Bluetooth on your device.                             |\n| `bb4bff`   | Please enable Bluetooth.                                                                        |\n| `a7793f`   | Please authorize Kisi for location services.                                                    |\n| `a3799f`   | Please enable your location services.                                                           |\n| `a3793f`   | Please enable your location services.                                                           |\n| `f298cf`   | The place has disabled all links for you.                                                       |\n| `f298df`   | Your access rights for this place do not include links.                                         |\n| `f298bf`   | Your access right is invalid.                                                                   |\n| `f01337`   | Your group's access rights for this place do not include apps.                                  |\n| `34bd8f`   | Your device is not the primary one.                                                             |\n| `facced`   | Unable to decode the certificate.                                                               |\n| `bbb99f`   | Your location is not valid.                                                                     |\n| `bbb93f`   | The location of the lock is invalid.                                                            |\n| `a3995f`   | You are too far away.                                                                           |\n| `bb4faa`   | You're not close enough to the door.                                                            |\n| `bbc93f`   | In-app access is disabled by the organization. Please tap your phone against the reader.        |\n| `34ffaa`   | Your access is not allowed at this moment, please try again later.                              |\n| `f35ade`   | Your access is no longer valid.                                                                 |\n| `f398de`   | Your access is invalid.,                                                                        |\n| `f358de`   | Your access is not yet valid, please try again later.                                           |\n| `fad334`   | An error occurred permitting the the elevator stop.                                             |\n| `fad121`   | The elevator stop was not found.                                                                |\n| `fad122`   | The elevator stop was not configured.                                                           |\n| `fad123`   | The elevator stops are locked down.                                                             |\n| `fad124`   | The elevator stop was on schedule.                                                              |\n| `fad002`   | The place is currently locked down.                                                             |\n| `ff420a`   | The door has no assigned Kisi controller.                                                       |\n| `fad001`   | The door is currently locked down.                                                              |\n| `fad105`   | The door is improperly configured.                                                              |\n| `fad10e`   | The door could not be found.                                                                    |\n| `fad110`   | The door is already scheduled to be unlocked.                                                   |\n| `fad137`   | The access was denied by the zone.                                                              |\n| `fad146`   | The third party zone was overriden but it is still armed.                                       |\n| `fad10f`   | An error occurred connecting to the wireless lock.                                              |\n| `fad106`   | An error occurred finding the wireless lock.                                                    |\n| `fad107`   | The wireless lock is offline.                                                                   |\n| `fad112`   | An unlock is already in progress for the wireless lock.                                         |\n| `fac001`   | The Kisi controller is currently unavailable.                                                   |\n| `fac002`   | The Kisi controller is currently unavailable.                                                   |\n| `fac003`   | The Kisi device is currently unavailable.                                                       |\n| `fac004`   | The Kisi device is currently unavailable.                                                       |\n| `fad108`   | The Kisi controller is not yet configured.                                                      |\n| `ecc123`   | The Kisi controller encountered an unhandled error.                                             |\n| `fbc000`   | The Kisi controller firmware is being updated. This will take a few seconds. Please retry then. |\n| `aaa345`   | The zone has no assigned zone controller.                                                       |\n| `fad126`   | The zone could not be found.                                                                    |\n| `fad129`   | The alarm controller is currently unavailable.                                                  |\n| `adf234`   | An error occurred resetting the zone.                                                           |\n| `fad144`   | The third party alarm is still in violation.                                                    |\n| `abbb11`   | The integration partner experienced an error.                                                   |\n| `abcc11`   | An integration partner resource could not be found.                                             |\n| `abdd11`   | The communication with the integration partner failed.                                          |\n| `abee11`   | Authorization with the integration partner failed.                                              |\n| `abfe11`   | The integration is not acceptable                                                               |\n| `abff11`   | The integration is disabled.                                                                    |\n"
  contact:
    name: Kisi Support
    email: support@getkisi.com
servers:
- url: https://api.kisi.io
  description: Kisi Production
tags:
- name: Controller Wiegand Connections
paths:
  /controller_wiegand_connections:
    get:
      operationId: fetchControllerWiegandConnections
      summary: Fetch controller wiegand connections
      tags:
      - Controller Wiegand Connections
      security:
      - Kisi-Login: []
      - OAuth2: []
      parameters:
      - name: controller_id
        in: query
        schema:
          type: integer
        required: true
        description: Filter by controller ID
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  oneOf:
                  - type: object
                    title: Legacy Reader Connection
                    properties:
                      id:
                        type: integer
                        description: The ID of the controller wiegand connection
                      created_at:
                        type: string
                        format: date-time
                        description: When the controller wiegand connection was created
                      updated_at:
                        type: string
                        format: date-time
                        description: When the controller wiegand connection was updated
                      name:
                        type:
                        - string
                        - 'null'
                        description: The name of the controller wiegand connection
                      controller_wiegand_id:
                        type: integer
                        description: The controller_wiegand ID of the controller wiegand connection
                      controller_wiegand:
                        type: object
                        title: Controller Wiegand
                        description: The controller_wiegand of the controller wiegand connection
                        properties:
                          id:
                            type: integer
                            description: The ID of the controller wiegand
                          channel:
                            type: number
                            description: The channel of the controller wiegand
                          name:
                            type: string
                            description: The name of the controller wiegand
                        required:
                        - id
                        - channel
                        - name
                        additionalProperties: false
                      type:
                        const: legacy_reader
                      lock_id:
                        type:
                        - integer
                        - 'null'
                        description: The lock ID of the controller wiegand connection
                      lock:
                        type: object
                        title: Lock
                        description: The lock of the controller wiegand connection
                        properties:
                          id:
                            type: integer
                            description: The ID of the lock
                          resource_type:
                            type: string
                            description: The resource type of the lock
                            const: Lock
                          name:
                            type: string
                            description: The name of the lock
                        required:
                        - id
                        - resource_type
                        - name
                        additionalProperties: false
                      elevator_id:
                        type:
                        - integer
                        - 'null'
                        description: The elevator ID of the controller wiegand connection
                      elevator:
                        type: object
                        title: Elevator
                        description: The elevator of the controller wiegand connection
                        properties:
                          id:
                            type: integer
                            description: The ID of the elevator
                          resource_type:
                            type: string
                            description: The resource type of the elevator
                            const: Elevator
                          name:
                            type: string
                            description: The name of the elevator
                        required:
                        - id
                        - resource_type
                        - name
                        additionalProperties: false
                    required:
                    - id
                    - created_at
                    - updated_at
                    - name
                    - controller_wiegand_id
                    - controller_wiegand
                    - type
                    - lock_id
                    - elevator_id
                    additionalProperties: false
                  - type: object
                    title: Legacy Controller Connection
                    properties:
                      id:
                        type: integer
                        description: The ID of the controller wiegand connection
                      created_at:
                        type: string
                        format: date-time
                        description: When the controller wiegand connection was created
                      updated_at:
                        type: string
                        format: date-time
                        description: When the controller wiegand connection was updated
                      name:
                        type:
                        - string
                        - 'null'
                        description: The name of the controller wiegand connection
                      controller_wiegand_id:
                        type: integer
                        description: The controller_wiegand ID of the controller wiegand connection
                      controller_wiegand:
                        type: object
                        title: Controller Wiegand
                        description: The controller_wiegand of the controller wiegand connection
                        properties:
                          id:
                            type: integer
                            description: The ID of the controller wiegand
                          channel:
                            type: number
                            description: The channel of the controller wiegand
                          name:
                            type: string
                            description: The name of the controller wiegand
                        required:
                        - id
                        - channel
                        - name
                        additionalProperties: false
                      type:
                        const: legacy_controller
                      virtual_card_format_name:
                        type:
                        - string
                        - 'null'
                        enum:
                        - null
                        - hid_h10301
                        - hid_h10302
                        - hid_h10304
                        - em_410x_26
                        - em_410x_32_34
                        - keyscan_c15001
                        - hid_d10202
                        description: The format of the virtual card.
                      virtual_card_card_number:
                        type:
                        - integer
                        - 'null'
                        description: The card number of the virtual card.
                      virtual_card_card_id:
                        type:
                        - integer
                        - 'null'
                        description: The card id of the virtual card. Only applies to `EM_410X_32_34` cards.
                      virtual_card_oem:
                        type:
                        - integer
                        - 'null'
                        description: The oem of the virtual card. Only applies to `KEYSCAN_C15001` cards.
                      virtual_card_facility_code:
                        type:
                        - integer
                        - 'null'
                        description: The facility code of the virtual card.
                      virtual_card_uid:
                        type:
                        - string
                        - 'null'
                        pattern: ^([0-9a-fA-F]){6,16}$
                        description: The uid of the virtual card.
                      virtual_card_length:
                        type:
                        - integer
                        - 'null'
                        description: The bit length of the virtual card's uid.
                      lock_id:
                        type: integer
                        description: The lock ID of the controller wiegand connection
                      lock:
                        type: object
                        title: Lock
                        description: The lock of the controller wiegand connection
                        properties:
                          id:
                            type: integer
                            description: The ID of the lock
                          resource_type:
                            type: string
                            description: The resource type of the lock
                            const: Lock
                          name:
                            type: string
                            description: The name of the lock
                        required:
                        - id
                        - resource_type
                        - name
                        additionalProperties: false
                    required:
                    - id
                    - created_at
                    - updated_at
                    - name
                    - controller_wiegand_id
                    - controller_wiegand
                    - type
                    - virtual_card_format_name
                    - virtual_card_card_number
                    - virtual_card_card_id
                    - virtual_card_oem
                    - virtual_card_facility_code
                    - virtual_card_uid
                    - virtual_card_length
                    - lock_id
                    - lock
                    additionalProperties: false
                  - type: object
                    title: Legacy Keypad Reader Connection
                    properties:
                      id:
                        type: integer
                        description: The ID of the controller wiegand connection
                      created_at:
                        type: string
                        format: date-time
                        description: When the controller wiegand connection was created
                      updated_at:
                        type: string
                        format: date-time
                        description: When the controller wiegand connection was updated
                      name:
                        type:
                        - string
                        - 'null'
                        description: The name of the controller wiegand connection
                      controller_wiegand_id:
                        type: integer
                        description: The controller_wiegand ID of the controller wiegand connection
                      controller_wiegand:
                        type: object
                        title: Controller Wiegand
                        description: The controller_wiegand of the controller wiegand connection
                        properties:
                          id:
                            type: integer
                            description: The ID of the controller wiegand
                          channel:
                            type: number
                            description: The channel of the controller wiegand
                          name:
                            type: string
                            description: The name of the controller wiegand
                        required:
                        - id
                        - channel
                        - name
                        additionalProperties: false
                      type:
                        const: legacy_keypad_reader
                      master_pin_code:
                        type:
                        - string
                        - 'null'
                        pattern: ^\d+$
                        description: The master pin code of the legacy keypad reader connection.
                      facility_code:
                        type:
                        - integer
                        - 'null'
                        description: The facility code of the keypad reader.
                      keypad_type:
                        type: string
                        enum:
                        - single_key_wiegand_6_bit_rosslare_format
                        - single_key_wiegand_8_bit_nibbles_complemented
                        - four_keys_binary_plus_facility_code_wiegand_26_bit
                        - one_to_five_keys_plus_facility_code_wiegand_26_bit
                        - single_key_wiegand_4_bit
                        description: The type of keypad connected to the wiegand channel.
                      two_factor_enabled:
                        type: boolean
                        description: Whether two factor authentication is enabled
                      lock_id:
                        type:
                        - integer
                        - 'null'
                        description: The lock ID of the controller wiegand connection
                      lock:
                        type: object
                        title: Lock
                        description: The lock of the controller wiegand connection
                        properties:
                          id:
                            type: integer
                            description: The ID of the lock
                          resource_type:
                            type: string
                            description: The resource type of the lock
                            const: Lock
                          name:
                            type: string
                            description: The name of the lock
                        required:
                        - id
                        - resource_type
                        - name
                        additionalProperties: false
                      elevator_id:
                        type:
                        - integer
                        - 'null'
                        description: The elevator ID of the controller wiegand connection
                      elevator:
                        type: object
                        title: Elevator
                        description: The elevator of the controller wiegand connection
                        properties:
                          id:
                            type: integer
                            description: The ID of the elevator
                          resource_type:
                            type: string
                            description: The resource type of the elevator
                            const: Elevator
                          name:
                            type: string
                            description: The name of the elevator
                        required:
                        - id
                        - resource_type
                        - name
                        additionalProperties: false
                    required:
                    - id
                    - created_at
                    - updated_at
                    - name
                    - controller_wiegand_id
                    - controller_wiegand
                    - type
                    - master_pin_code
                    - facility_code
                    - keypad_type
                    - two_factor_enabled
                    - lock_id
                    - elevator_id
                    additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createControllerWiegandConnection
      summary: Create a controller wiegand connection
      tags:
      - Controller Wiegand Connections
      security:
      - Kisi-Login: []
      - OAuth2: []
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                title: Legacy Reader Connection
                properties:
                  controller_wiegand_connection:
                    type: object
                    properties:
                      type:
                        const: legacy_reader
                      controller_wiegand_id:
                        type: integer
                        description: The controller_wiegand ID of the controller wiegand connection
                      lock_id:
                        type:
                        - integer
                        - 'null'
                        description: The lock ID of the controller wiegand connection
                      elevator_id:
                        type:
                        - integer
                        - 'null'
                        description: The elevator ID of the controller wiegand connection
                      name:
                        type:
                        - string
                        - 'null'
                        description: The name of the controller wiegand connection
                    required:
                    - type
                    - controller_wiegand_id
                required:
                - controller_wiegand_connection
              - type: object
                title: Legacy Controller Connection
                properties:
                  controller_wiegand_connection:
                    type: object
                    properties:
                      type:
                        const: legacy_controller
                      controller_wiegand_id:
                        type: integer
                        description: The controller_wiegand ID of the controller wiegand connection
                      lock_id:
                        type: integer
                        description: The lock ID of the controller wiegand connection
                      name:
                        type:
                        - string
                        - 'null'
                        description: The name of the controller wiegand connection
                      virtual_card_format_name:
                        type:
                        - string
                        - 'null'
                        enum:
                        - null
                        - hid_h10301
                        - hid_h10302
                        - hid_h10304
                        - em_410x_26
                        - em_410x_32_34
                        - keyscan_c15001
                        - hid_d10202
                        description: The format of the virtual card.
                      virtual_card_card_number:
                        type:
                        - integer
                        - 'null'
                        description: The card number of the virtual card.
                      virtual_card_facility_code:
                        type:
                        - integer
                        - 'null'
                        description: The facility code of the virtual card.
                      virtual_card_card_id:
                        type:
                        - integer
                        - 'null'
                        description: The card id of the virtual card. Only applies to `EM_410X_32_34` cards.
                      virtual_card_oem:
                        type:
                        - integer
                        - 'null'
                        description: The oem of the virtual card. Only applies to `KEYSCAN_C15001` cards.
                      virtual_card_uid:
                        type:
                        - string
                        - 'null'
                        pattern: ^([0-9a-fA-F]){6,16}$
                        description: The uid of the virtual card.
                      virtual_card_length:
                        type:
                        - integer
                        - 'null'
                        description: The bit length of the virtual card's uid.
                    required:
                    - type
                    - controller_wiegan

# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kisi/refs/heads/main/openapi/kisi-controller-wiegand-connections-api-openapi.yml