Welcome to the Quantiv API documentation!
The Quantiv API empowers developers with seamless access to powerful data-driven solutions. Our suite of APIs enables you to efficiently interact with key resources, automate processes, and enhance your applications with reliable insights.
Whether you're integrating property intelligence, optimizing lead quality assessments, or leveraging advanced data analytics, Quantiv provides the tools you need to drive smarter decisions and maximize efficiency.
Get started today and unlock the full potential of our APIs!
The Quantiv API is organized around REST principles, utilizing standard HTTP methods, response codes, and authentication. It accepts requests with a JSON body and returns responses in JSON format. The API only supports HTTPS-secured communication. Standard HTTP status codes are used to indicate request outcomes. Error responses include error, statusCode, and message fields for clear debugging.
To get started with Quantiv API Products you will need to follow these steps:
The Quantiv API uses a single endpoint for both sandbox and production environments.
| Environment | Endpoint URL |
|---|---|
| Sandbox | https://public-api.quantiv.io |
| Production | https://public-api.quantiv.io |
You will be provided with two API keys. The key with the sandbox prefix should be used for requests to the sandbox environment, while the key with the production prefix should be used for requests to the production environment.
The API key must be included in the token request header for each API request.
The Quantiv API follows standard HTTP response codes to communicate the outcome of an API request. Generally, codes in the 200 range represent successful requests, codes in the 400 range indicate errors in the request, and codes in the 500 range denote server-side issues.
| Status Code | Status Message | Description |
|---|---|---|
| 200 | Success | The request was successfully processed. |
| 400 | Bad Request | The request was malformed or had invalid syntax. |
| 401 | Unauthorized | The provided authentication credentials were invalid. |
| 404 | Not Found | The requested resource could not be located. |
| 500 | Internal Server Error | An error occurred on the server while processing the request. |
The Quantiv API returns a status code of 400 Bad Request for business-related errors. The response will include the details of the error, as outlined in the table below.
| Case | Error | StatusCode | Message |
|---|---|---|---|
| Incorrect Payment Status | Bad Request | 400 | Account is paused due to failed payment. Contact Quantiv Admin. |
| Inactive API Product Triggered | Bad Request | 400 | Product is not activated. Contact Quantiv Admin. |
| Reaching API Usage Limit | Bad Request | 400 | API Monthly Limit is reached. Contact Quantiv Admin. |
| Reaching $0 Account Balance | Bad Request | 400 | Insufficient Account Balance to process request. Contact Quantiv Admin. |
https://docs.quantiv.io/_mock/api/
https://public-api.quantiv.io/
Method to retrieve property details, Lead Integrity Score and Defects based on the provided information.
Note: If any parameter in the response contains a null value, it indicates that the value could not be determined based on the provided data.
Lead Integrity Score indicates the quality of a lead based on various factors such as zoning classification, owner occupancy status, presence of a structure, and surname match. It helps assess the reliability of a lead.
Score Values
| Score | Quality Level | Description |
|---|---|---|
| null | Unknown | Lead quality can not be determined. |
| 10–9 | Outstanding | Highest lead quality. |
| 8–7 | Strong | Reliable lead. |
| 6–5 | Moderate | Average lead quality. |
| 4–3 | Weak | Low-quality lead. |
| 2–1 | Very Weak | Very low lead quality. |
| 0 | Unreliable | Untrustworthy lead. |
Lead Integrity Defects indicates which factors contributed to a lower Lead Integrity Score. These defects highlight potential issues with the lead's reliability.
Defect Values
| Defect | Description |
|---|---|
| null | Lead Defects can not be determined. |
| zoning | Property type is not confirmed as residential. |
| occupancy | Property is not confirmed as occupied by the owner. |
| structure | Structure is not confirmed as present at the address. |
| surname | Surname is not confirmed to match one of the names on the deed. |
Buyer Insights is a comprehensive suite of scoring tools designed to help home services providers assess homeowners' financial reliability, purchasing behavior, and willingness to invest in premium home improvements. It includes:
Buyer Insights empowers businesses with data-driven insights, enabling smarter decision-making and improved profitability.
Note: If any parameter in the response contains a null value, it indicates that the value could not be determined based on the provided data.
SurePay™ Score Values
| Value | Description |
|---|---|
| null | Score can not be determined. |
| 5 | High likelihood to perform and meet obligations. High likelihood to qualify for the best interest rates. |
| 4 | Likely to perform and meet obligations. Likely to qualify for most loans at slightly higher rates. |
| 3 | Average likelihood to perform and meet obligations. May qualify for some loans at higher rates. |
| 2 | Poor likelihood to perform and meet obligations. May qualify for some loans at significantly higher rates. |
| 1 | Unlikely to perform and meet obligations. Highly unlikely to qualify for any loans. |
Elevate Score Values
| Value | Description |
|---|---|
| null | Score can not be determined. |
| 10 | Extremely Likely |
| 9 | Highly Likely |
| 8 | Very Likely |
| 7 | Somewhat Likely |
| 6 | Likely |
| 5 | Somewhat Unlikely |
| 4 | Very Unlikely |
| 3 | Highly Unlikely |
| 1-2 | Extremely Unlikely |
Buyer Insights Scores Description
| Score | Description |
|---|---|
| Savvy Shopper | Rationale: These homeowners conduct extensive research and compare multiple options—not necessarily to find the lowest price, but to ensure they make a well-informed, risk-averse decision. These consumers like to compare prices across different sites before purchasing and typically read online reviews and consumer reports. Sales Approach: Build trust by offering side-by-side comparisons, testimonials, and third-party validations. Reinforce their ability to make an educated decision while subtly guiding them toward your best offering. |
| Brand Loyalist | Rationale: These homeowners have strong brand preferences and believe that reputation equates to reliability. They may challenge recommendations that deviate from their preselected brands. These consumers are willing to pay more for proven and reputable brands. Sales Approach: Align with their existing knowledge by reinforcing brand credibility. Emphasize manufacturer warranties, certifications, and brand-backed guarantees. If proposing alternatives, focus on comparable or superior features rather than price. Educate the consumer about the brand if you sell a product in which brand awareness is limited. |
| Trendsetter | Rationale: These homeowners love being ahead of the curve and are eager to explore innovative, cutting-edge solutions. They value exclusivity and uniqueness in their purchases. These consumers are trendsetters and early adopters of new products. Sales Approach: Present the newest, most innovative products first. Emphasize exclusivity, technological advancements, and the opportunity to be among the first to own the latest home improvement solutions. |
| Budget-Savvy Buyer | Rationale: These homeowners prioritize affordability and perceived value over brand reputation. They tend to emphasize cost-efficiency in their decision-making process. Price is more important to these consumers than brand name. Sales Approach: Present cost-effective solutions that maximize value. Highlight financing options, cost savings over time, and product benefits that justify the investment. Be prepared to handle objections related to pricing. |
| Quality First Buyer | Rationale: These buyers prioritize durability, craftsmanship, and peace of mind over price but may struggle to define what “quality” looks like. Quality matters for these consumers, and they are willing to pay more for fresh ingredients, durable materials, and quality craftsmanship. Sales Approach: Focus on quality differentiators such as superior materials, expert installation, and longevity. Help them visualize potential risks of choosing lower-quality options and reassure them of the long-term value. |
| Impulse Shopper (Can’t Say No) | Rationale: These homeowners are easily persuaded to add features or upgrades that enhance functionality or perceived value. These spenders find it difficult to say 'no' to things that catch their eyes. They recognize they are "spenders" rather than "savers" and appreciate a convenient purchase opportunity. Top of mind = In the cart. Sales Approach: Strategically introduce upgrades and enhancements throughout the conversation. Highlight benefits of add-ons in a way that makes them feel essential rather than optional. Use visual demonstrations to reinforce desirability. |
| Popular Picks | Rationale: These buyers seek social validation and prefer solutions that align with current trends and widely accepted choices. Online reviews and recommendations influence them significantly. Sales Approach: Leverage social proof by showcasing positive customer testimonials, industry trends, and best-selling options. Reinforce that their decision aligns with what other satisfied homeowners are choosing. |
Buyer Insights Values
| Value | Description |
|---|---|
| null | Score can not be determined. |
| 10 | Extremely Likely |
| 9 | Highly Likely |
| 8 | Very Likely |
| 7 | Somewhat Likely |
| 6 | Likely |
| 5 | Somewhat Unlikely |
| 4 | Very Unlikely |
| 3 | Highly Unlikely |
| 2 | Extremely Unlikely |
| 1 | Unknown |
Accuracy Code
The accuracy code specifies the level at which the provided scores are categorized, based on the quality and relevance of the user-supplied data. It indicates the reference point used to generate the insights.
| Value | Description |
|---|---|
| P | The scores are directly related to the individual (owner) of the address, based on the provided address data. |
| A | The scores are directly related to a primary member of the household associated with the address, based on the provided address data. |
| G | The scores reflect the modeled profile of the homeowner based on the typical profile of owners within a narrow geographic area of the provided address data. |
| N | No relevant data could be matched based on the provided information. |
Roof Estimate is a fast, reliable tool for instantly assigning a value to roof replacement leads by calculating the approximate roof area and replacement costs based solely on a property address. Built specifically for roofing contractors, home improvement platforms, and sales engagement tools, it supports top-of-funnel lead generation and enables sales teams to quickly assess project value and prioritize opportunities.
The API processes address-level inputs and optional parameters like roof material and installation pricing per square — to return a detailed approximation that includes roof area (adjusted for pitch), average pitch angle, complexity level, and total estimated replacement cost.
Roof Estimate is designed to deliver consistent, data-backed approximations in real time — not to replace on-site inspections, precise measurements, or detailed proposals. Instead, it equips sales teams with a scalable, automated way to qualify and value leads. By providing relative cost estimates early in the sales cycle, businesses can increase quote-to-close rates, reduce time spent on manual assessments, and focus efforts on the highest-value opportunities.
Note: If any parameter in the response contains a null value, it indicates that the value could not be determined based on the provided data.
Structure Present Confidence Score Values
| Value | Description |
|---|---|
| null | Value could not be determined. |
| 100 | High confidence that rooftop data corresponds to the primary structure at the exact address provided. |
| 50 | Data may correspond to a nearby structure rather than the actual address, indicating a possible issue with the input address. |
When a Score of 50 is Returned
A confidence score of 50 may be returned under the following conditions:
In such cases, the rooftop data returned may not represent the structure located at the submitted address.
Data Accuracy Alerts
The Roof Pitch Alert and Roof Area Alert parameters help identify potentially unreliable or atypical measurement results related to roof pitch or area. These alerts are designed to prompt additional validation or inspection.
Roof Pitch Alert Values
Indicates potential issues with roof pitch estimation.
| Value | Description |
|---|---|
| null | Value could not be determined. |
| NO_ALERTS | No pitch-related alerts detected. |
| LOW_PITCH | Detected pitch is unusually low — possibly due to flat roofs or obstruction. |
| HIGH_PITCH | Detected pitch is unusually high — may indicate steep or complex geometry. |
Roof Area Alert Values
Indicates potential issues with roof area estimation.
| Value | Description |
|---|---|
| null | Value could not be determined. |
| NO_ALERTS | No area-related alerts detected. |
| LOW_AREA | Estimated area is smaller than expected — may be caused by occlusion or missing imagery. |
| HIGH_AREA | Estimated area is larger than expected — could result from multiple structures or over-segmentation. |
When Alerts Are Triggered
Alerts are generated to assist in identifying potentially inaccurate or atypical results based on the roof pitch or area. Common scenarios include:
In such cases, alerts provide a useful prompt for further validation, helping to prioritize follow-up review and ensure more accurate project planning.
GoSolar Index is an analytics tool built exclusively for residential solar sales teams, CRM platforms, and App providers to optimize lead qualification and targeting. This powerful scoring feature combines behavioral signals, sustainability intent, financial indicators, and political orientation to deliver a single, predictive score for every homeowner, improving conversion rates by identifying high-propensity targets.
The API response includes:
Solar providers can integrate the GoSolar Index into their lead scoring systems to improve conversion rates, reduce outreach costs, and personalize customer engagement strategies.
Note: If any parameter in the response contains a null value, it indicates that the value could not be determined based on the provided data.
GoSolar Index and Prospect Fit Level Mapping
| GoSolar Index | Prospect Fit Level |
|---|---|
| 8.33 – 10 | Ideal |
| 5.0 – 8.32 | Moderate |
| 0 – 4.99 | Weak |
Prospect Attitude Message Values
| Lead with emphasis on climate, sustainability, and clean energy considerations. |
| Lead with emphasis on economic benefits, incentives, energy independence, and ROI consideration. |
| Neutral message emphasizing both economic benefits, incentives, independence and renewable energy benefits, and sustainability. |
Accuracy Code
The accuracy code specifies the level at which the provided response is categorized, based on the quality and relevance of the user-supplied data. It indicates the reference point used to generate the insights.
| Value | Description |
|---|---|
| P | GoSolar Index, Prospect Fit Level and Prospect Attitude Message are directly related to the individual (owner) of the address, based on the provided address data. |
| A | GoSolar Index, Prospect Fit Level and Prospect Attitude Message are directly related to a primary member of the household associated with the address, based on the provided address data. |
| G | GoSolar Index, Prospect Fit Level and Prospect Attitude Message reflect the modeled profile of the homeowner based on the typical profile of owners within a narrow geographic area of the provided address data. |
| N | No relevant data could be matched based on the provided information. |
https://docs.quantiv.io/_mock/api/api/v1/gosolar-index
https://public-api.quantiv.io/api/v1/gosolar-index
curl -i -X GET \
'https://docs.quantiv.io/_mock/api/api/v1/gosolar-index?city=string&lastName=string&leadIntegrityScoreOn=true&state=string&streetAddress=string&streetNumber=string&zip=string' \
-H 'Accept: application/json' \
-H 'token: {API Key}'OK
The timestamp when the response was returned. It is provided in ISO 8601 format.
Represents Prospect Fit Level.
Represents Prospect Attitude Message.
The number of years the primary owner has owned the property.
Indicates whether the structure is present at the provided address.
Indicates lead’s quality. Evaluates such parameters, as zoning classification, owner occupied, structure present, surname match. The parameter is returned if leadIntegrityScoreOn parameter = true in query.
{ "timestamp": "2024-08-20T14:30:00Z", "goSolarIndex": 1, "prospectFitLevel": "Ideal", "prospectAttitudeMessage": "Lead with emphasis on renewable energy benefits, community.", "accuracyCode": "P", "primaryOwner": "John M Doe", "secondaryOwner": "Jane Doe", "ownerOccupied": true, "homeBuiltYear": "1990", "yearsInHome": "16", "county": "Douglas", "subdivision": "Castle Oaks", "school": "Somerville", "propertyType": "Residential", "areaBuildingSize": "3023", "scructurePresent": true, "leadIntegrityScore": 7, "leadIntegrityDefects": [ "surname" ] }