Debt/Credit Lookup (Soft Pull)

The Debt/Credit Lookup integration provides real-time soft-pull access to consumer credit and debt data for lead qualification and offer customization. This is a soft pull — it does not affect the consumer’s credit score.

Detail	Value
Cost	$0.35 per lookup
Rate limit	300 requests/min
Billing	Wallet-based (pre-paid)

Quick start

1. Go to Integrations in your dashboard at app.econsent.org.
2. Enable Debt/Credit Lookup and copy your API token.
3. Make your first request:

curl -X POST https://api.econsent.org/api/integrations/YOUR_COMPANY_ID/vzew/debt \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
    "email": "user@example.com",
    "state": "CA",
    "zip_code": "90210"
  }'

Endpoint

POST https://api.econsent.org/api/integrations/:companyId/vzew/debt

Authentication

Use Bearer token authentication with your Debt/Credit Lookup integration token:

Authorization: Bearer YOUR_API_TOKEN

Request parameters

Path parameters

Parameter	Type	Description
companyId	string	Your Company ID

Request body

Field	Type	Required	Description
email	string	Yes	Consumer’s email address
state	string	Yes	Two-letter state code (e.g., CA, NY)
zip_code	string	Yes	5-digit ZIP code

Response

Success (200)

{
  "success": true,
  "status": 200,
  "data": {
    "credit_score": 720,
    "unsecured_debt": 15000,
    "trade_lines": 8,
    "debt_to_income_estimated": 0.25
  },
  "billing": {
    "currency": "USD",
    "cost_charged": 0.35,
    "remaining_balance": 99.65,
    "formatted": {
      "cost_charged": "$0.35",
      "remaining_balance": "$99.65"
    }
  },
  "processing_time_ms": 250,
  "service": "debt",
  "company_id": "comp-abc",
  "timestamp": "2025-03-18T10:30:00Z",
  "provider": "vzew"
}

Response fields

Field	Type	Description
data.credit_score	number	Credit Vantage Score (300—850)
data.unsecured_debt	number	Total unsecured debt in USD
data.trade_lines	number	Number of active credit accounts
data.debt_to_income_estimated	number	Estimated debt-to-income ratio
billing.cost_charged	number	Amount deducted from wallet ($0.35)
billing.remaining_balance	number	Remaining wallet balance

Health check

You can verify your integration status, wallet balance, and available services using the health check endpoint:

GET https://api.econsent.org/api/integrations/:companyId/vzew/health

The response includes your current wallet balance, available integrations, service costs, and routing configuration.

Error responses

Status	Meaning
400	Bad request: missing or invalid parameters
401	Unauthorized: invalid API token
402	Payment required: insufficient wallet balance
403	Forbidden: integration not enabled
429	Rate limited: exceeded 300 requests/min

Note

If your wallet balance is insufficient, add funds at app.econsent.org under Billing > Wallet, or enable auto-recharge to avoid interruptions.

Code examples

Node.js

async function lookupDebt(email, state, zipCode) {
  const companyId = process.env.ECONSENT_COMPANY_ID;
  const token = process.env.ECONSENT_DEBT_TOKEN;

  const response = await fetch(
    `https://api.econsent.org/api/integrations/${companyId}/vzew/debt`,
    {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${token}`,
      },
      body: JSON.stringify({ email, state, zip_code: zipCode }),
    }
  );

  const data = await response.json();

  if (data.success) {
    console.log('Credit Score:', data.data.credit_score);
    console.log('Unsecured Debt: $' + data.data.unsecured_debt);
    console.log('Trade Lines:', data.data.trade_lines);
    return data.data;
  } else {
    throw new Error(data.error);
  }
}

Python

import os
import requests

def lookup_debt(email, state, zip_code):
    company_id = os.getenv('ECONSENT_COMPANY_ID')
    token = os.getenv('ECONSENT_DEBT_TOKEN')

    response = requests.post(
        f'https://api.econsent.org/api/integrations/{company_id}/vzew/debt',
        headers={
            'Content-Type': 'application/json',
            'Authorization': f'Bearer {token}',
        },
        json={
            'email': email,
            'state': state,
            'zip_code': zip_code,
        },
    )

    data = response.json()

    if data.get('success'):
        print(f"Credit Score: {data['data']['credit_score']}")
        print(f"Unsecured Debt: ${data['data']['unsecured_debt']}")
        print(f"Trade Lines: {data['data']['trade_lines']}")
        return data['data']
    else:
        raise Exception(data.get('error'))

PHP

<?php
function lookupDebt($email, $state, $zipCode) {
    $companyId = getenv('ECONSENT_COMPANY_ID');
    $token = getenv('ECONSENT_DEBT_TOKEN');

    $ch = curl_init("https://api.econsent.org/api/integrations/$companyId/vzew/debt");
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
        'email' => $email,
        'state' => $state,
        'zip_code' => $zipCode,
    ]));
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'Content-Type: application/json',
        "Authorization: Bearer $token",
    ]);

    $response = curl_exec($ch);
    curl_close($ch);

    $result = json_decode($response, true);

    if ($result['success']) {
        echo "Credit Score: " . $result['data']['credit_score'] . "\n";
        echo "Unsecured Debt: $" . $result['data']['unsecured_debt'] . "\n";
        echo "Trade Lines: " . $result['data']['trade_lines'] . "\n";
        return $result['data'];
    } else {
        throw new Exception($result['error']);
    }
}
?>

Best practices

• Cache results. Store lookup results to avoid duplicate charges for the same consumer.
• Handle errors gracefully. Implement retry logic for transient failures (5xx errors) and handle 402 responses by checking your wallet balance.
• Monitor your wallet. Enable auto-recharge and set up low-balance alerts under Billing > Settings.

Pricing

• Cost per lookup: $0.35
• Rate limit: 300 requests/min
• Billing method: Wallet-based (pre-paid via Stripe)

View all pricing details

Next steps

• Email Validation. Validate email deliverability at $0.05/check
• Phone Validation. Validate phone numbers at $0.05/check
• Fraud Detection. Real-time fraud scoring at $0.05/check
• Pricing & Billing. Full pricing breakdown