Introduction

The Lead Enrollment API transitions the approved offer into an active client account. This is Phase 4 (the final phase) of the DebtCore API workflow, occurring after offer selection.

The service is built around GraphQL - all calls are simply POST requests to the service endpoint.

Prerequisites

Before calling the Lead Enrollment API, you must have:

1. A saved offer with a valid offerId (referenced as ogId) from the Offer Generation API
2. The id of the lead in your own internal system (for tracking purposes)
3. Plan details for monthly expenses and monthly income breakdowns, and employment classification

How It Works

Enrollment Execution

Use createEnrollment to kick off the process of generating the client file in the CRM. The ogId is used to create the enrollment and is linked to a generated enrollmentId, triggering the internal workflows required to activate the customer’s program.

Required Fields

Field	Description
ogId	The offer generation ID (offerId) from the Offer Generation API
leadId	The ID of the lead in your internal system
planDetails	Income, expenses, and job classification details for enrollment

Data Fetching

The service will use the entered in ogId to automatically fetch the data needed from the offer and underwriting results to create the enrollment.

Lifecycle Tracking

After submitting a request to createEnrollment you will receive an enrollmentId in the response. Use enrollmentStatus with the enrollmentId to provide real-time updates on each step of the enrollment creation.

API Operations

Operation	Description
createEnrollment	Create the client file using the selected offer plan
enrollmentStatus	Track progress on enrollment creation

Additionally, there is an optional contactInfo field that can be used to inject the enrollment with more information. More details can be found in the API Reference section under createEnrollment.

Enrollment Status Steps

The enrollmentStatus response includes statuses for individual background steps:

• qaCall - QA call status
• createContact - Contact creation in CRM
• createEnrollmentPlan - Enrollment plan draft creation
• createNotes - Notes creation
• createDebts - Debt records creation
• createBudget - Budget setup
• createBankAccount - Bank account linking
• createDocuments - Document generation

Each step reports: PENDING, IN_PROGRESS, COMPLETED, SKIPPED, or FAILED

Key Features

• Full client file creation in CRM
• Support for both individual and joint applications
• Multi-language support (English/Spanish)
• Co-applicant linking
• Comprehensive address and contact management
• Real-time enrollment status tracking
• Automated data validation against underwriting records

Next Steps

• Create Enrollment - Create client enrollments
• Enrollment Status - Track enrollment progress
• Error Codes - Reference documentation