Quantiv API (1.0.0)

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!

🧐 Overview

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.

🚀 Getting Started

To get started with Quantiv API Products you will need to follow these steps:

  1. Contact the Quantiv representative via our website.
  2. Sign an agreement with Quantiv.
  3. Receive your sandbox and production API keys.
  4. Receive an invite to the Customer Portal, where you can track API usage and billing details.

🌐 Endpoint

The Quantiv API uses a single endpoint for both sandbox and production environments.

EnvironmentEndpoint URL
Sandboxhttps://public-api.quantiv.io
Productionhttps://public-api.quantiv.io

🔐 Authentication

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.

📝 Response Status Codes

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 CodeStatus MessageDescription
200SuccessThe request was successfully processed.
400Bad RequestThe request was malformed or had invalid syntax.
401UnauthorizedThe provided authentication credentials were invalid.
404Not FoundThe requested resource could not be located.
500Internal Server ErrorAn error occurred on the server while processing the request.

⚠️ Business Errors

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.

CaseErrorStatusCodeMessage
Incorrect Payment StatusBad Request400Account is paused due to failed payment. Contact Quantiv Admin.
Inactive API Product TriggeredBad Request400Product is not activated. Contact Quantiv Admin.
Reaching API Usage LimitBad Request400API Monthly Limit is reached. Contact Quantiv Admin.
Reaching $0 Account BalanceBad Request400Insufficient Account Balance to process request. Contact Quantiv Admin.
Download OpenAPI description
Languages
Servers
Mock server
https://docs.quantiv.io/_mock/api/
https://public-api.quantiv.io/

Lead Append Level 1

Method to retrieve property details based on the provided information.

Operations

Lead Append Level 2

Method to retrieve property details, Lead Integrity Score and Defects based on the provided information.

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:

ScoreQuality LevelDescription
nullUnknownLead quality can not be determined.
10–9OutstandingHighest lead quality.
8–7StrongReliable lead.
6–5ModerateAverage lead quality.
4–3WeakLow-quality lead.
2–1Very WeakVery low lead quality.
0UnreliableUntrustworthy 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:

DefectDescription
nullLead Defects can not be determined.
zoningProperty type is not confirmed as residential.
occupancyProperty is not confirmed as occupied by the owner.
structureStructure is not confirmed as present at the address.
surnameSurname is not confirmed to match one of the names on the deed.
Operations

Buyer Insights

Bayer 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:

  • SurePay™ Score – Evaluates the likelihood of homeowners paying for services, helping contractors mitigate financial risk.
  • Elevate Score – Measures a homeowner’s receptiveness and financial ability to invest upsell opportunities and higher-end home improvements.
  • Buyer Insights Scores – Assesses consumer buying styles across various categories.

Buyer Insights empowers businesses with data-driven insights, enabling smarter decision-making and improved profitability.

SurePay™ Score Values

ValueDescription
nullScore can not be determined.
5High likelihood to perform and meet obligations. High likelihood to qualify for the best interest rates.
4Likely to perform and meet obligations. Likely to qualify for most loans at slightly higher rates.
3Average likelihood to perform and meet obligations. May qualify for some loans at higher rates.
2Poor likelihood to perform and meet obligations. May qualify for some loans at significantly higher rates.
1Unlikely to perform and meet obligations. Highly unlikely to qualify for any loans.

Elevate Score Values

ValueDescription
nullScore can not be determined.
10Extremely Likely
9Highly Likely
8Very Likely
7Somewhat Likely
6Likely
5Somewhat Unlikely
4Very Unlikely
3Highly Unlikely
1-2Extremely Unlikely

Buyer Insights Scores Description

ScoreDescription
Savvy ShopperRationale: 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 LoyalistRationale: 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.
TrendsetterRationale: 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 BuyerRationale: 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 BuyerRationale: 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 PicksRationale: 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

ValueDescription
nullScore can not be determined.
10Extremely Likely
9Highly Likely
8Very Likely
7Somewhat Likely
6Likely
5Somewhat Unlikely
4Very Unlikely
3Highly Unlikely
2Extremely Unlikely
1Unknown

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.

ValueDescription
PThe scores are directly related to the individual (owner) of the address, based on the provided address data.
AThe scores are directly related to a primary member of the household associated with the address, based on the provided address data.
GThe 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.
NNo relevant data could be matched based on the provided information.
Operations