Leads Module API Endpoint

Note: Currently the only supported lead types are Personal Loan Application leads.

The entire interface consists of a single endpoint used to create a lead and update it (if necessary) until it is ready to be processed by the system. This allows the external providers the flexibility to use our system as a step-by-step storage point for user interactive portals (eg: a web site where the customer would follow a wizard to provide information and allow them to continue the process at any point through it). Once the lead is ready to be processed a flag on the payload can be set to indicate the lead is finalised. Depending on the application settings maintained by the subscriber, each lead provider's API key can be set to automatically process the finalised leads or await user review and processing. The provider can also individually set the CanBeAutoProcessed flag on the payload, even if the API key is set to auto import all leads. In order to be able to provide leads to a Biz Core Subscriber, the external provider must request an API key from the Subscriber. The Subscriber can generate and manage each of the API keys via the Biz Core UI. When using the API the subscriber must generate the Hawk Authentication Header using the API Key ID and API Key value pair provided by the Subscriber. Invalid values or disabled keys will result in an "Unauthorized" response.

Description: This API endpoint is used to submit a lead to the system.

HTTP Method: POST

Authentication:

When using the API, the subscriber must generate the Hawk Authentication Header using the API Key ID and API Key value pair provided by the Subscriber. If invalid values are used or if the key is not enabled, the API will return an "Unauthorized" response.

To generate an API Key ID and API Key value pair within the Biz Core Portal, use the sidebar to navigate to Settings → Advanced. From here, expand the Subscription API Keys widget and click the Plus icon. Provide a description in the field before clicking Add:

A popup window will launch displaying the API Key ID and Key value pair, after this information has been recorded click OK, I HAVE SAVED THIS INFORMATION:

Note: Ensure to save the Key ID and Key before proceeding, as this information cannot be retrieved.

Finally, expand the Leads Settings widget from the same page, locate the API that was just created and turn on the Active toggle:

Users can now provide the API Key ID and API Key to external lead providers in order to submit leads into Biz Core.

Request Parameters:

lead_data (object): A JSON object containing the lead data to be submitted. The structure and required fields of this object will be specified in the documentation.

Request Headers:

Authorization: {Your API KEY Access Token}

Request Properties Table:

Property	Enum Type
Nationality	CountryEnum
Gender	GenderEnum
MaritalStatus	MaritalStatusEnum
EmploymentTypeId	EmploymentTypeEnum
EmploymentPaymentFrequencyId	FrequencyEnum
AdditionalIncomePaymentFrequencyId	FrequencyEnum
RentExpensesPaymentFrequencyId	FrequencyEnum
LivingExpensesPaymentFrequencyId	FrequencyEnum
LoanExpensesPaymentFrequencyId	FrequencyEnum
VehicleTypeId	VehicleTypeEnum
LoanReason	LoanReasonEnum

Property Name	Type
firstName	string
middleNames	string
familyName	string
motherMaidenName	string
dateOfBirth	string (DateTime)
nationality	number
gender	number
maritalStatus	number
homeAddressId	string
postalAddressId	string
residentDate	string (DateTime)
numberOfDependents	number
licenceNumber	string
licenceExpiryDate	string (DateTime)
licenceState	string
licenceVersionNumber	string
passportNumber	string
passportExpiryDate	string (DateTime)
medicareNumber	string
medicareReference	string
medicareExpiryDate	string (DateTime)
employerName	string
employeeNo	string
occupation	string
employmentStartDate	string (DateTime)
industry	string
industryId	string
employmentTypeId	number
employmentContactFirstName	string
employmentContactLastName	string
employmentContactPosition	string
employmentContactEmailAddress	string
employmentContactMobilePhone	string
employmentPhone	string
employmentIncome	number
employmentPaymentFrequencyId	number
additionalIncome	number
additionalIncomePaymentFrequencyId	number
rentExpenses	number
rentExpensesPaymentFrequencyId	number
livingExpenses	number
livingExpensesPaymentFrequencyId	number
livingExpensesSituationId	string
livingExpensesSituationAmount	number
livingExpensesSituationFrequencyId	number
loanExpenses	number
loanExpensesPaymentFrequencyId	number
loanExpensesDescription	string
vehicleTypeId	number
make	string
model	string
year	number
colour	string
body	string
registrationNumber	string
registrationStateId	string
registrationOtherState	string
chassisNumber	string
engineNumber	string
registrationExpireDate	string (DateTime)
isHomeOwner	boolean
bankStatementCredentials	string
bankStatementsToken	string
sendResumeUrl	boolean
resumeUrl	string
leadId	string
subscriptionId	string
leadSource	string
leadMedium	string
leadCampaign	string
leadContent	string
identifiers	object
loanProductId	string
loanProduct	string
amount	number
paymentFrequency	number
lengthInWeeks	number
loanReason	number
loanReasonOther	string
loanReasonApplicationForm	string
emailContacts	array
phoneContacts	array
addressContacts	array
isReadyForProcessing	boolean
canBeAutoProcessed	boolean

