> ## Documentation Index
> Fetch the complete documentation index at: https://docs.incentives.leap.energy/llms.txt
> Use this file to discover all available pages before exploring further.
# Quickstart
> Embed an offer for customers to claim incentives after purchase and installation
## Setup
Leap will share an API Key for authenticating requests.
Send your list of devices and Leap will return the list with `device_id` mapped for your API requests.
Define which data fields your system will provide vs. what customers will enter directly.
## Check Eligibility & Get URL
Check a customer's eligibility for incentives. Leap will return a Connect URL which customers use to submit applications across all eligible programs.
### Request
```json theme={null}
POST /incentives
{
"operation_type": "lookup",
"reference_id": "ref-12345",
"address": {
"street_1": "456 Main St",
"street_2": "Apt 2B",
"city": "Bend",
"state_or_province_code": "OR",
"postal_code": "97701",
"country_code": "US"
},
"building_type": "RESIDENTIAL",
"device_ids": [123],
"create_application": true
}
```
### Response Examples
```json theme={null}
{
"utility": {
"eiaid": "14354",
"name": "PacifiCorp (Oregon)"
},
"possible_utilities": [
{
"eiaid": "14354",
"name": "PacifiCorp (Oregon)"
}
],
"address": "456 Main St, Apt 2B, Bend, OR, 97701",
"building_type": "RESIDENTIAL",
"customer_id": 453,
"programs_evaluated": 2,
"incentives": {
"total_incentive_amount": 750,
"total_eligible_combinations": 1,
"by_program": [
{
"program_id": 838,
"program_name": "Pacific Power – Oregon \"Charge at Home\" EV Charger Rebate",
"total_incentive": 750,
"eligible_combinations": 1,
"processing_enabled": true,
"device_tier_results": [
{
"device_id": 123,
"device_name": "Level 2 EV Charger",
"tier_id": 456,
"tier_name": "Standard Rebate",
"eligible": true,
"incentive_amount": 750,
"calculation_details": "Fixed rebate per device: $750",
"failed_requirements": [],
"ignored_requirements": [
"Installation must be within 90 days of application",
"Must use licensed contractor"
],
"completed_requirements": []
}
]
}
]
},
"processing_summary": {
"program_ids": [838],
"incentive_amount": 750
},
"connect_url": "https://connect.incentives.leap.energy/your-company/refId/ref-12345",
"reference_id": "ref-12345"
}
```
```json theme={null}
{
"utility": {
"eiaid": "15248",
"name": "Portland General Electric Co"
},
"possible_utilities": [
{
"eiaid": "15248",
"name": "Portland General Electric Co"
}
],
"address": "100 SW Main St, Portland, OR, 97204",
"building_type": "RESIDENTIAL",
"customer_id": 454,
"programs_evaluated": 1,
"incentives": {
"total_incentive_amount": 0,
"total_eligible_combinations": 0,
"by_program": [
{
"program_id": 900,
"program_name": "PGE Smart Charging – Tesla Telematics Path",
"total_incentive": 0,
"eligible_combinations": 0,
"processing_enabled": true,
"device_tier_results": [
{
"device_id": 123,
"device_name": "Dumb Level 1 Charger",
"tier_id": 501,
"tier_name": "Smart Charger Tier",
"eligible": false,
"incentive_amount": 0,
"calculation_details": "Device does not meet tier requirements",
"failed_requirements": [
"Device not OCPP compliant",
"Charger level must be at least LEVEL_2"
],
"ignored_requirements": [],
"completed_requirements": []
}
]
}
]
},
"processing_summary": {
"program_ids": [],
"incentive_amount": 0
},
"connect_url": "",
"reference_id": "ref-67890"
}
```
```json theme={null}
{
"utility": {
"eiaid": "17609",
"name": "Sacramento Municipal Util Dist"
},
"possible_utilities": [
{
"eiaid": "17609",
"name": "Sacramento Municipal Util Dist"
}
],
"address": "789 Oak Avenue, Sacramento, CA, 95814",
"building_type": "RESIDENTIAL",
"customer_id": 455,
"programs_evaluated": 2,
"incentives": {
"total_incentive_amount": 1250,
"total_eligible_combinations": 2,
"by_program": [
{
"program_id": 1001,
"program_name": "SMUD Charge@Home EV Rebates",
"total_incentive": 500,
"eligible_combinations": 1,
"processing_enabled": true,
"device_tier_results": [
{
"device_id": 123,
"device_name": "Level 2 EV Charger",
"tier_id": 789,
"tier_name": "Standard Tier",
"eligible": true,
"incentive_amount": 500,
"calculation_details": "Fixed rebate per device: $500",
"failed_requirements": [],
"ignored_requirements": [
"Installation must be within 90 days of application"
],
"completed_requirements": []
}
]
},
{
"program_id": 1002,
"program_name": "SMUD Go Electric Bonus – Residential Panel-Upgrade & Make-Ready Rebate",
"total_incentive": 750,
"eligible_combinations": 1,
"processing_enabled": false,
"device_tier_results": [
{
"device_id": 456,
"device_name": "Electric Panel Upgrade",
"tier_id": 790,
"tier_name": "Panel Make Ready",
"eligible": true,
"incentive_amount": 750,
"calculation_details": "Fixed rebate per device: $750",
"failed_requirements": [],
"ignored_requirements": [
"Must use licensed contractor"
],
"completed_requirements": []
}
]
}
]
},
"processing_summary": {
"program_ids": [1001],
"incentive_amount": 500
},
"connect_url": "https://connect.incentives.leap.energy/your-company/refId/ref-24680",
"reference_id": "ref-24680"
}
```
In this example, two programs are evaluated but only `SMUD Charge@Home EV Rebates` has `processing_enabled: true`. The `processing_summary` reflects only that program — `incentive_amount: 500` — because that's the offer Leap can complete an application for today. The `incentives.total_incentive_amount: 1250` includes both programs and is useful for forecasting; the `processing_summary.incentive_amount` is what to surface to the customer right now.
## Place in Your App Flow
Place the offer to Claim Incentives inside your customer journey.
Send the incentive link in your order confirmation or follow-up emails
Display immediately after purchase completion
Integrate into your product setup or onboarding flow
## Customer Fills the Application
Customer completes the application in Leap Connect. After completion, application\_status is updated to `awaiting_partner` or `completed`.
The customer will provide required documentation and consent for data sharing during this step.
## Upload Claimed Fields
Provide information to complete the customer's application.
### Step 1: Search for Applications
Search for applications in `awaiting_partner` status. Applications are automatically filtered to your organization.
```http theme={null}
GET /applications?application_status=awaiting_partner
x-api-key: YOUR_API_KEY
```
**Response:**
```json theme={null}
{
"next_page_token": null,
"results": [
{
"id": 123,
"program_id": 339,
"customer_id": 609,
"customer_device_id": [45],
"status": "awaiting_partner",
"rebate_type": "instant",
"payee_type": "customer",
"total_requested_amount": 1500.00,
"created_at": "2025-01-10T15:30:00Z",
"updated_at": "2025-01-15T10:45:00Z",
"customer": {
"id": 609,
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone": "555-123-4567",
"address_line1": "123 Main St",
"city": "Atlanta",
"state": "GA",
"zip_code": "30303"
}
}
]
}
```
### Step 2: Update Application
Upload partner data using the application ID from the search results.
```http theme={null}
PATCH /applications/123
x-api-key: YOUR_API_KEY
```
**Request:**
```json theme={null}
{
"status": "completed",
"customer": {
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"phone": "555-1234"
},
"customer_devices": [
{
"id": 45,
"purchase_date": "2025-01-15",
"installation_date": "2025-01-20",
"contractor_name": "ABC Electric",
"contractor_license": "EC-12345"
}
]
}
```
This endpoint requires API key authentication via `x-api-key` header. The application must belong to your organization.
The PATCH endpoint supports partial updates - only include fields you want to modify. Application fields can be updated at the top level (e.g., `status`, `approval_date`), and customer/devices can be updated in nested objects.