ExternalAccountCreateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/narmi/main/json-schema/narmi-external-account-create-request-schema.json",
  "title": "ExternalAccountCreateRequest",
  "description": "Shared fields and validation for all ExternalAccount serializers.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/narmi-accounts-api-openapi.yml#/components/schemas/ExternalAccountCreateRequest",
  "type": "object",
  "properties": {
    "routing_number": {
      "type": "string",
      "minLength": 1,
      "description": "Routing number for the external account."
    },
    "account_number": {
      "type": "string",
      "minLength": 1,
      "description": "Account number for the external account."
    },
    "product_type": {
      "allOf": [
        {
          "$ref": "#/$defs/ProductTypeEnum"
        }
      ],
      "description": "Account type, can be one of `checking`, `savings`, or `loan`.\n\n* `checking` - Checking\n* `savings` - Savings\n* `loan` - Loan"
    },
    "account_purpose": {
      "allOf": [
        {
          "$ref": "#/$defs/AccountPurposeEnum"
        }
      ],
      "description": "Specifies whether an external account is `personal` or `business`.\n\n* `personal` - Personal\n* `business` - Business"
    },
    "agreement": {
      "type": "boolean",
      "description": "Whether the user has accepted the terms for account creation. This must be set to true for the account to be created successfully."
    },
    "description": {
      "type": "string",
      "description": "User-specific nickname for the account. This will be used as the display name of the account."
    }
  },
  "required": [
    "account_number",
    "account_purpose",
    "agreement",
    "product_type",
    "routing_number"
  ],
  "x-stoplight": {
    "id": "op3ybif6mojpd"
  },
  "$defs": {
    "AccountPurposeEnum": {
      "enum": [
        "personal",
        "business"
      ],
      "type": "string",
      "description": "* `personal` - Personal\n* `business` - Business",
      "x-stoplight": {
        "id": "ccf1svqamabvv"
      }
    },
    "ProductTypeEnum": {
      "enum": [
        "checking",
        "savings",
        "loan"
      ],
      "type": "string",
      "description": "* `checking` - Checking\n* `savings` - Savings\n* `loan` - Loan",
      "x-stoplight": {
        "id": "glwfyeoe7jdqc"
      }
    }
  }
}