BrokerAPI

# 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 Commercial Lead

To submit a new commercial lead into your Lend Platform account you can use this API. Note when using the sandbox environment for testing you will only be able to see the API response, there is no UI to login to.

  • 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 user 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 Mr, Mrs, Miss, Ms
    owner.first_name string 60 Yes
    owner.middle_name string 50
    owner.last_name string 60 Yes
    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.dob date Date must be in YYYY-MM-DD format. Cannot be future date.
    owner.gender string Must be Female, Male
    owner.marital_status string Must be Single, Married, De facto
    owner.home_owner int 1 This is a home_owner_id from our Home Owner Options (living type) picklist. You can access the latest list of living types by sending a GET request to the /api/configs/homeowner API.
    owner.home_owner_detail string 255 Useful if home_owner is Other, to provide any extra information regarding their living situation.
    owner.address string 100 This is the first line of the address for the applicant (including unit numbers).
    owner.suburb string 50 Applicant's suburb.
    owner.state string 3 Applicant's state. AU state must be in the short 3-code version (example: VIC for Victoria).
    owner.postcode string 4 Applicant's postcode.
    owner.number_of_dependants int 11 The number of dependants the applicant has.
    owner.dependant_details string Any extra details on dependants.
    owner.owner_type int 1 This is a owner_type_id from our Owner Type picklist (Director, Shareholder, Partner etc.). You can access the latest list of Owner Types by sending a GET request to the /api/configs/ownertypes API.
    owner.directorship_start_date date The date they became a director (if applicable), must be in YYYY-MM-DD format.
    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.class_of_beneficiary string 255 If the entity is trust and the applicant is a beneficiary you can include the applicant's beneficiary class.
    owner.security_type string If the applicant can provide security. Must be Property (Residential), Property (Commercial),Vehicle, Equipment, Other
    owner.security_type_detail string 255 Include if owner.security_type is Other
    owner.estimated_value decimal 10,2 The value of the security.
    owner.remaining_debt decimal 10,2 The money owed (if any) for the security.
    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.driving_licence_type string Must be Full, Provisional, Learner, Heavy Vehicle, None, Overseas
    owner.medicare_number string 12 Medicare number.
    owner.medicare_ref string 2 The number next to the relevant name on the Medicare card.
    owner.medicare_card_colour string Must be Green, Yellow, Blue
    owner.medicare_expiry date Must be in YYYY-MM-DD format.
    owner.passport_number string 100 Passport number.
    owner.passport_country string 100 Passport country of issue.
    owner.passport_expiry date Must be in YYYY-MM-DD format.
    owner.residency_status string Must be Citizen, Permanent Resident, Visa
    owner.credit_history string The applicant's credit history. Must be one of these strings: Good,No Credit History,Paid Defaults,Unpaid Defaults,Ex Bankrupt,Not Sure
    owner.consent datetime If the applicant has provided consent for you to pull a personal credit file check pass the date of consent. Must be in YYYY-MM-DD format.
    lead.product_type_id int 11 This is a product_type_id from our list of finance products. You can access the latest list of finance product types by sending a GET request to the /api/configs/producttypes API.
    lead.campaign string 60 For tracking purposes you can pass the campaign name.
    lead.referer string 255 For tracking purposes you can pass the http referer url.
    lead.partner_external_ref string 50 You can include your own unique lead reference. Ensure each lead has a unique reference.
    lead.abn string 11 Must be a valid Australian Business Number (ABN). No spaces.
    lead.company_registration_date date Yes The date the business started. Must be in YYYY-MM-DD format
    lead.business_name string 255 The registered Business Name (example: Lend)
    lead.organisation_name string 255 Yes The legal entity name (example: Lend Capital Pty Ltd)
    lead.prev_business_name int 1 True (1) or False (0). Did the business previously trade under a different entity?
    lead.trading_period_select string How long was it trading under the previous entity? Must be Less than 6 months, 6 - 12 months, More than 12 months
    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 address suburb.
    lead.b_state string 3 Business trading address state. AU state must be in the short 3-code version (example: VIC for Victoria).
    lead.b_postcode string 4 Business trading address postcode.
    lead.b_country string 2 Business trading address country.
    lead.r_address string 100 This is the first line of the address for the registered office address (including unit numbers).
    lead.r_suburb string 50 Registered office address suburb.
    lead.r_state string Registered office address state. AU state must be in the short 3-code version (example: VIC for Victoria).
    lead.r_postcode string 10 Registered office address postcode.
    lead.r_country string 2 Registered office address country code.
    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 a GET request to the /api/configs/industries API.
    lead.industry_detail string 255 Useful when lead.industry is Other
    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 a GET request to the /api/configs/loanterms API.
    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 a GET request to the /api/configs/purposes API.
    lead.purpose_other string 255 Useful when lead.purpose is Other
    lead.existing_business int 1 True (1) or False (0). If the lead.purpose is to purchase an existing business, lenders want to know if the applicant has an existing business. If they do, then the financial details should be based on their existing business, not the one they wish to purchase.
    lead.equipment.id int 11 Required when lead.purpose is Vehicles or Transport or Machinery 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 enum Equipment condition. Must be one of these strings: New, Used, Optional when lead.purpose is Vehicles or Transport or Machinery or Equipment.
    lead.equipment_year string Equipment year. Must be in YYYY format. Optional when lead.equipment_condition is Used.
    lead.equipment_found int 1 True (1) or False (0). If they have already found the equipment. Optional when lead.purpose is Vehicles or Transport or Machinery or Equipment.
    lead.equipment_source enum Equipment source. Must be one of these strings: Dealer, Private Sale, Auction, Other Sale. Optional when lead.equipment_found is 1
    lead.equipment_source_detail string 255 Useful when lead.equipment_source is Other Sale.
    lead.has_customer_type int 1 True (1) or False (0). If the business issues invoices.
    lead.invoice_amount_outstanding decimal 10,2 If the business issues invoices provide further info relevant for invoice finance. Value of invoices. Whole figures or 2 decimal places are accepted (example: 45000 and 45000.00 are both accepted).
    lead.number_of_invoices int 4 If the business issues invoices provide further info relevant for invoice finance. Number of invoices.
    lead.customer_type string If the business issues invoices provide further info relevant for invoice finance. Are the invoices issued to other businesses, consumers or both? Must be Businesses, Consumers, Both.
    lead.private_lending_purpose_id int 11 Only applicable when the product type is Private Lending. 1 = Land Bank, 2 = Partial Development Completion, 3 = Full Construction,
    lead.property_purpose string Only applicable when the product type is Private Lending. Must be New Purchase, Refinance, Construction.
    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.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.monthly_expenses decimal 10,2 Whole figures or 2 decimal places are accepted (example: 45000 and 45000.00 are both accepted).
    lead.tax_outstanding int 1 True (1) or False (0). Does the business have any tax debt?
    lead.tax_outstanding_arrangement int 1 True (1) or False (0). If there is outstanding tax, is there an payment plan arrangement in place with the tax office?
    lead.tax_overdue decimal 10,2 How much is the tax debt? Whole figures or 2 decimal places are accepted (example: 45000 and 45000.00 are both accepted).
    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.overdraft_loc_limit decimal 10,2 If they have an arranged overdraft with their bank. Whole figures or 2 decimal places are accepted (example: 1000 and 1000.00 are both accepted).
    lead.bank_statements int 1 True (1) or False (0). Can they provide...?
    lead.ato_portal int 1 True (1) or False (0). Can they provide...?
    lead.bas_statements int 1 True (1) or False (0). Can they provide...?
    lead.prev_asset_finance int 1 True (1) or False (0). Can they provide...?
    lead.comp_financial_statements int 1 True (1) or False (0). Can they provide...?
    lead.personal_business_tax_returns int 1 True (1) or False (0). Can they provide...?
    lead.pl_balance_sheet int 1 True (1) or False (0). Can they provide...?
    lead.business_credit_history string The business's credit history. Must be one of these strings: Good, No Credit History, Paid Defaults,Unpaid Defaults, Ex Bankrupt, Not Sure.
    lead.force_send bool If you want the lead to be sent to the first matched lender even if the application isn't 100% complete, set this to true. Note: Mandatory fields are still required. This setting overrides the send_type below, but will only send to the first lender. You need to use send_type Auto if you want it send to additional lenders.
    lead.send_type string 6 Default is Auto. Accepts Auto or Manual. This is the send method. Set to Manual when you want to manually send from within the Lend platform, or set to Auto if you want the lead to be sent automatically once it's 100% complete.
    lead.who_to_contact string 6 Default is Client. Accepts Broker or Client. This is who you would like the lenders to liaise with in regards to the application.
    marketing.ga_client_id string 25 For additional tracking purposes you can add a google analytics client id.
    marketing.gclid string 100 For additional tracking purposes you can add a google ads click id.
    marketing.utm_source string 100 For additional tracking purposes you can tag a source.
    marketing.utm_medium string 100 For additional tracking purposes you can tag a medium.
    marketing.utm_campaign string 100 For additional tracking purposes you can tag a campaign.
    marketing.utm_content string 100 You can add additional info such as content.
    marketing.utm_term string 100 You can add additional info such as a term range.
    lead_notes Array Array - Lead notes can be included. These notes are for internal use for you to see in the Lend platform, they are not sent to lenders.
    lead_notes[x].notes string 1000 The note. Note: You can add multiple notes in an array.

    Example Request Body:

          {
        "send_email_to_client": 0,
        "broker_assigned" : "xxxxxxx",
        "owner": {
          "title": "Mr",
          "first_name": "John",
          "middle_name": "Jack",
          "last_name": "Doe",
          "contact_number": "0444222333",
          "email": "[email protected]",
          "dob": "1988-12-31",
          "gender": "Male",
          "marital_status": "Single",
          "home_owner": 2,
          "home_owner_detail": "Any extra info regarding living arrangements",
          "address": "1 Taylor Street",
          "suburb": "Moorabbin",
          "state": "VIC",
          "postcode": "3189",
          "owner_type": 1,
          "equity": 95,
          "security_type": "Property (Residential)",
          "security_type_detail": "Other",
          "estimated_value": 500000.00,
          "remaining_debt": 200000.00,
          "driving_licence_num": "xxxxxxxxx",
          "driving_licence_expiry": "2025-12-31",
          "driving_licence_state": "VIC",
          "driving_licence_type": "Full",
          "medicare_number": "00114399",
          "medicare_ref": "1"
          "medicare_card_colour": "Green",
          "medicare_expiry": "02-05-21",
          "passport_number": "025597217",
          "passport_country": "Australia",
          "passport_expiry": "2030-03-17",
          "credit_history": "Good"
          "consent": 2024-04-01",
          "is_guarantor": 0,
          "number_of_dependants": 0,
          "dependant_details": "No Dependants",
          "residency_status": "Citizen"
        },
        "lead": {
          "product_type_id": 10,
          "campaign": "facebook_1",
          "referer": "mysite.com/page1"
          "partner_external_ref": "abc123xyz",
          "abn": "12612877442",
          "business_name": "Doe Gardening",
          "organisation_name": "Doe Gardening Pty Ltd",
          "company_registration_date": "2018-12-31",
          "loan_term_requested": 12,
          "industry_id": 52,
          "industry_detail": "Any extra info regarding Industry",
          "b_address": "1 Taylor Street",
          "b_suburb": "Moorabbin",
          "b_state": "VIC",
          "b_postcode": "3201",
          "b_country": "Australia",
          "purpose_id": 3,
          "equipment_id": 3,
          "equipment_condition": "Used",
          "equipment_year": 2023
          "equipment_found": 1,
          "equipment_source": "Dealer",
          "has_customer_type": 1,
          "customer_type": "Both",
          "invoice_amount_outstanding": 56800,
          "number_of_invoices": 21,
          "amount_requested": 65000,
          "sales_monthly": 47000.00,
          "monthly_expenses": 39000.00,
          "tax_outstanding": 1,
          "tax_outstanding_arrangement": 1,
          "tax_overdue": 20000.00,
          "bs_doc_id": "Z9ND3K5D2",
          "overdraft_loc_limit": 5000.00,
          "bank_statements": 1,
          "ato_portal": 1,
          "bas_statements" 1,
          "prev_asset_finance": 0,
          "comp_financial_statements": 0,
          "personal_business_tax_returns": 1,
          "pl_balance_sheet": 1
          "business_credit_history": "Good",
          "force_send": 0,
          "send_type": "Manual",
          "who_to_contact": "Client"
        },
        "marketing": {
          "ga_client_id": "12345"
          "gclid": "56789"
          "utm_source": "g_ads"
          "utm_medium": "search"
          "utm_campaign": "nsw"
          "utm_term": "4-6yrs"
          "utm_content": "blah"
        },
        "lead_notes": [
          {
            "notes": "note 1"
          },
          {
            "notes": "note 2"
          }
        ]
      }


  • Response 200

    • This is the response if your lead submission was successful.
    • success will be a boolean, and should always be true.
    • 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": false
      }


  • Response 422

    • This is the response if your lead submission contains any missing or incorrect data.
    • success will be a boolean, and will always be false.
    • 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 be false.
    • 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"
        }
      }


