NDL Lead Delivery - Request Body Field Documentation

Delivering high-quality, structured lead data is crucial for ensuring fast, accurate processing within Next Door Lending systems. Below outlines the required and optional fields, data types, and expectations for API consumers. This version uses a Flattened JSON structure, fully aligned to our latest API practices. Prior to sending lead data please work with your NDL rep to create a lead source_name and funnelType. Without setting these field before sending data will result in failed data submission even with the accepted response.

Sending a lead:

You will be provided with a Webhook that will look something similar to the example below this and it will have auth header for the API key. The content should be passed as a raw JSON bundle in the body.

Method: POST

<https://hook.us1.make.celonis.com/{id}>

Headers:

Send the API key using the HTTP header. If the key matches, access is granted.

"x-make-apikey: ndl.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

"Content-Type: application/json"

Example:

curl -X POST "<https://hook.us1.make.celonis.com/xxxxxxxxxxxxxxxxxxxxxxx>" \\
  -H "Content-Type: application/json" \\
  -H "x-make-apikey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \\
  -d '{
    "leadId": "TESTUUID2",
    "firstName": "Test",
    "lastName": "Test",
    "dateOfBirth": "1976-08-21",
    "email": "[email protected]",
    "phone": "555-555-5555",
    "funnelType": "test_funnel",
    "mortgageType": "Purchase",
    "loanPurpose": "Purchase",
    "timeFrame": "UNDER_CONTRACT",
    "purchasePrice": 200000,
    "mortgageBalance": 160000,
    "loanToValue": 80,
    "downPayment": 40000,
    "employmentStatus": "Employed",
    "propertyType": "Single-Family",
    "propertyUsage": "Primary",
    "currentStreet": "118 Main",
    "currentCity": "Denver",
    "currentState": "CO",
    "currentZip": "80205",
    "militaryStatus": true,
    "creditScore": 680,
    "leadSourceRationale": "Rationale of the source"
  }'

Responses:

200 - OK

Accepted

401 - Unauthorized

Unauthorized.

Important Notes: