{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/narmi/main/json-schema/narmi-payee-create-doc-request-schema.json",
  "title": "PayeeCreateDocRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/narmi-payees-api-openapi.yml#/components/schemas/PayeeCreateDocRequest",
  "type": "object",
  "properties": {
    "type": {
      "allOf": [
        {
          "$ref": "#/$defs/Type905Enum"
        }
      ],
      "minLength": 1,
      "description": "Whether the payment recipient is a person or business."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "description": "Recipient's name."
    },
    "description": {
      "type": "string",
      "minLength": 1,
      "description": "Free-form text."
    },
    "phone": {
      "type": "string",
      "minLength": 1,
      "description": "Recipient's phone number."
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "description": "Recipient's email address."
    },
    "passphrase": {
      "type": "string",
      "minLength": 1,
      "description": "Shared secret phrase between payer and payee."
    },
    "account_number": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "description": "Destination account number."
    },
    "address": {
      "allOf": [
        {
          "$ref": "#/$defs/AddressRequest"
        }
      ],
      "description": "Recipient's address."
    },
    "delivery_options": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/BillDeliveryOptionRequest"
      }
    },
    "ignore_warnings": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ErrorRequest"
      },
      "writeOnly": true,
      "description": "Warning codes to be suppressed during call."
    }
  },
  "required": [
    "name",
    "type"
  ],
  "x-stoplight": {
    "id": "sskdhy8j5ihgs"
  },
  "$defs": {
    "AddressRequest": {
      "type": "object",
      "properties": {
        "street_address": {
          "type": "string",
          "minLength": 1
        },
        "street_address_2": {
          "type": "string"
        },
        "city": {
          "type": "string",
          "minLength": 1
        },
        "region_code": {
          "type": "string",
          "minLength": 1,
          "description": "A region, province, parish, or any kind of subdivision represented by up to 3 characters. Typically an ISO 2-character state code."
        },
        "postal_code": {
          "type": "string",
          "minLength": 1,
          "description": "Typically a five-digit numeric US ZIP Code."
        },
        "country_code": {
          "type": "string",
          "minLength": 1,
          "description": "An ISO 3166-1 alpha-2 country code."
        },
        "type": {
          "type": "string",
          "minLength": 1
        },
        "device_id": {
          "type": [
            "string",
            "null"
          ],
          "writeOnly": true
        },
        "device_request_id": {
          "type": [
            "string",
            "null"
          ],
          "writeOnly": true
        }
      },
      "required": [
        "city",
        "postal_code",
        "region_code",
        "street_address"
      ],
      "x-stoplight": {
        "id": "4ixdbnlsh0rei"
      }
    },
    "BillDeliveryOptionRequest": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "format": "date"
        }
      },
      "required": [
        "date"
      ],
      "x-stoplight": {
        "id": "i3oemzw6y6ap9"
      }
    },
    "ErrorRequest": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "code"
      ],
      "x-stoplight": {
        "id": "cqk62uhcqgodx"
      }
    },
    "Type905Enum": {
      "type": "string",
      "enum": [
        "personal",
        "business"
      ],
      "x-stoplight": {
        "id": "ulcreuinjodf5"
      }
    }
  }
}