Overview

Welcome to the Carprolive® API.

The Carprolive® API is designed to provide secure, structured access to dealer and integration data through modern JSON endpoints. The platform is intended for vendor integrations, partner applications, and internal development workflows that need dependable access to Carprolive® account data.

Secure Access

Authentication is handled through account-level access and vendor credentials so integrations can be controlled and audited over time.

Structured Responses

Endpoints return JSON payloads designed to be easy to consume in custom apps, portals, middleware, and integration services.

Scalable Documentation

The documentation area is organized to support additional endpoints as the API platform grows beyond the current Deals API.

What the API is for

The Carprolive® API gives approved users and partners a way to retrieve data from the Carprolive® platform without relying on manual exports or direct database access. Each endpoint is intended to support specific integration scenarios such as title processing, account workflows, and future dealer-system connectivity.

Registering for access

To use the API portal, start by creating an account through the registration page. During registration, the system collects your contact information, company name, intended use case, and account password. A vendor key is also generated and stored with your account during the registration process.

After registration, a verification email is sent to the email address you provided. You must verify that email address before your account can be used. Depending on your workflow, account approval may also be required before portal access is fully granted.

Registration flow
Create account → Verify email → Wait for approval → Sign in to the portal → Begin using the available API documentation and credentials.

Getting started

01

Create your portal account

Register through the API portal so your account can be created with the correct contact details and intended use case.

02

Verify your email

Use the link in the verification email to confirm ownership of your email address.

03

Wait for approval

Your account status must be set to approved before login access is granted. Approval is generally within a couple of hours.

04

Sign in to the portal

Once verified and approved, sign in to review your account details, vendor key, and API documentation.

05

Start with the current endpoint docs

Review the current endpoint reference, expected headers, parameters, and example requests before building your integration.

Authentication and access

API access is designed to be controlled through account records and generated keys. In the current system, registered accounts are associated with a generated vendor key, and endpoint access can also be tied to additional integration credentials depending on the endpoint design.

Important
Only use credentials and vendor keys issued for your account. Rotating a vendor key replaces the prior key immediately.

Current documentation structure

The documentation area is organized with a menu on the left and endpoint content on the right. The Overview section provides platform guidance, while each endpoint has its own documentation page. Currently, the Deals API is the first endpoint available in the docs menu.

As more endpoints are added in the future, they can be included in the same documentation structure without changing the overall navigation model.