Skip to content
API Documentation

Introduction

The Lead Eligibility API (also known as the Underwriting Service) establishes the applicant’s risk profile and qualifies them for debt settlement. This is Phase 2 of the DebtCore API workflow, occurring after credit assessment.

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

Prerequisites

Before calling the Lead Eligibility API, you must have:

  1. A credit report from the Credit Reporting API with reportStatus: 'COMPLETED'
  2. The creditReportId returned from the credit report pull

How It Works

Initial Qualification

The system generates an Underwriting ID (uwId) based on the credit report. Use checkApplicantEligibility to create a new underwriting application - the service evaluates all debts from the credit report and returns eligibility results.

Revision Control

The lifecycle supports an iterative “What-If” scenario. You can update applicant parameters multiple times using updateApplicantEligibility. Each submission triggers a re-calculation of eligibility, with the service maintaining a revision counter to ensure data consistency and auditability.

API Operations

OperationDescription
checkApplicantEligibilityCreate a new underwriting application and evaluate eligibility
updateApplicantEligibilityModify an existing underwriting application

Key Features

  • Lead qualification workflows with comprehensive debt analysis
  • Eligibility scoring based on configurable rules
  • Support for both SINGLE and JOINT applications
  • Iterative “What-If” scenario support with revision tracking
  • Manual debt entry and management
  • Integration with Credit Reporting and Offer Generation APIs

Next Steps