Enum Name	Value	Two-Letter Code	Three-Letter Code	Supported
Australia	0	AU	AUS	Yes
NewZealand	1	NZ	NZL	Yes

GenderEnum
Other	0
Female	1
Male	2

MaritalStatusEnum	Name	MaritalStatusId
Other	[Name = "Other"]	0
Single	[Name = "Single"]	1
Married	[Name = "Married"]	2
Divorced	[Name = "Divorced"]	3
Widowed	[Name = "Widowed"]	4
DeFacto	[Name = "De Facto"]	5
Separated	[Name = "Separated"]	6

EmploymentTypeEnum:

EmploymentTypeEnum	Name	EmploymentTypeId
Casual	[Name = "Casual"]	0
Contract	[Name = "Contract"]	1
PartTime	[Name = "Part Time"]	2
FullTime	[Name = "Full Time"]	3
Benefits	[Name = "Benefits"]	4
SelfEmployed	[Name = "Self-Employed"]	5

FrequencyEnum:

FrequencyEnum	Name	FrequencyId
Daily	[Name = "Daily"]	0
Weekly	[Name = "Weekly"]	1
Fortnightly	[Name = "Fortnightly"]	2
Monthly	[Name = "Monthly"]	3
Quarterly	[Name = "Quarterly"]	4
HalfYearly	[Name = "Half Yearly"]	5
Yearly	[Name = "Yearly"]	6
OnceOff	[Name = "Once-Off"]	7

VehicleTypeEnum:

VehicleTypeEnum	Description	VehicleTypeId
Car	Car	0
Motorcycle	Motorcycle	1
Trailer	Trailer	2
Boat	Boat	3
Van	Van	4
RV	RV	5
Truck	Truck	6
Plane	Plane	7
JetSki	Jet Ski	8
Yacht	Yacht	9

LoanReasonEnum:

LoanReasonEnum	Reason	LoanReasonId
Other	Other	0
HouseholdGoodsAndFurniture	Household Goods and Furniture	1
MedicalDentalSpecialistExpenses	Medical Dental Specialist Expenses	2
RentalBond	Rental Bond	3
UtilityBills	Utility Bills	4
TravelHoliday	Travel or Holiday	5
EventCosts	Event Costs	6
ProfessionalServices	Professional Services	7
EducationFees	Education Fees	8
Gifts	Gifts	9
CarServiceRepairs	Car Service or Repairs	10
BasicLivingExpenses	Basic Living Expenses	11
WorkExpenses	Work Expenses	12
CarRegistration	Car Registration	13
RelocationCosts	Relocation Costs	14
EntertainmentLeisure	Entertainment Leisure	15
HomeRepairsImprovements	Home Repairs or Improvements	16
Insurance	Insurance	17
DebtConsolidation	Debt Consolidation	18

NewEmailContact:

Property	Type
EmailAddress	string

NewPhoneContact:

Property	Type
PhoneTypeId	PhoneTypeEnum
PhoneNumber	string

PhoneTypeEnum:

PhoneTypeEnum	Name
Residential	Residential	0
Mobile	Mobile	1
Business	Business	2

NewAddressContact:

Property	Type
Premise	string
StreetAddress	string
PostalCode	string
Locality	string
AdministrativeArea	string
Country	string

Request Body Example:

