Merge · Schema

AddressRequest

# The Address Object ### Description The `Address` object is used to represent a contact's or company's address. ### Usage Example Fetch from the `GET CompanyInfo` endpoint and view the company's addresses.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
type	object	The address type.
street_1	stringnull	Line 1 of the address's street.
street_2	stringnull	Line 2 of the address's street.
city	stringnull	The address's city.
country_subdivision	stringnull	The address's state or region.
country	object	The address's country. The country code in ISO 3166-1 alpha-2 format.
zip_code	stringnull	The address's zip code.
integration_params	objectnull
linked_account_params	objectnull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AddressRequest",
  "title": "AddressRequest",
  "type": "object",
  "properties": {
    "type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/AddressTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The address type."
    },
    "street_1": {
      "type": [
        "string",
        "null"
      ],
      "description": "Line 1 of the address's street."
    },
    "street_2": {
      "type": [
        "string",
        "null"
      ],
      "description": "Line 2 of the address's street."
    },
    "city": {
      "type": [
        "string",
        "null"
      ],
      "description": "The address's city."
    },
    "country_subdivision": {
      "type": [
        "string",
        "null"
      ],
      "description": "The address's state or region."
    },
    "country": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/CountryEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The address's country. The country code in ISO 3166-1 alpha-2 format."
    },
    "zip_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "The address's zip code."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    }
  },
  "description": "# The Address Object\n### Description\nThe `Address` object is used to represent a contact's or company's address.\n\n### Usage Example\nFetch from the `GET CompanyInfo` endpoint and view the company's addresses."
}