ApplicationClientRequest

Client/applicant information for partner application

  • email
    Type: string
    required

    Email address of the client

  • personalDetails
    Type: object · PersonalDetailsRequest
    required

    Personal details

    • dependants
      Type: stringenum
      required

      Number of dependants

      values
      • None
      • xv1
      • xv2
      • xv3_or_more
      • Unknown
    • employmentStatus
      Type: stringenum
      required

      Employment status

      values
      • Full_Time
      • Part_Time
      • Self_Employed
      • Other
      • Unknown
    • livingSituation
      Type: stringenum
      required

      Living situation

      values
      • Home_Owner
      • Renter
      • Other
      • Boarding
      • Unknown
    • maritalStatus
      Type: stringenum
      required

      Customer's marital status

      values
      • Married
      • In_a_relationship
      • Single
      • Separated
      • Divorced
      • Widowed
      • De_facto
      • Unknown
    • residencyStatus
      Type: stringenum
      required

      Residency status

      values
      • NZ_Citizen
      • Permanent_Resident
      • Work_Visa
      • Student_Visa
    • timeAtAddress
      Type: stringenum
      required

      Time at current address

      values
      • Less_than_1_year
      • xv1_year
      • xv2_years
      • xv3_years_Plus
      • Unknown
    • timeAtRole
      Type: stringenum
      required

      Time at current role

      values
      • Less_than_1_year
      • xv1_year
      • xv2_years
      • xv3_years_Plus
      • Unknown
    • unpaidDefaults
      Type: stringenum
      required

      Whether the client has unpaid defaults

      values
      • Yes
      • No
      • Unsure
    • rentAmount
      Type: number

      Rent Amount

    • rentFrequency
      Type: stringenum

      Rent Frequency

      values
      • Weekly
      • Fortnightly
      • Monthly
  • userDetails
    Type: object · UserDetailsRequest
    required

    Basic user details

    • addresses
      Type: array object[] · AddressRequest[]
      required

      List of addresses

      Address details

    • 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

  • bankStatement
    Type: object · BankStatementRequest

    Personal details including marital status, living situation, etc.

    • akahuExportCodes
      Type: array string[]

      Illion bank export codes

    • illionExportCodes
      Type: array string[]

      Illion bank export codes