{
  "firstName": "APITest",
  "middleNames": "APITest",
  "familyName": "APITest",
  "motherMaidenName": "APITest",
  "dateOfBirth": "2005-07-24T01:04:40.060Z",
  "nationality": "0",
  "gender": "1",
  "maritalStatus": "0",
  "homeAddressId": "F5E96FAD-7DCB-44E6-80EA-5DD71E2E5100",
  "postalAddressId": "F5E96FAD-7DCB-44E6-80EA-5DD71E2E5100",
  "residentDate": "2020-07-24T01:04:40.060Z",
  "numberOfDependents": "2",
  "licenceNumber": "API123",
  "licenceExpiryDate": "2026-07-24T01:04:40.060Z",
  "licenceState": "7647730D-8BDE-40C2-AEEB-5EC889AF3C25",
  "licenceVersionNumber": "API123",
  "passportNumber": "API123",
  "passportExpiryDate": "2027-07-24T01:04:40.060Z",
  "medicareNumber": "API123",
  "medicareReference": "45566",
  "medicareExpiryDate": "2027-07-24T01:04:40.060Z",
  "employerName": "APITest",
  "employeeNo": "2222",
  "occupation": "Test",
  "employmentStartDate": "2020-07-24T01:04:40.060Z",
  "employmentStartDateApplicationForm": "2023-07-24T01:04:40.060Z",
  "industryId": "BCDA81F3-4C29-4C8A-BA4C-0006F1EB131C",
  "employmentTypeId": "0",
  "employmentContactFirstName": "APITest",
  "employmentContactLastName": "APITest",
  "employmentContactPosition": "APITest",
  "employmentContactEmailAddress": "[email protected]",
  "employmentContactMobilePhone": "0400000000",
  "employmentIncome": "6000",
  "employmentPaymentFrequencyId": 2,
  "additionalIncome": "4500",
  "additionalIncomePaymentFrequencyId": 2,
  "rentExpenses": "4500",
  "rentExpensesPaymentFrequencyId": 2,
  "livingExpenses": "4500",
  "livingExpensesPaymentFrequencyId": 2,
  "livingExpensesPaymentFrequencyIdApplicationForm": 2,
  "livingExpensesSituationAmountApplicationForm": "4500",
  "livingExpensesSituationFrequencyIdApplicationForm": 2,
  "loanExpenses": "4500",
  "loanExpensesPaymentFrequencyId": 2,
  "loanExpensesDescription": "APITest",
  "vehicleTypeId": 0,
  "make": "Test",
  "model": "Test",
  "year": "2010",
  "colour": "Test",
  "body": "fhf",
  "registrationNumber": "API123",
  "registrationStateId": "F5E96FAD-7DCB-44E6-80EA-5DD71E2E5100",
  "chassisNumber": "API123",
  "engineNumber": "API123",
  "registrationExpireDate": "2027-07-24T01:04:40.060Z",
  "isHomeOwner": true,
  "bankStatementCredentials": null,
  "bankStatementsToken": null,
  "sendResumeUrl": false,
  "resumeUrl": null,
  "leadId": null,
  "subscriptionId": "c08f84dc-840a-47eb-a27e-ddab42bedc6f",
  "LeadSource": "AWESOME LEAD PROVIDER",
  "leadMedium": "APITest9",
  "leadCampaign": "APITest8",
  "leadContent": "APITest7",
  "identifiers": {
    "additionalProp1": "APITest1",
    "additionalProp2": "APITest2",
    "additionalProp3": "APITest3"
  },
  "loanProductId": "04F7B1DB-0C6B-4AF7-BA36-7A7FCFB68F40",
  "loanProduct": "SMACC",
  "amount": "4300",
  "paymentFrequency": "2",
  "lengthInWeeks": "52",
  "loanReason": 0,
  "loanReasonOther": "Test",
  "EmailContacts": [
    {
      "EmailAddress": "[email protected]"
    }
  ],
  "phoneContacts": [
    {
      "phoneTypeId": "0",
      "phoneNumber": "0400000000",
      "countryId": 0
    }
  ],
  "addressContacts": [
    {
      "newAddressContactId": null,
      "dateMovedIn": "2020-07-24T01:21:00.722Z",
      "premise": 46,
      "streetAddress": "46 Rita Street",
      "postalCode": "4883",
      "locality": "Atherton",
      "administrativeArea": "QLD",
      "country": "Australia"
    }
  ],
  "isReadyForProcessing": true,
  "canBeAutoProcessed": true
}

Response:

Status: 200 OK if the lead submission was successful.
Status: 4xx or 5xx if there was an error during the lead submission.

Response Body Example (Success): Code 200

