CreateAddressUsageRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wordline/main/json-schema/wordline-create-address-usage-request-schema.json",
  "title": "CreateAddressUsageRequest",
  "x-generated": "2026-10-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wordline-company-address-api-openapi.yml#/components/schemas/CreateAddressUsageRequest",
  "type": "object",
  "required": [
    "addressUsageName",
    "serviceCode"
  ],
  "properties": {
    "addressUsageName": {
      "type": "string",
      "description": "The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY."
    },
    "entityReference": {
      "type": "string",
      "description": "This corresponds to the application domain of the address. It can be eg a card contract reference, card account reference. It is an optional field.\nIt enables to have the same usage address for the same customer applied to different addresses (one cardholder with 2 card contracts: card delivery address usage is assigned to main postal address for contract A and card delivery address usage is also assigned to office postal address for contract B."
    },
    "serviceCode": {
      "type": "string",
      "description": "The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE, …"
    }
  }
}