Skip to content
API Documentation

Introduction

The Alleviate API provides a comprehensive suite of services for debt relief enrollment, credit reporting, underwriting, and offer generation.

What is the Alleviate API?

The Alleviate API provides:

  • Credit Reporting - Pull and analyze credit reports for debt relief applicants
  • Lead Eligibility - Determine applicant and debt eligibility based on configurable rules
  • Offer Generation - Generate personalized debt relief offers and enrollment plans
  • Lead Enrollment - Manage client enrollment workflows and CRM integration

How It Works

1. Credit Reporting

Retrieve credit report data using Credit Reporting

2. Lead Eligibility

Check applicant and debt eligibility via Lead Eligibility

3. Offer Generation

Create personalized offers using Offer Generation

4. Lead Enrollment

Complete enrollment via Lead Enrollment

Enrollment Flow

┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐
│    Credit       │────▶│ Lead Eligibility│────▶│ Offer Generation│
│   Reporting     │     │                 │     │                 │
└─────────────────┘     └─────────────────┘     └─────────────────┘
                                                        │
                                                        ▼
                                                ┌─────────────────┐
                                                │ Lead Enrollment │
                                                │                 │
                                                └─────────────────┘

Service Overview

Credit Reporting

The Credit Reporting API handles credit report retrieval and parsing:

  • Pull soft credit reports from credit bureaus
  • Parse and normalize credit data
  • Support for PDF format

Lead Eligibility

The Lead Eligibility API determines eligibility:

  • Check applicant eligibility based on credit data
  • Evaluate individual debts for settlement eligibility
  • Apply configurable underwriting rules
  • Return detailed eligibility results

Offer Generation

The Offer Generation API creates personalized offers:

  • Generate debt relief offers based on qualified debts
  • Calculate monthly payment plans
  • Create enrollment programs
  • Support multiple offer configurations

Lead Enrollment

The Lead Enrollment API completes the enrollment process:

  • Create enrollments in the CRM system
  • Track enrollment status
  • Manage enrollment workflows

API Technology

The Alleviate API uses GraphQL:

  • Strongly Typed - All inputs and outputs are strictly typed
  • Introspection - Query the schema to discover available operations
  • Single Endpoint - All operations go through one endpoint per environment
  • Flexible Queries - Request only the fields you need

Next Steps

  1. Set up Authentication to get your API credentials
  2. Review the Environments to understand available endpoints
  3. Follow the Full Enrollment Flow to see a complete integration example