{
  "result": {
    "lead": {
      "firstName": "APITest",
      "middleNames": "APITest",
      "familyName": "APITest",
      "motherMaidenName": "APITest",
      "dateOfBirth": "2005-07-24T01:04:40.06",
      "nationality": 0,
      "gender": 1,
      "maritalStatus": 0,
      "homeAddressId": "f5e96fad-7dcb-44e6-80ea-5dd71e2e5100",
      "postalAddressId": "f5e96fad-7dcb-44e6-80ea-5dd71e2e5100",
      "residentDate": "2020-07-24T01:04:40.06+00:00",
      "numberOfDependents": 2,
      "licenceNumber": "API123",
      "licenceExpiryDate": "2026-07-24T01:04:40.06",
      "licenceState": "7647730D-8BDE-40C2-AEEB-5EC889AF3C25",
      "licenceVersionNumber": "API123",
      "passportNumber": "API123",
      "passportExpiryDate": "2027-07-24T01:04:40.06",
      "medicareNumber": "API123",
      "medicareReference": "45566",
      "medicareExpiryDate": "2027-07-24T01:04:40.06",
      "employerName": "APITest",
      "employeeNo": "2222",
      "occupation": "test",
      "employmentStartDate": "2020-07-24T01:04:40.06+00:00",
      "industry": null,
      "industryId": "bcda81f3-4c29-4c8a-ba4c-0006f1eb131c",
      "employmentTypeId": 0,
      "employmentContactFirstName": "APITest",
      "employmentContactLastName": "APITest",
      "employmentContactPosition": "APITest",
      "employmentContactEmailAddress": "[email protected]",
      "employmentContactMobilePhone": "0400000000",
      "employmentPhone": null,
      "employmentIncome": 6000,
      "employmentPaymentFrequencyId": 2,
      "additionalIncome": 4500,
      "additionalIncomePaymentFrequencyId": 2,
      "rentExpenses": 4500,
      "rentExpensesPaymentFrequencyId": 2,
      "livingExpenses": 4500,
      "livingExpensesPaymentFrequencyId": 2,
      "livingExpensesSituationId": null,
      "livingExpensesSituationAmount": null,
      "livingExpensesSituationFrequencyId": null,
      "loanExpenses": 4500,
      "loanExpensesPaymentFrequencyId": 2,
      "loanExpensesDescription": "APITest",
      "vehicleTypeId": 0,
      "make": "test",
      "model": "test",
      "year": 2010,
      "colour": "test",
      "body": "test",
      "registrationNumber": "API123",
      "registrationStateId": "f5e96fad-7dcb-44e6-80ea-5dd71e2e5100",
      "registrationOtherState": null,
      "chassisNumber": "API123",
      "engineNumber": "API123",
      "registrationExpireDate": "2027-07-24T01:04:40.06+00:00",
      "isHomeOwner": true,
      "bankStatementCredentials": null,
      "bankStatementsToken": null,
      "sendResumeUrl": false,
      "resumeUrl": null,
      "leadId": "2c197e13-4377-4096-8d8f-2ec260dc80e0",
      "subscriptionId": "c08f84dc-840a-47eb-a27e-ddab42bedc6f",
      "leadSource": "AWESOME LEAD PROVIDER",
      "leadMedium": "APITest9",
      "leadCampaign": "APITest8",
      "leadContent": "APITest7",
      "identifiers": {
        "additionalProp1": "APITest1",
        "additionalProp2": "APITest2",
        "additionalProp3": "APITest3"
      },
      "loanProductId": "04f7b1db-0c6b-4af7-ba36-7a7fcfb68f40",
      "loanProduct": "SMACC",
      "amount": 4300,
      "paymentFrequency": 2,
      "lengthInWeeks": 52,
      "loanReason": 0,
      "loanReasonOther": "test",
      "loanReasonApplicationForm": null,
      "emailContacts": [
        {
          "emailAddress": "[email protected]"
        }
      ],
      "phoneContacts": [
        {
          "phoneTypeId": 0,
          "phoneNumber": "0400000000",
          "countryId": 0
        }
      ],
      "addressContacts": [
        {
          "newAddressContactId": null,
          "dateMovedIn": "2020-07-24T01:21:00.722+00:00",
          "premise": null,
          "streetAddress": "46 Rita Street",
          "postalCode": "4883",
          "locality": "Atherton",
          "administrativeArea": "QLD",
          "country": "Australia"
        }
      ],
      "isReadyForProcessing": true,
      "canBeAutoProcessed": true,
      "reference": "BCB001730A"
    }
  },
  "statusCode": 200
}

This structured API documentation provides a clear understanding of the endpoints, authentication, request parameters, and properties involved in the lead submission process.

Minimum Recommended Request Body Example:

{
  "firstName": "Test",
  "familyName": "Test",
  "dateOfBirth": "2005-07-24T12:00:00.000Z",
  "nationality": "0",
  "gender": "1",
  "maritalStatus": "0",
  "occupation": "Test",
  "employmentIncome": "6000",
  "leadId": null,
  "subscriptionId": "c08f84dc-840a-47eb-a27e-ddab42bedc6f",
  "LeadSource": "AWESOME LEAD PROVIDER",
  "loanProduct": "SMACC",
  "amount": "4300",
  "paymentFrequency": "2",
  "lengthInWeeks": "52",
  "loanReason": 0,
  "EmailContacts": [
    {
      "EmailAddress": "[email protected]"
    }
  ],
  "phoneContacts": [
    {
      "phoneTypeId": "1",
      "phoneNumber": "0400000000",
      "countryId": 0
    }
  ],
  "addressContacts": [
    {
      "premise": 46,
      "streetAddress": "46 Rita Street",
      "postalCode": "4883",
      "locality": "Atherton",
      "administrativeArea": "QLD",
      "country": "Australia"
    }
  ],
  "isReadyForProcessing": true,
  "canBeAutoProcessed": true
}

Note: this example will submit all details to the system and immediatly create an new application.