CreatePartnerApplicationRequest

Request for creating a new application through partner API

  • clients
    Type: array object[] · ApplicationClientRequest[]
    required

    List of clients for the application (1-2 clients)

    Client/applicant information for partner application

    • email
      Type: string
      required

      Email address of the client

    • personalDetails
      Type: object · PersonalDetailsRequest
      required

      Personal details

    • userDetails
      Type: object · UserDetailsRequest
      required

      Basic user details

    • bankStatement
      Type: object · BankStatementRequest

      Personal details including marital status, living situation, etc.

  • details
    Type: object · ApplicationDetailsRequest
    required

    Application details including amount, purpose, and terms

    • amount
      Type: numberFormat: double
      required

      Loan amount

    • PPIselected
      Type: boolean
      required

      Whether Payment Protection Insurance is selected

    • purpose
      Type: stringenum
      required

      Purpose of the loan

      values
      • Debt_Consolidation
      • Vehicle
      • Unexpected_Expenses
      • Retail_Purchase
      • Home_Improvement
    • interestFreeTermLength
      Type: string

      Interest-free term length as a standardized period

    • interestFreeTermLengthInDays
      Type: integerFormat: int32

      Interest-free term length in days

    • ppiAmount
      Type: numberFormat: double

      PPI Amount value

    • repaymentFrequency
      Type: stringenum

      Repayment Frequency

      values
      • Weekly
      • Fortnightly
      • Monthly
    • termLengthInDays
      Type: integerFormat: int32

      Term length in days

  • product
    Type: string
    required

    Product type for the application

  • debtConsolidation
    Type: array object[] · DebtConsolidationRequest[]

    List of Debt ConsolidationRequest items for the application

    Debt consolidation item for partner application

    • amount
      Type: integerFormat: int64
      required

      amount of debt consolidation

    • name
      Type: string
      required

      name

  • extras
    Type: object · ApplicationExtrasRequest

    Additional optional fields for the application

    • brokerFee
      Type: numberFormat: double

      The fee on top of the loan added by the broker

    • externalReferenceId
      Type: string

      externalReferenceId

    • metadata
      Type: object

      A free-form object that can be used to store custom data about the application.

    • notes
      Type: string

      notes for application

    • partnerUserEmail
      Type: string

      The email address of the partner user submitting the API

    • promotionalCode
      Type: string

      Promotional code

  • security
    Type: array object[] · ApplicationSecurityRequest[]

    Security details for the application

    Security information for the application

    • address
      Type: object · SecurityAddressRequest

      address

    • metaData
      Type: object

      metaData

    • registrationNumber
      Type: string

      Registration number if applicable

    • type
      Type: stringenum

      Type of security for the application

      values
      • Property
      • Vehicle
      • Other
    • value
      Type: integerFormat: int32

      value

  • settings
    Type: object · ApplicationSettingsRequest

    Application settings including notification preferences

    • acceptPrivacyAgreement
      Type: boolean
      required

      Whether privacy agreement is accepted

    • notificationPreference
      Type: stringenum
      required

      Notification preference

      values
      • None
      • ApplicationOutcomeNotifications
      • AllNotifications
    • partnerNotificationPreference
      Type: stringenum
      required

      Partner Notification Preference

      values
      • None
      • ApplicationOutcomeNotifications
      • AllNotifications