Create a new partner application

​

Create a new lending application on behalf of a partner. This endpoint proxies the request to the admin API. Supports creating applications for personal loans with one or two applicants. Each applicant must provide complete personal, financial, and contact information. For a business loan, set product to Commercial Loan, use a business purpose (Business or Business_*) in details.purpose, and provide borrowerEntity with at least one director, partner or trustee and an email for everyone who signs.

Body·

required
application/json

Request body containing the partner application details.

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+

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/api/v1/applications/partner/create
curl https://dev-api.pioneerhub.co.nz/api/v1/applications/partner/create \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "details": {
    "repaymentFrequency": "Weekly",
    "purpose": "Debt_Consolidation",
    "amount": 5000,
    "termLengthInDays": 365,
    "interestFreeTermLengthInDays": 0,
    "interestFreeTermLength": 10,
    "PPIselected": true,
    "ppiAmount": 10.2
  },
  "clients": [
    {
      "email": "[email protected]",
      "userDetails": {
        "dob": "1987-10-25",
        "lastName": "Doe",
        "firstName": "John",
        "middleName": "middle",
        "gender": "Male",
        "addresses": [
          {
            "streetAddress": "123",
            "suburb": "Newtown",
            "city": "Wellington",
            "postalCode": "6011",
            "type": "Primary",
            "location": "Postal"
          }
        ],
        "phoneNumber": "+64 21 123 4567"
      },
      "personalDetails": {
        "maritalStatus": "Married",
        "livingSituation": "Home_Owner",
        "dependants": "None",
        "unpaidDefaults": "Yes",
        "timeAtAddress": "Less_than_1_year",
        "timeAtRole": "Less_than_1_year",
        "residencyStatus": "NZ_Citizen",
        "employmentStatus": "Full_Time",
        "rentFrequency": "Weekly",
        "rentAmount": 123.456
      },
      "bankStatement": {
        "illionExportCodes": [
          "7SPS8TD77"
        ],
        "akahuExportCodes": [
          "CDE"
        ]
      }
    }
  ],
  "product": "Personal Loan",
  "debtConsolidation": [
    {
      "name": "tommy",
      "amount": 1000
    }
  ],
  "security": [
    {
      "type": "Property",
      "value": 1,
      "registrationNumber": "",
      "knownVehicle": false,
      "metaData": {
        "key1": "value1",
        "key2": "value2"
      },
      "address": {
        "streetAddress": "123",
        "suburb": "Newtown",
        "city": "Wellington",
        "postalCode": "6011",
        "type": "Primary",
        "location": "Postal"
      }
    }
  ],
  "settings": {
    "notificationPreference": "AllNotifications",
    "acceptPrivacyAgreement": true,
    "partnerNotificationPreference": "AllNotifications"
  },
  "extras": {
    "promotionalCode": "PROMO123",
    "externalReferenceId": "EXT123456",
    "brokerFee": 1000,
    "partnerUserEmail": "[email protected]",
    "metadata": {
      "customId": "CUST-001",
      "source": "web-portal"
    },
    "notes": "Notes about the application"
  }
}'
Response example

Example of API response

{
  "status": "CREATED",
  "data": {
    "success": true,
    "applicationId": 8,
    "bankStatementUrl": "https://oauth.akahu.nz/?response_type=code&redirect_uri=https%3A%2F%2Fsandbox.pioneerhub.co.nz%2Fapi%2Fclient%2Fakahu%2Fcallback&scope=ONEOFF&client_id=app_token_cm33ru1k3000008lddp64g5ah&email=john.doe%40example.com&state=%7B%22applicationId%22%3A8%2C%22email%22%3A%22john.doe%40example.com%22%2C%22type%22%3A%22application%22%2C%22userId%22%3A19%7D",
    "message": "Created successully"
  },
  "timestamp": "2025-07-31T13:35:24.453508665Z"
}

Application successfully created