openapi: 3.1.1
info:
  title: CustomerDetails
  version: 1.0.0
  description: |
    PII identity and address details for a utility service customer.

    Contains the personally-identifiable information that is kept separate
    from the non-PII CustomerProfile. fullName appears ONLY here — never
    in customerProfile or any resource entry.

    CIM alignment (IEC 61968-1):
      CustomerDetails → cim:Customer
      fullName        → cim:Customer.name
      serviceConnectionDate → cim:ServiceLocation.firstAddressDetail (activation date)
      installationAddress   → cim:ServiceLocation

    Canonical IRI: https://schema.nfh.global/CustomerDetails/v1.0

    Used by ElectricityCredential/v1.2 credentialSubject.customerDetails.
    May be reused by any utility credential that carries customer PII.

jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
  - url: https://schema.nfh.global
    description: Canonical schema registry
paths: {}
components:
  schemas:

    CustomerDetails:
      $id: https://schema.nfh.global/CustomerDetails/v1.0/attributes.yaml#/components/schemas/CustomerDetails
      type: object
      description: >
        PII identity and address details for a utility customer.
        fullName appears ONLY here — never in customerProfile or resource entries.
        CIM: cim:Customer (IEC 61968-1).
      required:
        - fullName
        - installationAddress
        - serviceConnectionDate
      x-tags:
        - customer
        - pii
        - credential
        - electricity
        - deg
      x-jsonld:
        "@id": deg:CustomerDetails
      properties:

        fullName:
          type: string
          minLength: 1
          maxLength: 200
          description: Full name of the customer as per ID proof.
          x-standard: "CIM (IEC 61968-1 Customer.name)"
          x-jsonld:
            "@id": schema:name

        careOf:
          type: object
          description: >
            Optional care-of (c/o) reference person used to uniquely identify /
            disambiguate a customer who may share the same fullName with others
            in a locality (e.g. a village). Pairs a name with an optional,
            gender-neutral relationship.
          required:
            - name
          additionalProperties: false
          x-jsonld:
            "@id": deg:careOf
          properties:
            name:
              type: string
              minLength: 1
              maxLength: 200
              description: >
                Name of the care-of / reference person used to disambiguate
                the customer.
              x-jsonld:
                "@id": schema:name
            relationship:
              type: string
              enum: [parent, spouse, guardian, sibling, child, other]
              description: >
                Gender-neutral relationship of the reference person to the
                customer.
              x-jsonld:
                "@id": deg:relationship

        installationAddress:
          $ref: "https://schema.nfh.global/Location/v2.0/attributes.yaml#/components/schemas/Location"
          description: >
            Physical location of the metered installation. geo (GeoJSON Point,
            coordinates [longitude, latitude]) is required; address
            (schema.org PostalAddress fields) is optional.
          x-standard: "GeoJSON RFC 7946; schema.org PostalAddress; CIM (IEC 61968-1 ServiceLocation)"
          x-jsonld:
            "@id": deg:installationAddress

        serviceConnectionDate:
          type: string
          format: date-time
          description: >
            Date and time the service connection was activated, with timezone
            offset (ISO 8601).
          x-standard: "CIM (IEC 61968-1 ServiceLocation activation date)"
          x-jsonld:
            "@id": deg:serviceConnectionDate