# Submit New Consumer Lead

To submit a new consumer lead into your Lend Platform account you can use this API. Note when using the sandbox environment for testing you will only be able to see the API response, there is no UI to login to.

  • Request URL: /api/leads

  • Example URL: https://partners.lend.com.au/api/leads

  • Method: POST

  • Request Body:

    Field Type Length Required Other Info
    broker_assigned string 7 If you want to assign this lead to a specific user 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)
    lead.lead_type string 10 Yes Must be Consumer
    lead.product_type_id int 11 Yes Must be 25 for Asset Finance (i.e. pass lead.product_type_id 25 when using the first 4 purposes below) or 26 for Personal Loan (i.e. pass lead.product_type_id 26 when using any of the personal loan purposes below).
    lead.purpose_id int 2 Yes This is a purpose_id. The consumer values are as follows...
    Asset Finance:
    20 Car
    21 Motorcycle
    22 Caravan
    23 Other Vehicle.
    Personal Loan:
    25 Debt Consolidation
    26 Home Improvement
    27 Holiday
    28 Wedding
    29 Professional Service Fees
    30 Business
    31 Investment
    32 Funeral
    33 Vehicle
    34 Recreational Vehicle
    35 Sporting Equipment
    36 Medical
    37 Dental
    38 Bills
    39 Vehicle Repairs
    40 Other
    lead.purpose_other string 255 Useful when lead.purpose_id is 40 Other.
    lead.campaign string 60 For tracking purposes you can pass the campaign name.
    lead.referer string 255 For tracking purposes you can pass the http referer url.
    lead.partner_external_ref string 50 You can include your own unique lead reference. Ensure each lead has a unique reference.
    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 a GET request to the /api/configs/loanterms API.
    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.amount_requested decimal 10,2 Yes The finance amount.
    lead.company_registration_date date Yes API was designed for commercial use, to enable brokers to add consumer leads via API workaround includes adding a date here (i.e. 2024-01-01) Must be in YYYY-MM-DD format.
    lead.organisation_name string 255 Yes API was designed for commercial use, to enable brokers to add consumer leads via API workaround includes adding a value here (i.e. Not Applicable, or NA)
    lead.b_country string 2 API was designed for commercial use, to enable brokers to add consumer leads via API workaround includes adding a value here, use AU.
    lead.industry_id int 11 Yes API was designed for commercial use, to enable brokers to add consumer leads via API workaround includes adding an ID here, use 57.
    lead.sales_monthly decimal 10,2 Yes API was designed for commercial use, to enable brokers to add consumer leads via API workaround includes adding a value here, use 50.
    lead.send_type string 6 Yes API was designed for commercial use, to enable brokers to add consumer leads via API workaround includes adding a value here, use Manual.
    owner.title string Only include applicant 1. Must be Mr, Mrs, Miss, Ms
    owner.first_name string 60 Yes
    owner.middle_name string 50
    owner.last_name string 60 Yes
    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.dob date Date must be in YYYY-MM-DD format. Cannot be future date.
    owner.gender string Must be Female, Male
    owner.marital_status string Must be Single, Married, De facto
    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.driving_licence_type string Must be Full, Provisional, Learner, Heavy Vehicle, None, Overseas
    owner.medicare_number string 12 Medicare number.
    owner.medicare_ref string 2 The number next to the relevant name on the Medicare card.
    owner.medicare_card_colour string Must be Green, Yellow, Blue
    owner.medicare_expiry date Must be in YYYY-MM-DD format.
    owner.passport_number string 100 Passport number.
    owner.passport_country string 100 Passport country of issue.
    owner.passport_expiry date Must be in YYYY-MM-DD format.
    owner.credit_history string The applicant's credit history. Must be one of these strings: Good,No Credit History,Paid Defaults,Unpaid Defaults,Ex Bankrupt,Not Sure
    owner.consent datetime If the applicant has provided consent for you to pull a personal credit file check pass the date of consent. Must be in YYYY-MM-DD format.
    owner.number_of_dependants int 11 The number of dependants the applicant has.
    owner.dependant_details string Any extra details on dependants.
    owner.residency_status string Must be Citizen, Permanent Resident, Visa
    lead_owner_addresses Array Array - Only for include applicant 1.
    lead_owner_addresses[x].living_status enum Must be Owned Outright, Mortgaged, Renting, Boarding, Living with parents, Other
    lead_owner_addresses[x]
    .living_status_other    		 string 50 Useful if living_status is Other, to provide any extra information regarding their living situation.
    lead_owner_addresses[x]
    .landlord_name    		 string 100 Note, ONLY include when lead_owner_addresses[x].living_status is Renting, else omit this field.
    lead_owner_addresses[x]
    .landlord_contact_number    		 string 10 Note, ONLY include when lead_owner_addresses[x].living_status is Renting, else omit this field. Must be a valid AU number, country code is not required.
    lead_owner_addresses[x].address string 100 This is the first line of the address for the applicant (including unit numbers).
    lead_owner_addresses[x].suburb string 50 Applicant's suburb.
    lead_owner_addresses[x].state enum Applicant's state. Must be ACT, NSW, VIC, QLD, SA, WA, TAS, NT
    lead_owner_addresses[x].postcode string 4 Applicant's postcode.
    lead_owner_addresses[x].country string 2 Applicant's country code. Use AU.
    lead_owner_addresses[x].date_from date The date they moved in. Date must be in YYYY-MM-DD format. Cannot be future date.
    lead_owner_addresses[x].date_to date Pass null for current address.
    lead_owner_employments Array Array - Only include for applicant 1.
    lead_owner_employments[x]
    .lead_owner_occupation_id    		 int 11 This is a occupation_id from our occupation picklist. You can access the latest list by sending a GET request to the /api/configs/occupations API.
    lead_owner_employments[x]
    .employer    		 string 255 Employer name.
    lead_owner_employments[x]
    .employment_type    		 enum This is a employment_type from our employment types picklist. You can access the latest list by sending a GET request to the /api/configs/employment-types API.
    lead_owner_employments[x]
    .date_from    		 date The date they started. Date must be in YYYY-MM-DD format. Cannot be future date.
    lead_owner_employments[x]
    .date_to    		 date Pass null for current employment.
    lead_owner_incomes Array Array - Only include for applicant 1.
    lead_owner_incomes[x]
    .config_income_id    		 int 11 The config_income_id options are:
    1 Salary / Wages
    2 Rental Income
    3 Other Investments
    4 Centrelink and Family Benefits
    5 Superannuation
    6 Other Income
    lead_owner_incomes[x].amount decimal 10,2 The amount for this income type. (Monthly)
    lead_owner_incomes[x].note string 100 Any note about this income type.
    lead_asset_finance.equipment_id int 11 Required when lead.product_type_id is 25 The following lead_asset_finance fields are only for Asset Finance (when lead.product_type_id is 25). This is a equipment_id from our loan equipment types picklist. You can access the latest list of equipment types by sending a GET request to the /api/configs/equipment API.
    lead_asset_finance.sale_type enum Must be Dealer, Private Sale, Auction, Unsure, Refinance
    lead_asset_finance.is_vehicle_found int 1 True (1) or False (0). If they have already found the asset.
    lead_asset_finance.condition enum Asset condition. Must be New, Used, Demo, Unsure
    lead_asset_finance.year string 4 The year of the asset. Must be in YYYY format.
    lead_asset_finance.make string 100 The make of the asset. (i.e. Ford)
    lead_asset_finance.model string 100 The model of the asset. (i.e. Ranger)
    lead_asset_finance.variant string 255 The model variant. (i.e. Jan FX4 3.2 (4x4) PX MKIII MY21.75 DOUBLE CAB P/UP)
    lead_asset_finance
    .engine_transmission    		 string 254 The engine and trans description. (i.e. 6 SP MANUAL TURBO CDI)
    lead_asset_finance.transmission enum The trans type. Must be Auto, Manual
    lead_asset_finance.num_cyl enum The number of cylinders. Must be 2, 4, 6, 8, 10, 12, 16)
    lead_asset_finance.engine string 125 The engine number.
    lead_asset_finance.vin string 30 The vehicle/asset identification number.
    lead_asset_finance.rego string 20 The registration plate number.
    lead_asset_finance.rego_state enum 10 The state of registration. Must be ACT, NSW, VIC, QLD, SA, WA, TAS, NT
    lead_asset_finance.odometer int 11 The kms or miles or hours.
    lead_asset_finance.colour string 20
    lead_asset_finance
    .asset_purchase_price    		 decimal 10,2 The purchase price. Whole figures or 2 decimal places are accepted (example: 45000 and 45000.00 are both accepted).
    lead_asset_finance.asset_deposit decimal 10,2 Deposit amount if applicable. Whole figures or 2 decimal places are accepted (example: 5000 and 5000.00 are both accepted).
    lead_asset_finance.tradein_value decimal 10,2 Trade-in amount if applicable. Whole figures or 2 decimal places are accepted (example: 5000 and 5000.00 are both accepted).
    lead_asset_finance.outstanding_loan decimal 10,2 Outstanding loan amount if applicable. Whole figures or 2 decimal places are accepted (example: 5000 and 5000.00 are both accepted).
    lead_asset_finance.insurance_addon decimal 10,2 Insurance amount, if adding to finance. Whole figures or 2 decimal places are accepted (example: 2000 and 2000.00 are both accepted).
    lead_asset_finance.other_addons decimal 10,2 Other amount to add to finance. Whole figures or 2 decimal places are accepted (example: 1000 and 1000.00 are both accepted).
    lead_asset_finance.asset_balloon decimal 10,2 The balloon payment amount. Can be in $ or %. Ensure the following field specifies. Whole figures or 2 decimal places are accepted (example: 5000 and 5000.00 are both accepted).
    lead_asset_finance
    .balloon_percent_or_value    		 string 10 Balloon in $ or %. Must be value for $, or percent for %.
    lead_asset_finance.balloon_reason enum Must be LowerMonthlyPayment, PlannedUpgradeOfVehicle, Other
    lead_asset_finance
    .balloon_reason_explanation    		 string 500 The explanation for compliance.
    lead_asset_finance
    .balloon_pay_method    		 string 10 Must be TradeIn, Cash, Refinance
    lead_asset_finance.finance_amount decimal 10,2 Required when
    lead.product_type_id is 25    		 The finance amount.
    lead_asset_finance.manual_valuation decimal 10,2 The asset valuation.
    lead_asset_finance.ltv string 10 The loan to value ratio.
    lead_asset_finance.supplier string 255 The supplier name.
    lead_asset_finance.supplier_email string 254 The supplier email.
    lead_asset_finance
    .supplier_contact_name    		 string 100 The supplier contact person.
    lead_asset_finance
    .supplier_contact_number    		 string 20 The supplier contact person number.
    lead_asset_finance.supplier_quote_ref string 100 The supplier quote ref.
    marketing.ga_client_id string 25 For additional tracking purposes you can add a google analytics client id.
    marketing.gclid string 100 For additional tracking purposes you can add a google ads click id.
    marketing.utm_source string 100 For additional tracking purposes you can tag a source.
    marketing.utm_medium string 100 For additional tracking purposes you can tag a medium.
    marketing.utm_campaign string 100 For additional tracking purposes you can tag a campaign.
    marketing.utm_content string 100 You can add additional info such as content.
    marketing.utm_term string 100 You can add additional info such as a term range.
    lead_notes Array Array - Lead notes can be included. These notes are for internal use for you to see in the Lend platform, they are not sent to lenders.
    lead_notes[x].notes string 1000 The note. Note: You can add multiple notes in an array.

    Example Request Body:

          {
        "broker_assigned" : "xxxxxxx",
        "lead": {
          "lead_type": "Consumer",
          "product_type_id": 25,
          "purpose_id": 20,
          "campaign": "facebook_1",
          "referer": "mysite.com/page1"
          "partner_external_ref": "abc123xyz",
          "loan_term_requested": 60,
          "bs_doc_id": "Z9ND3K5D2",
          "amount_requested": 56000,
          "organisation_name": "NA",
          "company_registration_date": "2024-01-01",
          "industry_id": 57,
          "b_country": "AU",
          "sales_monthly": 50,
          "send_type": "Manual"
        },
        "owner": {
          "title": "Mr",
          "first_name": "John",
          "middle_name": "Jack",
          "last_name": "Doe",
          "contact_number": "0444222333",
          "email": "[email protected]",
          "dob": "1988-12-31",
          "gender": "Male",
          "marital_status": "Single",
          "driving_licence_num": "xxxxxxxxx",
          "driving_licence_expiry": "2025-12-31",
          "driving_licence_state": "VIC",
          "driving_licence_type": "Full",
          "medicare_number": "00114399",
          "medicare_ref": "1"
          "medicare_card_colour": "Green",
          "medicare_expiry": "02-05-21",
          "passport_number": "025597217",
          "passport_country": "Australia",
          "passport_expiry": "2030-03-17",
          "credit_history": "Good"
          "consent": 2024-04-01",
          "number_of_dependants": 0,
          "dependant_details": "No Dependants",
          "residency_status": "Citizen"
        },
        "lead_owner_employments": [
          {
            "lead_owner_occupation_id": 1,
            "employer": "Testing",
            "employment_type": "Permanent Full Time",
            "date_from": "2022-01-01",
            "date_to": null
          }
        ],
        "lead_owner_incomes": [
          {
            "config_income_id": 1,
            "amount": 10000,
            "note": "testing"
          }
        ],
        "lead_owner_addresses": [
          {
            "living_status": "Other",
            "living_status_other": "Testing",
            "landlord_name": "Test",
            "landlord_contact_number": "0400000000",
            "address": "1 Test St",
            "suburb": "Melbourne",
            "state": "VIC",
            "postcode": 3000,
            "country": "AU",
            "date_from": "2022-01-01",
            "date_to": null
          }
        ],
        "lead_asset_finance": {
          "equipment_id": 1,
          "sale_type": "Dealer",
          "is_vehicle_found": true,
          "condition": “Used”,
          "year": "2024”,
          "make": "TOYOTA",
          "model": "CAMRY",
          "variant": "Jan ASCENT + SAT NAV AXVA70R 4D SEDAN",
          "engine_transmission": null,
          "transmission": "Auto",
          "num_cyl": 2,
          "engine": "112233",
          "vin": "1234567890",
          "rego": "TEST12",
          "rego_state": "VIC",
          "odometer": 10000,
          "colour": "Red",
          "asset_purchase_price": 45000,
          "asset_deposit": 5000,
          "asset_tradein_value": 10000,
          "outstanding_loan": 20000,
          "insurance_addon": 2000,
          "other_addons": 4000,
          "asset_balloon": 10,
          "balloon_percent_or_value": "percent",
          "balloon_reason": "PlannedUpgradeOfVehicle",
          "balloon_reason_explanation": null,
          "balloon_pay_method": "TradeIn",
          "finance_amount": "56000",
          "manual_valuation": 46000,
          "ltv": 122,
          "supplier": "Test Supplier",
          "supplier_email": "[email protected]",
          "supplier_contact_name": "John Smith",
          "supplier_contact_number": "0400000000",
          "supplier_quote_ref": "TEST1234"
        },
        "marketing": {
          "ga_client_id": "12345"
          "gclid": "56789"
          "utm_source": "g_ads"
          "utm_medium": "search"
          "utm_campaign": "vic"
          "utm_term": "4-6yrs"
          "utm_content": "blah"
        },
        "lead_notes": [
          {
            "notes": "note 1"
          },
          {
            "notes": "note 2"
          }
        ]
      }


  • Response 200

    • This is the response if your lead submission was successful.
    • success will be a boolean, and should always be true.
    • 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.
    • The email_sent_to_client informs you if we have successfully sent an email to your client asking to complete the online form. Not for consumer.

    Example Response:

          {
        "success": true,
        "ref": "22nPwwU",
        "lead_completion": "95%",
        "email_sent_to_client": false
      }


  • Response 422

    • This is the response if your lead submission contains any missing or incorrect data.
    • success will be a boolean, and will always be false.
    • 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 be false.
    • 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"
        }
      }


