Postman Collection

This guide explains how to import and use the Postman collection for testing Credit Reporting and Lead Eligibility API endpoints.

The SANDBOX-CR and Eligibility collection provides pre-configured requests for testing:

• Credit report pulling and retrieval
• Single applicant eligibility checks
• Applicant eligibility updates (applicant info, debts)
• Offer generation
• Joint application flows

The collection includes test scripts that automatically extract and save IDs (like creditReportId) for use in subsequent requests.

Download

Download Postman Collection

Getting Started

1. Download Postman - Install Postman if you haven’t already 2. Download the Collection - Use the download button above 3. Import the Collection - Import the JSON file into Postman 4. Configure Variables - Set up your collection variables 5. Authenticate - Run the “Start Here” request to get an access token 6. Start Testing - Run requests in sequence

Importing the Collection

1. Open Postman 2. Click Import in the top left 3. Drag and drop the downloaded JSON file or click Upload Files 4. Click Import to confirm

Collection Variables

The collection requires the following variables to be configured:

Variable	Sandbox	Production
alleviate_tenant_id	8797fa3f-ba90-4187-97fb-6ab892ea90355	8797fa3f-ba90-4187-97fb-6ab892ea9035
debt_core_app_id	aba793eb-f395-4f86-be59-7a7d0c1bfdb0	9060a1d0-da3b-4676-ad64-ff64465cce41
client_app_id	Provided by your account manager	Provided by your account manager
client_secret	Provided by your account manager	Provided by your account manager

Caution

Never commit or share your client secrets. Contact your account manager to obtain your client_app_id and client_secret.

Collection Structure

#1 SANDBOX-CR and Eligibility
├── Start Here
│   └── Start: SB UW Set Access Token
├── Single Applicant
│   ├── 1. Pull Credit Report
│   ├── 2. Check Single Applicant Eligibility
│   ├── 3. Update Applicant Eligibility (applicant info)
│   ├── 3. Update Applicant Eligibility (debts)
│   ├── 3. Update Applicant Eligibility (add many debts)
│   └── 4. Offers
├── Other
│   ├── 1.2 Get Credit Report Response
│   └── 2.1 Get UW Results
└── Joint Application
    └── (Coming soon)

Authentication

Before running any API requests, you must authenticate:

1. Navigate to Start Here → Start: SB UW Set Access Token 2. Click Send 3. The response will include an access_token 4. The test script automatically saves this token to the utoken collection variable

Tip

The access token is automatically used in all subsequent requests via the utoken variable.

Running the Single Applicant Flow

1. Authenticate - Run “Start: SB UW Set Access Token” 2. Pull Credit Report - Run request #1 (automatically saves creditReportId) 3. Check Eligibility - Run request #2 with the saved credit report ID 4. Update Eligibility - Optionally update applicant info or debts with request #3 5. Generate Offers - Run request #4 to create offers

Note

The collection includes multiple test case payloads in the pre-request scripts. Check the “Pre-request Script” tab to see available test personas.

Troubleshooting

Issue	Solution
401 Unauthorized	Re-run the “Set Access Token” request to refresh your token
Missing creditReportId	Ensure you ran “Pull Credit Report” first and it succeeded
Variables not resolving	Check that all required collection variables are configured
Token expired	Access tokens expire; re-run authentication request