curl -X POST https://credzu.com/wp-json/credzu/v1/get-lead \
-H "Content-Type: application/json" \
-H "Authorization: Credzu-Key YOUR_API_KEY" \
-d '{
"lead_id": 44921
}'
<?php
$ch = curl_init("https://credzu.com/wp-json/credzu/v1/get-lead");
curl_setopt_array($ch, array(
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json",
"Authorization: Credzu-Key YOUR_API_KEY"
),
CURLOPT_POSTFIELDS => json_encode(array("lead_id" => 44921))
));
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($response);
{
"success": true,
"data": {
"id": 44921,
"partner_id": 1,
"partner_lead_id": "FBHL-55672",
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@example.com",
"phone": "555-333-2222",
"fico_range": "580-619",
"loan_officer_id": "A.GLADSTONE",
"status": "contract_signed",
"created_at": "2025-01-15 10:30:00",
"updated_at": "2025-01-18 14:22:00"
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Lead not found"
}
}
Endpoints
Get Lead
Retrieve the current status and details of a specific lead
POST
/
get-lead
curl -X POST https://credzu.com/wp-json/credzu/v1/get-lead \
-H "Content-Type: application/json" \
-H "Authorization: Credzu-Key YOUR_API_KEY" \
-d '{
"lead_id": 44921
}'
<?php
$ch = curl_init("https://credzu.com/wp-json/credzu/v1/get-lead");
curl_setopt_array($ch, array(
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json",
"Authorization: Credzu-Key YOUR_API_KEY"
),
CURLOPT_POSTFIELDS => json_encode(array("lead_id" => 44921))
));
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($response);
{
"success": true,
"data": {
"id": 44921,
"partner_id": 1,
"partner_lead_id": "FBHL-55672",
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@example.com",
"phone": "555-333-2222",
"fico_range": "580-619",
"loan_officer_id": "A.GLADSTONE",
"status": "contract_signed",
"created_at": "2025-01-15 10:30:00",
"updated_at": "2025-01-18 14:22:00"
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Lead not found"
}
}
Overview
Allows partners to fetch the current state of a specific lead by its Credzu lead ID.Request Body
integer
required
The Credzu lead ID returned when the lead was created
Response
boolean
true if the lead was foundobject
Lead details object
Show Lead object properties
Show Lead object properties
integer
Credzu’s unique identifier
string
Your internal ID for this lead
string
Borrower’s first name
string
Borrower’s last name
string
Borrower’s email
string
Borrower’s phone
string
Current milestone status (e.g.,
lead_received, contract_signed, mortgage_ready)string
FICO score range if provided
string
Loan officer identifier if provided
string
Lead creation timestamp
string
Last update timestamp
curl -X POST https://credzu.com/wp-json/credzu/v1/get-lead \
-H "Content-Type: application/json" \
-H "Authorization: Credzu-Key YOUR_API_KEY" \
-d '{
"lead_id": 44921
}'
<?php
$ch = curl_init("https://credzu.com/wp-json/credzu/v1/get-lead");
curl_setopt_array($ch, array(
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json",
"Authorization: Credzu-Key YOUR_API_KEY"
),
CURLOPT_POSTFIELDS => json_encode(array("lead_id" => 44921))
));
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($response);
{
"success": true,
"data": {
"id": 44921,
"partner_id": 1,
"partner_lead_id": "FBHL-55672",
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@example.com",
"phone": "555-333-2222",
"fico_range": "580-619",
"loan_officer_id": "A.GLADSTONE",
"status": "contract_signed",
"created_at": "2025-01-15 10:30:00",
"updated_at": "2025-01-18 14:22:00"
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Lead not found"
}
}
You can only retrieve leads that belong to your partner account. Attempting to access another partner’s leads will return a
NOT_FOUND error.⌘I