Karia
Guides

Generating your first lead

Capture a sales lead in Karia and generate a lease estimate for it

After doing a quick calculation for roughly how much a lease on their chosen vehicle would cost, a prospective customer on your website would like to proceed and get in touch with your sales team.

This guide will show you how to capture that lead in Karia and then create a lease estimate.

Prerequisites

  • Enabled Lead Generation in your sales and origination workspace.
  • Read Quick Start to get your orgId and workspaceId.
  • Read Getting an API Key to get your API key.

Workflow

opt[Generate estimate document]12345678Submit enquiryPOST …/origination/leadLead (id)POST …/lead/{leadId}/estimateEstimate (id)Lead and estimate createdPOST …/estimate/{estimateId}/documentDocument (downloadUrl)CustomerYour appKaria APICustomerYour appKaria API
opt[Generateestimatedocument]12345678SubmitenquiryPOST…/origination/leadLead (id)POST…/lead/{leadId}/estimateEstimate (id)Lead andestimatecreatedPOST…/estimate/{estimateId}/documentDocument(downloadUrl)CustomerYour appKaria APICustomerYour appKaria API
  1. Customer submits an enquiry from your form or sales intake flow.
  2. Your app creates a new lead in Karia.
  3. Use the returned id as the leadId for estimates.
  4. Your app creates a new estimate for the lead.

Optionally, your app can generate the estimate document as well.

Create The Lead

Create the new sales lead with your prospective customer's name and any available contact details. You can provide additional metadata, such as when the lead should be followed up on, external source and external ID, as well as notes for any sales context.

  • Only firstName and lastName are required.
  • Phone number must be in international format: +61400111222.
  • Include a quickEstimateId if you have created a quick estimate for the customer.

Create the lead

Create the lead first. The returned lead ID is required when you create the estimate.
Open reference
POST/organisation/{orgId}/workspace/{workspaceId}/origination/lead
Authorizationv
{
  "type": "Bearer API key"
}
Pathv
Endpoint
/organisation/{orgId}/workspace/{workspaceId}/origination/lead
{
  "orgId": "org_123",
  "workspaceId": "workspace_123"
}
Operation ID
origination.lead.create
Bodyv
{
  "firstName": "Jane",
  "lastName": "Citizen",
  "email": "jane.citizen@example.com",
  "phone": "+61400111222",
  "followUpDate": "2026-11-02T00:00:00.000Z",
  "externalSource": "website_form",
  "externalId": "enquiry_456",
  "notes": "Interested in a 36 month lease on a hybrid SUV"
}
{
  "response": {
    "id": "0196f3a2-7b1c-7d4e-9a2b-3c5d6e7f8a90",
    "referenceId": "LD-A000000000",
    "status": "new",
    "firstName": "Jane",
    "lastName": "Citizen",
    "middleName": null,
    "email": "jane.citizen@example.com",
    "phone": "+61400111222",
    "externalSource": "website_form",
    "externalId": "enquiry_456",
    "followUpDate": "2026-11-02T00:00:00.000Z",
    "assigneeIds": [],
    "contactId": null,
    "contactReferenceId": null,
    "createdAt": "2026-10-26T06:40:00.000Z",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "deletedAt": null,
    "deletedBy": null,
    "lastUpdatedAt": null,
    "lastUpdatedBy": null,
    "lastIngestAt": null,
    "notes": "Interested in a 36 month lease on a hybrid SUV",
    "isMatched": false
  }
}

Create The Estimate

The prospective customer would like to see different lease options, with varying lease terms and vehicle prices to see how that would affect their lease payments. To do so, create estimates for this sales lead with each of the desired lease options.

  • The newest estimate for a lead is current, and creating another estimate for the same lead marks the earlier one as previous.

If omitted, startingPriceType, annualKms and state will default to drive_away_price, 15000 and vic.

Create the estimate

Generate a lease estimate for the lead once it exists. Use the created lead ID in the request path.
Open reference
POST/organisation/{orgId}/workspace/{workspaceId}/origination/lead/{leadId}/estimate
Authorizationv
{
  "type": "Bearer API key"
}
Pathv
Endpoint
/organisation/{orgId}/workspace/{workspaceId}/origination/lead/{leadId}/estimate
{
  "orgId": "org_123",
  "workspaceId": "workspace_123",
  "leadId": "0196f3a2-7b1c-7d4e-9a2b-3c5d6e7f8a90"
}
Operation ID
origination.estimate.create
Bodyv
{
  "salary": 90000,
  "leaseTerm": 36,
  "startingPrice": 50000,
  "startingPriceType": "drive_away_price",
  "payrollCycle": "fortnightly",
  "businessUse": 0,
  "fuelType": "hybrid",
  "annualKms": 15000,
  "state": "nsw"
}
{
  "response": {
    "id": "0196f3a4-1e2f-7a6b-8c3d-4e5f6a7b8c9d",
    "referenceId": "EST-P4N8R2TW6C",
    "leadId": "0196f3a2-7b1c-7d4e-9a2b-3c5d6e7f8a90",
    "status": "current",
    "version": 1,
    "source": "api",
    "documentId": null,
    "settings": {
      "financier": {
        "id": 1,
        "referenceId": "FIN-ABC1234567",
        "name": "Example Financier"
      },
      "product": {
        "id": 1,
        "referenceId": "PRD-DEF2345678",
        "name": "Example Product"
      },
      "budget": {
        "id": 1,
        "referenceId": "BDG-GHI3456789",
        "name": "Example Budget",
        "vehicleCategory": "suv",
        "vehicleSize": "medium"
      }
    },
    "pricing": {
      "driveAwayPrice": "50000.00"
    },
    "finance": {
      "leasePayment": {
        "fortnightly": {
          "exGstAmount": "500.00",
          "gstAmount": "50.00",
          "incGstAmount": "550.00"
        }
      }
    }
  }
}

Generate The Estimate Document

To share the lease estimate details with the customer, you can generate the estimate document.

Generate the estimate document (optional)

Generate a document for the estimate when you want to share it with the customer.
Open reference
POST/organisation/{orgId}/workspace/{workspaceId}/origination/lead/{leadId}/estimate/{estimateId}/document
Authorizationv
{
  "type": "Bearer API key"
}
Pathv
Endpoint
/organisation/{orgId}/workspace/{workspaceId}/origination/lead/{leadId}/estimate/{estimateId}/document
{
  "orgId": "org_123",
  "workspaceId": "workspace_123",
  "leadId": "0196f3a2-7b1c-7d4e-9a2b-3c5d6e7f8a90",
  "estimateId": "0196f3a4-1e2f-7a6b-8c3d-4e5f6a7b8c9d"
}
Operation ID
origination.estimate.generateDocument
Bodyv
{
  "payrollCycle": "fortnightly",
  "fbtMethod": "statutory"
}
{
  "response": {
    "message": "Document generated successfully",
    "presignedUrl": "https://example.com/upload/EST-P4N8R2TW6C-lead-estimate",
    "downloadUrl": "https://example.com/download/EST-P4N8R2TW6C-lead-estimate",
    "documentId": "0196f3a5-9c8d-7e1f-a2b3-5c6d7e8f9a0b",
    "fileName": "EST-P4N8R2TW6C-lead-estimate",
    "documentStatus": "generated"
  }
}

Advanced

Using Quick Estimates to build your own calculator

Calculate a novated lease estimate, then list the estimates your API key has created

Submitting your first deal

Send a sales lead to Karia by creating a contact and then an origination deal

On this page

PrerequisitesWorkflowCreate The LeadCreate The EstimateGenerate The Estimate DocumentAdvancedRelated Docs