UpdateEntityRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/methodfi/main/json-schema/methodfi-update-entity-request-schema.json",
  "title": "UpdateEntityRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/methodfi-entities-api-openapi.yml#/components/schemas/UpdateEntityRequest",
  "type": "object",
  "properties": {
    "individual": {
      "$ref": "#/$defs/CreateEntityIndividual"
    },
    "corporation": {
      "$ref": "#/$defs/CreateEntityCorporation"
    },
    "address": {
      "$ref": "#/$defs/Address"
    },
    "metadata": {
      "$ref": "#/$defs/Metadata"
    }
  },
  "$defs": {
    "Address": {
      "type": "object",
      "description": "Postal mailing address.",
      "properties": {
        "line1": {
          "type": [
            "string",
            "null"
          ],
          "description": "Primary street address line."
        },
        "line2": {
          "type": [
            "string",
            "null"
          ],
          "description": "Secondary address line such as apartment or suite."
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "City or locality."
        },
        "state": {
          "type": [
            "string",
            "null"
          ],
          "description": "Two-letter state or province code when available."
        },
        "zip": {
          "type": [
            "string",
            "null"
          ],
          "description": "Postal code."
        }
      }
    },
    "CreateEntityCorporation": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Legal name of the corporation."
        },
        "dba": {
          "type": "string",
          "description": "Doing business as name."
        },
        "ein": {
          "type": "string",
          "description": "Employer Identification Number."
        },
        "owners": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/EntityCorporationOwner"
          },
          "description": "List of beneficial owners."
        }
      }
    },
    "CreateEntityIndividual": {
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string",
          "description": "First name of the individual."
        },
        "last_name": {
          "type": "string",
          "description": "Last name of the individual."
        },
        "phone": {
          "type": "string",
          "description": "Phone number of the individual.",
          "pattern": "^\\+\\d{10,15}$"
        },
        "email": {
          "type": "string",
          "description": "Email address of the individual.",
          "format": "email"
        },
        "dob": {
          "type": "string",
          "format": "date",
          "description": "Date of birth of the individual (YYYY-MM-DD)."
        },
        "ssn": {
          "type": "string",
          "pattern": "^\\d{9}$",
          "description": "Social security number (9 digits). Mutually exclusive with ssn_4."
        },
        "ssn_4": {
          "type": "string",
          "pattern": "^\\d{4}$",
          "description": "Last 4 digits of SSN. Mutually exclusive with ssn."
        }
      }
    },
    "EntityCorporationOwner": {
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string",
          "description": "First name of the owner."
        },
        "last_name": {
          "type": "string",
          "description": "Last name of the owner."
        },
        "phone": {
          "type": "string",
          "description": "Phone number of the owner.",
          "pattern": "^\\+\\d{10,15}$"
        },
        "email": {
          "type": "string",
          "description": "Email address of the owner.",
          "format": "email"
        },
        "dob": {
          "type": "string",
          "format": "date",
          "description": "Date of birth of the owner (YYYY-MM-DD)."
        },
        "address": {
          "$ref": "#/$defs/Address"
        }
      }
    },
    "Metadata": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": true,
      "description": "Arbitrary key-value metadata attached to the resource."
    }
  }
}