Response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/nmi/json-schema/nmi-create-merchant-keys-response-schema.json",
  "title": "Response",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/nmi-merchants-api-openapi.yml#/components/schemas/CreateMerchantKeysResponse",
  "type": "object",
  "properties": {
    "objectType": {
      "type": "string",
      "enum": [
        "securityKey"
      ],
      "description": "The type of object that was created as a result of the request."
    },
    "id": {
      "type": "string",
      "description": "The ID of the merchant key that was created."
    },
    "keyText": {
      "type": "string",
      "description": "The value of the key to be sent in with API requests or passed into Collect.js. This can be accessed later in the Security Keys section of the Merchant's Settings."
    },
    "userId": {
      "type": "string",
      "description": "The merchant user ID associated with the key that was created."
    },
    "description": {
      "type": "string",
      "description": "The description assigned to the key. Matches that passed in the request."
    },
    "permissions": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "transaction",
          "cart",
          "tokenization",
          "collectCheckout"
        ]
      },
      "description": "The permissions assigned to the key. Matches those passed in the request except that `tokenization` will be added to `collectCheckout` keys automatically."
    }
  }
}