# View All Leads

If you want to view all the leads in your account since a specific date that you provide. Note this is designed for commercial leads, not consumer leads.

  • 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 be true.
    • 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. Note this is designed for commercial leads, not consumer leads.

  • 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 be true.
    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 be false.
    • data.error will be a string describing the error.

    Example Response:

          {
        "success": false,
        "data": {
          "error": "No lead was found with that lead_ref"
        }
      }


  • 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 be false.
    • 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.

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",
            },
          ]
        }

# Occupations

Access the full list of occupations that we support (including their unique ID's).

  • Method: GET
  • Request URL: /api/configs/occupations

Below is a sample list, the real response contains more.

Example Response

        {
          "success": true,
          "occupations": [
            {
              "id": 1,
              "occupation": "Chief Executive or Managing Director",
              "is_au": true,
              "is_nz": false
            }
          ]
        }

# Employment Types

Access the full list of employment types that we support (including their unique ID's).

  • Method: GET
  • Request URL: /api/configs/employment-types

Below is a sample list, the real response contains more.

Example Response

        {
          "success": true,
          "employment_types": [
            "Permanent Full Time",
            "Permanent Part Time",
            "Casual Full Time",
            "Casual Part Time",
            "Self Employed Contractor",
            "Pensioner",
            "Self Funded Retiree",
            "Contract",
            "Unemployed",
            "Student",
            "Houseperson",
            "Centerlink",
            "Other"
          ]
        }