Skip to content
MLAS API

Postman Collection

We provide an official Postman collection to help you quickly test the Marketing Lead Automation Service API. This collection includes pre-configured requests for authentication and all API operations.

Importing the Collection

  1. Download the Collection

    Download Postman Collection →

    Or request the collection file from the engineering team during onboarding.

    The collection is named: [LEAD_PARTNER_ONBOARDING] leads-sandbox.alleviate.com

  2. Import into Postman

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

  3. Configure Variables

    After importing, configure your credentials:

    1. Click on the collection name in the sidebar
    2. Click the Variables tab
    3. Set the following values:
    VariableDescriptionDefault Value
    client_app_idYour application’s Client ID(Provided during onboarding)
    client_secretYour application’s Client Secret(Provided during onboarding)
    alleviate_tenant_idAlleviate’s Azure AD Tenant ID8797fa3f-ba90-4187-97fb-6ab892ea9035
    debt_core_app_idDebt Core Application ID (for scope)aba793eb-f395-4f86-be59-7a7d0c1bfdb0
    base_urlAPI base URLhttps://leads-sandbox.alleviate.com
    1. Click Save

Collection Structure

The collection is organized into two folders:

📁 * SEND THIS FIRST authentication
   └── [Step 0]: Set Access Token


📁 New Lead
   ├── Create Lead
   ├── Get Lead Status
   └── Submit Lead

1. Authentication

Run This First

Folder: * SEND THIS FIRST authentication

Request: [Step 0]: Set Access Token

This request authenticates with Microsoft Entra ID using the OAuth 2.0 client credentials flow. It automatically saves the access token to the utoken collection variable for use in subsequent requests.

Endpoint:

POST https://login.microsoftonline.com/{{alleviate_tenant_id}}/oauth2/v2.0/token

Body (x-www-form-urlencoded):

KeyValue
grant_typeclient_credentials
client_id{{client_app_id}}
client_secret{{client_secret}}
scopeapi://{{debt_core_app_id}}/.default

2. Create Lead

Folder: New Lead

Request: Create Lead

Submits a new lead for processing. The response id is automatically saved to the lead_id collection variable via a post-request test script.

Endpoint:

POST {{base_url}}/graphql

GraphQL Mutation:

mutation TestMinimalLead($input: LeadInput!) {
  createLead(input: $input) {
    id
    resultCode
    note
    partnerLeadId
    bidValue
  }
}

Example Variables (from collection):

{
  "input": {
    "firstName": "John1-1",
    "lastName": "Test",
    "dateOfBirth": "1970-01-26",
    "email": "john.doe1-1@gmail.com",
    "homePhone": "8166999999",
    "address1": "1230 Public Lane 456",
    "city": "Dallas",
    "state": "OH",
    "zipCode": "65542",
    "socialSecurityNumber": "123456789",
    "incomeSourceId": 1,
    "residenceTypeId": 2,
    "payFrequencyId": 1,
    "monthlyIncome": 4000,
    "loanAmount": 5000,
    "loanPurposeId": 1,
    "estimatedDebt": 25000,
    "siteURL": "fake.com",
    "clientIP": "107.77.220.32",
    "affiliateAppID": "220001-7300907c-1af0-415b-a981-b7e13f718ebd",
    "leadId": "69-1060-1111"
  }
}

3. Get Lead Status

Folder: New Lead

Request: Get Lead Status

Queries lead status by ID for reconciliation and troubleshooting.

Endpoint:

POST {{base_url}}/graphql

GraphQL Query:

query GetLeadStatus($id: ID!) {
  getLeadStatus(id: $id) {
    id
    resultCode
    note
    partnerLeadId
    bidValue
  }
}

Variables:

{
  "id": "{{lead_id}}"
}

4. Submit Lead

Folder: New Lead

Request: Submit Lead

Submits a qualified lead to the CRM system. Only call this for leads with qualifying result codes (1013-1017).

Endpoint:

POST {{base_url}}/graphql

GraphQL Mutation:

mutation SubmitLead($input: SubmitLeadInput!) {
  submitLead(input: $input) {
    leadId
    statusCode
    crmRecordId
    crm
  }
}

