CreatePartnerApplicationRequest

Request for creating a new application through partner API

  • clients
    Type:
    required

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

    Properties: 4
  • details
    Type:
    required

    Application details including amount, purpose, and terms

    Properties: 8
  • product
    Type: "Personal Loan" or "Commercial Loan"enum
    required

    Product type for the application. Commercial Loan is a business loan and requires borrowerEntity and a business purpose in details.purpose

  • borrowerEntity
    Type:

    The company, partnership or trust borrowing. Required when product is Commercial Loan, ignored on any other product

    Properties: 11
  • debtConsolidation
    Type:

    List of Debt ConsolidationRequest items for the application

    Properties: 2
  • extras
    Type:

    Additional optional fields for the application

    Properties: 6
  • security
    Type:

    Security details for the application

    Properties: 6
  • settings
    Type:

    Application settings including notification preferences

    Properties: 3
  • timeInBusiness
    Type: stringenum

    How long the business has been trading. Commercial Loan only; recorded in the application notes

    values
    Less than 1 year1 year2 years3 years+