CustomerKeyInputVO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-customer-key-input-vo-schema.json",
  "title": "CustomerKeyInputVO",
  "description": "This is a request object for requesting customer key and secret key.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fedex-registration-api-openapi.yml#/components/schemas/CustomerKeyInputVO",
  "required": [
    "accountNumber",
    "address",
    "customerName"
  ],
  "type": "object",
  "properties": {
    "address": {
      "$ref": "#/$defs/AddressVO"
    },
    "accountNumber": {
      "type": "string",
      "description": "This is the FedEx account number requesting authentication details."
    },
    "customerName": {
      "type": "string",
      "description": "Name of the customer or company requesting authentication details."
    }
  },
  "$defs": {
    "AddressVO": {
      "required": [
        "city",
        "countryCode",
        "postalCode",
        "residential",
        "stateOrProvinceCode",
        "streetLines"
      ],
      "type": "object",
      "properties": {
        "residential": {
          "type": "boolean",
          "description": "Indicates whether this address is residential (as opposed to commercial)."
        },
        "city": {
          "type": "string",
          "description": "Specify name of city or town."
        },
        "countryCode": {
          "type": "string",
          "description": "The two-letter code used to identify a country. Max length is 2."
        },
        "postalCode": {
          "type": "string",
          "description": "Use this element to input postal code. Postal code is mandatory for postal-aware countries. The Max length is 10."
        },
        "streetLines": {
          "type": "array",
          "description": "Provide street address which is a combination of number, street name, etc. At least one line is required. For a valid physical address, empty lines should not be included. Max Length is 35.",
          "items": {
            "type": "string"
          }
        },
        "stateOrProvinceCode": {
          "type": "string",
          "description": "Provide 2 letter state or province code.. Max length is 2"
        }
      },
      "description": "Indicates the customer's address you are attempting to get the Customer Key and Customer Secret for. Note that address information needs to match the Shipping or billing address as loaded in FedEx systems. Contact FedEx support team for any address-related issues or questions."
    }
  }
}