UserDetailsRequest

Basic user details including name, DOB, and addresses

  • addresses
    Type: array object[] ยท AddressRequest[]
    required

    List of addresses

    Address details

    • city
      Type: string
      required

      City name

    • location
      Type: stringenum
      required

      Location

      values
      • Postal
      • Physical
    • postalCode
      Type: string
      required

      New Zealand postal code (numeric only)

    • streetAddress
      Type: string
      required

      Street address including house/unit number

    • suburb
      Type: string
      required

      Suburb name

    • type
      Type: stringenum
      required

      Type of address

      values
      • Primary
      • Secondary
      • Work
  • dob
    Type: stringFormat: date
    required

    Date of birth

  • firstName
    Type: string
    required

    First name

  • gender
    Type: stringenum
    required

    Gender

    values
    • Male
    • Female
    • Other
    • Unknown
  • lastName
    Type: string
    required

    Last name

  • phoneNumber
    Type: string
    required

    Phone number of the client

  • middleName
    Type: string

    Middle name