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.

Body·CreatePartnerApplicationRequest
required
application/json

Request body containing the partner application details.

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

  • details
    Type: object · ApplicationDetailsRequest
    required

    Application details including amount, purpose, and terms

  • 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

  • extras
    Type: object · ApplicationExtrasRequest

    Additional optional fields for the application

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

    Security details for the application

    Security information for the application

  • settings
    Type: object · ApplicationSettingsRequest

    Application settings including notification preferences

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/api/v1/applications/partner/create
curl https://sandbox-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"
  }
}'

{
  "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