# BrokerAPI
Base URL: https://partners.lend.com.au/
In the documentation when we refer to a Request URL such as /api/configs/purposes
, the full URL would be https://partners.lend.com.au/api/configs/purposes
# Lead APIs
# Submit New Lead
To submit a new lead into your Lend Platform account you can use this API.
Request URL:
/api/leads
Example URL:
https://partners.lend.com.au/api/leads
Method:
POST
Request Body:
Field Type Length Required Other Info send_email_to_client bool If this is true, then after the lead has been submitted, if it is not 100% complete, we will send your client an email asking to complete the form. If you are posting to the sandbox
environment no real email will be sent.broker_assigned string 7 If you want to assign this lead to a specific broker on your team, you can provide their Reference here. Refs for your team can be found here... https://partners.lend.com.au/partners/account-admin-management (opens new window) owner.title string Must be Dr
,Mrs
,Miss
,Mr
,Ms
,Prefer not to say
owner.first_name string 60 Yes owner.middle_name string 50 owner.last_name string 60 Yes owner.gender string Must be Female
,Male
,Prefer not to say
owner.marital_status string Must be Single
,Married
,De facto
,Prefer not to say
owner.driving_licence_type string Must be Full
,Provisional
,Learner
,Heavy Vehicle
,None
,Overseas
owner.contact_number string 10 Yes Must be a valid AU number, country code is not required. owner.email string 254 Yes Must be a valid email format. owner.home_owner int 1 This is a home_owner_id
from our Home Owner picklist. You can access the latest list of Home Owner Types by sending aGET
request to the/api/configs/homeowner
API.owner.home_owner_detail string 255 Useful if home_owner
isOther
, to provide any extra information regarding their living situation.owner.dob date Date must be in YYYY-MM-DD format. Cannot be future date. owner.driving_licence_num string 100 Must be a valid AU driving licence number owner.driving_licence_expiry date Date must be in YYYY-MM-DD format. owner.driving_licence_state string 3 AU state must be in the short 3-code version (example: VIC for Victoria) owner.address string 100 This is the first line of address for the applicant (including unit numbers) owner.suburb string 50 owner.state string 3 AU state must be in the short 3-code version (example: VIC for Victoria) owner.postcode string 4 owner.owner_type int 1 This is a owner_type_id
from our Owner Type picklist. You can access the latest list of Owner Types by sending aGET
request to the/api/configs/ownertypes
API.owner.number_of_dependants int 11 owner.dependant_details string Extra details on dependants owner.residency_status string Must be Citizen
,Permanent Resident
,Visa
owner.equity decimal 10,2 The percentage of the business they own. Whole figures or 2 decimal places are accepted (example: 51.00 and 50 are both accepted). No % sign is required. owner.credit_history string Must be one of these strings: Good
,No Credit History
,Paid Defaults
,Unpaid Defaults
,Ex Bankrupt
,Not Sure
owner.class_of_beneficiary string 255 owner.directorship_start_date date owner.security_type string Must be Property (Residential)
,Property (Commercial)
,Vehicle
,Equipment
,Other
owner.security_type_detail string 255 Fill out of owner.security_type
isOther
owner.estimated_value decimal 10,2 owner.remaining_debt decimal 10,2 owner.current_value decimal 10,2 owner.lvr decimal 10,2 owner.security_value decimal 10,2 owner.credit_score decimal 10,2 owner.medicare_number string 12 owner.medicare_ref string 2 owner.medicare_card_colour string Must be Green
,Yellow
,Blue
owner.medicare_expiry date owner.passport_number string 100 owner.passport_country string 100 owner.passport_expiry date owner.consent datetime owner.point_of_contact int 1 owner.is_guarantor int 1 owner.notes string 255 lead.amount_requested decimal 10,2 Yes Must be more than 0. Whole figures or 2 decimal places are accepted (example: 45000 and 45000.00 are both accepted). lead.campaign string 60 lead.partner_alias_id int 11 lead.r_address string 100 Registered office first line address. lead.r_suburb string 50 Registered office suburb. lead.r_state string Must be ACT
,NSW
,VIC
,QLD
,SA
,WA
,TAS
,NT
.lead.r_postcode string 10 Registered office postcode. lead.r_country string 2 Registered office country. lead.abn string 11 Must be a valid Australian Business Number. No spaces required. lead.business_name string 255 Any registered Business Name (example: Lend) lead.organisation_name string 255 Yes The legal entity name (example: Lend Capital Pty Ltd) lead.purpose_id int 2 Yes This is a purpose_id
from our loan purpose picklist. You can access the latest list of loan purposes by sending aGET
request to the/api/configs/purposes
API.lead.purpose_other string 255 Useful when lead.purpose
isOther
lead.loan_term_requested int 2 This is a loan_term_id
from our loan terms picklist. You can access the latest list of loan terms by sending aGET
request to the/api/configs/loanterms
API.lead.trading_since date [Field Deprecated] Date must be in YYYY-MM-DD format. We suggest now using lead.company_registration_date
field.lead.company_registration_date date Yes Date must be in YYYY-MM-DD format lead.industry_id int 11 Yes This is an industry_id
from one of our list of industries. You can access the latest list of industries by sending aGET
request to the/api/configs/industries
API.lead.industry_detail string 255 Useful when lead.industry
isOther
lead.equipment.id int 11 Required when lead.purpose
isVehicles or Transport
orMachinery or Equipment
This is an equipment_id
from our equipment types picklist. You can access the latest list of equipment types by sending a GET request to the/api/configs/equipmenttypes
API.lead.equipment_condition int 11 Must be one of these strings: New
,Used
,Optional
whenlead.purpose
isVehicles or Transport
orMachinery or Equipment
.lead.equipment_year string Must be in YYYY format. Optional when lead.equipment_condition
isUsed
.lead.equipment_found int 1 True (1) or False (0). If they have already found the equipment. Optional when lead.purpose
isVehicles or Transport
orMachinery or Equipment
.lead.equipment_source string Must be one of these strings: Dealer
,Private
,Auction
,Other
. Optional whenlead.equipment_found
is1
lead.equipment_source_detail string 255 Useful when lead.equipment_source
isOther
.lead.business_credit_history string Must be one of these strings: Good
,No Credit History
,Paid Defaults
,Unpaid Defaults
,Ex Bankrupt
,Not Sure
.lead.product_type_id int 11 This is a product_type_id
from one of our list of products. You can access the latest list of product types by sending aGET
request to the/api/configs/producttypes
API.lead.b_address string 100 This is the first line of address for the business (including unit numbers) lead.b_suburb string 50 Business trading suburb lead.b_state string 3 AU state must be in the short 3-code version (example: VIC for Victoria) lead.b_postcode string 4 Business trading postcode lead.b_country string 2 Business trading country lead.sales_monthly decimal 10,2 Yes Monthly Revenue (average per month over the last 6 months). Whole figures or 2 decimal places are accepted (example: 45000 and 45000.00 are both accepted). lead.sales_annual decimal 10,2 Useful if they have been trading more than 12 months. Annual Revenue over the last 12 months. Whole figures or 2 decimal places are accepted (example: 200000 and 200000.00 are both accepted). lead.overdraft_loc_limit decimal 10,2 If they have any arranged overdraft with their bank. Whole figures or 2 decimal places are accepted (example: 1000 and 1000.00 are both accepted). lead.tax_outstanding_arrangement int 1 True (1) or False (0). If they have an any outstanding tax, is there an arrangement in place with the ATO. lead.bs_doc_id string 9 Illion (formerly Proviso) Document ID. This will allow us to retrieve the bank statements from Illion's Broker Flow. lead.force_send bool If you want your lead to be sent to lenders even if the application isn't 100% complete, set this to true. Note: Required fields are still required. lead.send_type string 6 Default is Auto
. AcceptsAuto
orManual
. This is the type of method you want your lead to be sent to lenders.lead.who_to_contact string 6 Default is Client
. AcceptsBroker
orClient
. This is who you would like the lenders to liaise with in regards to the application.lead.monthly_expenses decimal 10,2 lead.how_soon_id int 11 lead.existing_business int 1 True (1) or False (0). lead.tax_outstanding int 1 True (1) or False (0). lead.tax_overdue decimal 10,2 lead.tax_outstanding_arrangement int 1 lead.books_package_is int 11 lead.books_package_detail string 100 lead.premise_type_id int 11 lead.premise_other_detail string 255 lead.invoice_amount_outstanding decimal 10,2 lead.number_of_invoices int 4 lead.smsf_property_type string Must be Residential
,Commercial
,Land
.lead.smsf_property_postcode decimal 4,0 lead.smsf_property_balance decimal 10,2 lead.security_status int 1 True (1) or False (0). lead.show_security_other string 255 lead.director_status_select string Must be Single
,Multiple
.lead.consent_status int 1 True (1) or False (0). lead.prev_business_name int 1 True (1) or False (0). lead.trading_period_select string Must be Less than 6 months
,6 - 12 months
,More than 12 months
lead.has_customer_type int 1 True (1) or False (0). lead.invoice_lvr decimal 10,2 lead.private_lending_purpose_id int 11 lead.customer_type string Must be Businesses
,Consumers
,Both
.lead.property_purpose string Must be New Purchase
,Refinance
,Construction
.lead.bank_statements int 1 True (1) or False (0). lead.ato_portal int 1 True (1) or False (0). lead.bas_statements int 1 True (1) or False (0). lead.prev_asset_finance int 1 True (1) or False (0). lead.comp_financial_statements int 1 True (1) or False (0). lead.personal_business_tax_returns int 1 True (1) or False (0). lead.pl_balance_sheet int 1 True (1) or False (0). Example Request Body:
{ "send_email_to_client": 1, "broker_assigned" : "xxxxxxx", "owner": { "title": "Mr", "first_name": "John", "middle_name": "", "last_name": "Doe", "gender": "Male", "contact_number": "0444444444", "marital_status": "Single", "driving_licence_type": "Full", "security_type": "Property (Residential)", "security_type_detail": "Other", "email": "[email protected]", "home_owner": 2, "home_owner_detail": "Any extra info regarding living arrangements", "dob": "1988-12-31", "driving_licence_num": "xxxxxxxxx", "driving_licence_expiry": "2025-12-31", "driving_licence_state": "VIC", "address": "1 Taylor Street", "suburb": "Moorabbin", "state": "VIC", "postcode": "3189", "owner_type": 1, "equity": 95, "credit_history": "No Credit History" "estimated_value": 5000.00, "remaining_debt": 2000.00, "current_value": 10000.00, "lvr": 1000.00, "security_value": 3000.00, "credit_score": "50", "medicare_number": "00114399", "medicare_ref": "a4tFe" "medicare_card_colour": "Green", "medicare_expiry": "02/05/21", "passport_number": "025597217", "passport_country": "Australia", "passport_expiry": "21/11/25", "consent": 01/03/22", "point_of_contact": 1, "is_guarantor": 0, "notes": "", "number_of_dependants": 0, "dependant_details": "No Dependants", "residency_status": "Citizen" }, "lead": { "abn": "12 612 877 442", "partner_external_ref": "abc123xyz", "business_name": "Doe Gardening", "organisation_name": "Doe Gardening Pty Ltd", "amount_requested": 30000, "purpose_id": 6, "loan_term_requested": 12, "company_registration_date": "2018-12-31", "industry_id": 52, "product_type_id": 6, "b_address": "1 Taylor Street", "b_suburb": "Moorabbin", "b_state": "VIC", "b_country": "Australia", "b_postcode": "3201", "sales_monthly": 3000.00, "sales_annual": 45000.00, "overdraft_loc_limit": 500.00, "tax_outstanding_arrangement": 0, "bs_doc_id": "Z9ND3K5D2", "force_send": 0, "send_type": "Auto", "who_to_contact": "Client", "purpose_other": "New Equipment", "industry_detail": "Other Industry", "equipment_id": 3, "equipment_condition": "Used", "equipment_year": 2013 "equipment_found": 1, "equipment_source": "Dealer", "equipment_source_detail": "Trade", "business_credit_history": "Good", "product_type_id": 2, "sales_monthly": 10000.00, "sales_annual": 120000.00, "overdraft_loc_limit": 5000.00, "tax_outstanding_arrangement": 1, "bs_doc_id": 12345, "force_send": true, "send_type": "Auto", "who_to_contact": "Client", "monthly_expenses": 3000.00, "how_soon_id": 4, "existing_business": 0, "tax_outstanding": 1, "tax_overdue": 200.50, "tax_outstanding_arrangement": 0, "books_package_is": 5, "books_package_detail": "Other", "premise_type_id": 7, "premise_other_detail": "Other", "invoice_amount_outstanding": 200, "number_of_invoices": 21, "smsf_property_type": "Residential", "smsf_property_postcode": 3000, "smsf_property_balance": 500.25, "security_status": 0, "show_security_other": "Other", "director_status_select": "Multiple", "consent_status": 0, "prev_business_name": 1, "trading_period_select": "Less than 6 months", "has_customer_type": 0, "invoice_lvr": 700.00, "private_lending_purpose_id": 3, "customer_type": "Consumers", "property_purpose": "Construction", "bank_statements": 1, "ato_portal": 0, "bas_statements" 1, "prev_asset_finance": 0, "comp_financial_statements": 1, "personal_business_tax_returns": 1, "pl_balance_sheet": 1 } }
Response
200
- This is the response if your lead submission was successful.
success
will be a boolean, and should always betrue
.- You will be provided with a 7-character
ref
string, this is unique and is used to identify your lead for any future requests. This ref will never change and will be used regardless of what stage (or status) the lead is in. - The
lead_completion
informs you how complete the lead is, if it is not 100% then the lead will sit in your Lend Platform Dashboard until complete. - The
email_sent_to_client
informs you if we have successfully sent an email to your client asking to complete the online form.
Example Response:
{ "success": true, "ref": "22nPwwU", "lead_completion": "95%", "email_sent_to_client": true }
Response
422
- This is the response if your lead submission contains any missing or incorrect data.
success
will be a boolean, and will always befalse
.errors
will be an array containing all the reasons your lead submission failed. In the example below we are showing just one of the reasons.
Example Response:
{ "success": false, "errors": [ { "field": "lead.amount_requested", "error": "Loan amount requested must be more than 0" } ] }
Response
403
- This is the response if your request's
Signature
header contains a signature that is invalid. success
will be a boolean, and will always befalse
.- This is the same structure we use for any generic error messages unrelated to the payload you submitted, so it will contain
data.error
.
Example Response:
{ "success": false, "data": { "error": "Invalid Signature" } }
- This is the response if your request's
# View All Leads
If you want to view all the leads in your account since a specific date that you provide.
- Request URL:
/api/leads/?since=YYYY-MM-DD
- Example URL:
https://partners.lend.com.au/api/leads/?since=2019-10-01
- Method:
GET
- Query Parameters:
since
- (YYYY-MM-DD) Example:/api/leads?since=2019-10-01
.
- Request Body: None
Response
200
success
will be a boolean, and should always betrue
.- Note: If you want to view the current lender status for each lead, see "View Single Lead" section.
Field Type Length Other Info data array Contains 1 object per lead in your account. data[0]lead array Contains the lead details you submitted. data[0]owner array Contains the lead details you submitted. Example Response:
{ "success": true, "data": [ { "lead": { "partner_external_ref": "abc321xyz", "b_address": "1 Taylor Street", "b_suburb": "Moorabbin", "b_state": "VIC", "b_postcode": "3201", "organisation_name": "Doe Gardening Pty Ltd", "business_name": "Doe Gardening", "company_registration_date": "2018-12-31", "abn": "12612877442", "industry_id": "54", "product_type_id": "6", "amount_requested": "30000.00", "loan_term_requested": "12", "purpose_id": "6", "sales_annual": "45000.00", "sales_monthly": "3000.00", "tax_outstanding_arrangement": null, "overdraft_loc_limit": "500.00", "bs_doc_id": "Z9ND3K5D2", "lead_ref": "55VPHip" }, "owner": { "owner_type": "1", "first_name": "John", "middle_name": null, "last_name": "Doe", "dob": "1988-12-31", "driving_licence_num": "xxxxxxxxx", "driving_licence_expiry": "2025-12-31", "driving_licence_state": "VIC", "phone": null, "mobile": "0444444444", "home_owner": "2", "home_owner_detail": "Any extra info regarding living arrangements", "email": "[email protected]", "address": "1 Taylor Street", "suburb": "Moorabbin", "state": "VIC", "postcode": "3189", "equity": "95.00", "credit_history": "No Credit History" } } ] }
# View a Single Lead
If you want to view the full details for a specific lead in your account.
- Request URL:
/api/leads/XXXXXXX
- Example URL:
https://partners.lend.com.au/api/leads/4w6fs
- Method:
GET
- Query Parameters:
lead_ref
- (string) The 7-character string reference for your lead. This is returned in the response after submitting a lead to/api/leads
- Request Body: None
Response
200
success
will be a boolean, and should always betrue
.
Field Type Length Other Info lead array Contains the lead details you submitted. owner array Contains the lead details you submitted. current.lender string 50 The current (latest) lender the lead was sent to. current.lend_status string 128 Lend's own standardised statuses. current.lender_status string 500 The raw status direct from the lender, all these are mapped to a relevent lend_status
.current.last_status_update datetime The last date and time this lead's status was changed. current.sent_to_lender datetime The last date and time this lead was sent to the current lender. Example Response:
{ "success": true, "data": { "lead": { "partner_external_ref": "abc321xyz", "b_address": "1 Taylor Street", "b_suburb": "Moorabbin", "b_state": "VIC", "b_postcode": "3201", "organisation_name": "Doe Gardening Pty Ltd", "business_name": "Doe Gardening", "company_registration_date": "2018-12-31", "abn": "12612877442", "industry_id": "54", "amount_requested": "30000.00", "loan_term_requested": "12", "purpose_id": "6", "sales_annual": "45000.00", "sales_monthly": "3000.00", "tax_outstanding_arrangement": null, "overdraft_loc_limit": "500.00", "bs_doc_id": "Z9ND3K5D2", "lead_ref": "55VPHip" }, "owner": { "owner_type": "1", "first_name": "John", "middle_name": null, "last_name": "Doe", "dob": "1988-12-31", "driving_licence_num": "xxxxxxxxx", "driving_licence_expiry": "2025-12-31", "driving_licence_state": "VIC", "phone": null, "mobile": "0444444444", "home_owner": "2", "home_owner_detail": "Any extra info regarding living arrangements", "email": "[email protected]", "address": "1 Taylor Street", "suburb": "Moorabbin", "state": "VIC", "postcode": "3189", "equity": "95.00", "credit_history": "No Credit History" }, "current": { "lender" : "Lender Name", "lend_status" : "Attempting contact", "lender_status" : "in progress -> 4th attempted call", "last_status_update" : "2019-10-07 09:10:00", "sent_to_lender" : "2019-10-05 14:00:00" } } }
Response
404
- This is the response if your
lead_ref
was not found in our database. success
will be a boolean, and will always befalse
.data.error
will be a string describing the error.
Example Response:
{ "success": false, "data": { "error": "No lead was found with that lead_ref" } }
- This is the response if your
Response
403
- This is the response if you are trying to access a lead which does not belong to your account.
success
will be a boolean, and will always befalse
.data.error
will be a string describing the error.
Example Response:
{ "success": false, "data": { "error": "You are not authroised to access that lead" } }
# Picklist APIs
# Industries
Access the full list of industries that we support (including their unique ID's).
The response will return a list of parent industries and all their child industries.
- Method:
GET
- Request URL:
/api/configs/industries
Below is a sample list, the real response contains more. Each industry (including the parent), contains an industry_id
. This id is used in the lead.industry_id
field when submitting / editing a lead.
Example Response:
{
"success": true,
"industries": [
{
"industry_id": "52",
"industry": "Arts & Lifestyle",
"children": [
{
"industry_id": "60",
"industry": "Sports & Physical Recreation"
},
{
"industry_id": "61",
"industry": "Other"
}
]
},
{
"industry_id": "62",
"industry": "Construction & Trades",
"children": [
{
"industry_id": "82",
"industry": "Tiling, Carpentry, Floors"
},
{
"industry_id": "83",
"industry": "Other"
}
]
},
{
"industry_id": "189",
"industry": "Other",
"children": null
}
]
}
# Loan Purposes
Access the full list of loan purposes that we support (including their unique ID's).
- Method:
GET
- Request URL:
/api/configs/purposes
Below is a sample list, the real response contains more. Each purpose contains a purpose_id
. This id is used in the lead.purpose_id
field when submitting / editing a lead.
Example Response
{
"success": true,
"purposes": [
{
"purpose_id": "1",
"purpose": "Day-to-day"
},
{
"purpose_id": "2",
"purpose": "Inventory"
}
]
}
# Loan Terms
Access the full list of loan terms that we support (including their unique ID's).
- Method:
GET
- Request URL:
/api/configs/loanterms
Below is a sample list, the real response contains more. Each purpose contains a loan_term_id
. This id is used in the lead.loan_term_requested
field when submitting / editing a lead.
Example Response
{
"success": true,
"loan_terms": [
{
"loan_term_id": "1",
"loan_term": "3 Months"
},
{
"loan_term_id": "2",
"loan_term": "4 Months"
}
]
}
# Owner Types
Access the full list of owner types that we support (including their unique ID's).
- Method:
GET
- Request URL:
/api/configs/ownertypes
Below is a sample list, the real response contains more. Each Owner Type contains a owner_type_id
. This id is used in the owner.owner_type
field when submitting / editing a lead.
Example Response
{
"success": true,
"owner_type": [
{
"owner_type_id": 1,
"description": "Director & Shareholder"
},
{
"owner_type_id": 2,
"description": "Director Only"
}
]
}
# Home Owner Options
Access the full list of home-owner types that we support (including their unique ID's).
- Method:
GET
- Request URL:
/api/configs/homeowner
Below is a sample list, the real response contains more. Each Home Owner Option contains a home_owner_id
. This id is used in the owner.home_owner
field when submitting / editing a lead.
Example Response
{
"success": true,
"home_owner": [
{
"home_owner_id": 1,
"description": "Owns"
},
{
"home_owner_id": 2,
"description": "Rents"
}
]
}
# Product Types
Access the full list of finance product types that we support (including their unique ID's).
- Method:
GET
- Request URL:
/api/configs/producttypes
Below is a sample list, the real response contains more. Each Product (including the parent), contains an product_type_id
. This id is used in the lead.product_type_id
field when submitting / editing a lead.
Example Response
{
"success": true,
"product_types": [
{
"product_type_id": "1",
"product_type_name": "Unsecured Loan",
"children": null
},
{
"product_type_name": "Caveat Loan",
"children": [
{
"product_type_id": "15",
"product_type_name": "Bridging"
},
{
"product_type_id": "16",
"product_type_name": "Term Loan"
}
]
}
]
}
# Equipment Types
Access the full list of equipment types that we support (including their unique ID's).
- Method:
GET
- Request URL:
/api/configs/equipment
Below is a sample list, the real response contains more.s
Example Response
{
"success": true,
"equipment": [
{
"equipment_id": "1",
"description": "Passenger Vehicles < 4.5 Tonne",
},
{
"equipment_id": "2",
"description": "Machinery",
},
{
"equipment_id": "3",
"description": "Small & Medium Trucks",
},
]
}