Variables:

{
  "input": {
    "leadId": "{{lead_id}}"
  }
}

Workflow

Follow this order when testing:

1. Set Access Token    → Authenticates and saves token to {{utoken}}
         ↓
2. Create Lead         → Submits lead, saves ID to {{lead_id}}
         ↓
3. Get Lead Status     → Optional lookup for reconciliation/troubleshooting
         ↓
4. Submit Lead         → Only if qualified (resultCode 1013-1017) and manual CRM submission is configured

Result Codes Reference

The following result codes may be returned by lead status responses. These are documented inline in the Postman collection.

Processing State Codes

CodeNameDescription
1000SUBMITTED_PROCESSINGLead submitted and processing
1001UNIQUE_PROCESSING_COMPLETELead is unique, processing complete

Duplicate State Codes

CodeNameDescription
1003DUPLICATE_LEADDuplicate lead found (workflow stops immediately)
1004DUPLICATE_LEAD_CRMDuplicate lead found

Processing Failure Codes

CodeNameDescription
1006MONEVO_FAILEDMonevo processing failed (workflow stops)
1007TRUSTEDFORM_FAILEDTrustedForm processing failed (workflow stops)
1008BID_FAILEDBid processing failed (workflow stops)

Product Code Based Result Codes (Qualified Leads)

Submit Lead Eligible
CodeNameDescription
1013PRODUCT_CODE_3225Sum(BC33S + US33S + CO06S) + Vantage Score above 600 > 15,000
1014PRODUCT_CODE_3226Sum(BC33S + US33S + CO06S) + Vantage Score above 450 > 20,000
1015PRODUCT_CODE_3227Sum(BC33S + US33S + CO06S) + Vantage Score above 450 > 30,000
1016PRODUCT_CODE_3228Sum(BC33S + US33S + CO06S) + Vantage Score above 450 > 40,000
1017PRODUCT_CODE_3229Sum(BC33S + US33S + CO06S) + Vantage Score above 450 > 50,000

Other Result Codes

CodeNameDescription
1018PRODUCT_CODE_3288Credit File Unknown/Not Found (CFU)
1019PRODUCT_CODE_3289SUM(BC33S + US33S + CO06s) > 15,000 + Vantage Score < 450

CRM Submission Result Codes

CodeNameDescription
1021CRM_SUBMITTEDLead Submitted to CRM
1022PREVIOUSLY_SUBMITTED_CRMLead Previously Submitted to CRM

Error State Codes

CodeNameDescription
9999PROCESSING_ERRORError occurred during processing

Collection Variables

The collection uses these variables:

VariableDescriptionDefault ValueSet By
alleviate_tenant_idAzure AD Tenant ID8797fa3f-ba90-4187-97fb-6ab892ea9035Pre-configured
client_app_idYour Client ID—You (during onboarding)
client_secretYour Client Secret—You (during onboarding)
debt_core_app_idAPI scope app IDaba793eb-f395-4f86-be59-7a7d0c1bfdb0Pre-configured
base_urlAPI base URLhttps://leads-sandbox.alleviate.comPre-configured
utokenAccess token—Automatic (after auth)
lead_idLast created lead ID—Automatic (after createLead)

Troubleshooting

401 Unauthorized

  • Re-run the “[Step 0]: Set Access Token” request in the authentication folder
  • Verify your client_app_id and client_secret are correct
  • Check that the token hasn’t expired (tokens are valid for 1 hour)

Invalid Grant / AADSTS Error

  • Check that alleviate_tenant_id is set to 8797fa3f-ba90-4187-97fb-6ab892ea9035
  • Verify your application is properly registered with Alleviate
  • Confirm you’re using the correct client_secret (not the secret ID)

Lead Not Found

  • Ensure you’re using the correct lead_id (check the collection variable)
  • Verify you’re hitting the same environment where the lead was created
  • Use the id returned from createLead, not your external leadId

Request Times Out

  • The sandbox environment may have cold start delays
  • Retry after a few seconds
  • For createLead, processing may take up to 30 seconds for credit pulls

Duplicate Lead Error (1003)

  • The lead with the same phone/email combination already exists
  • Use a different test phone number/email