Skip to main content

​
Overview

The Credzu API is a RESTful JSON-based interface that allows third-party systems (CRM, LOS, lender software, lead managers, and enterprise partners) to securely exchange referral and status information with Credzu.

​
Base URL

All endpoints follow this pattern: 
https://credzu.com/wp-json/credzu/v1/{endpoint}

​
Request Format

All requests must include: 
Content-Type: application/json
Authorization: Credzu-Key {YOUR_API_KEY}

​
Response Format

All responses are returned as JSON with a consistent structure: Success response: 
{
  "success": true,
  "message": "Operation completed",
  "data": {}
}
Error response: 
{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Error description"
  }
}

​
Available Endpoints

​
Inbound (Partner → Credzu)

MethodEndpointDescription
GET/pingHealth check - verify API is online
POST/create-leadCreate a new consumer/lead in Credzu
POST/get-leadRetrieve current status of a lead
POST/get-eventsGet event history for a lead
POST/update-partner-infoUpdate metadata for an existing lead

​
Outbound (Credzu → Partner)

Credzu sends webhook callbacks to your registered endpoint for these events:
EventDescription
lead_receivedLead was successfully created
client_account_createdBorrower logged in and completed onboarding
credit_scan_completedBorrower completed credit scan
contract_signedBorrower signed service contract
escrow_fundedBorrower funded escrow account
score_updateCredit score update (sent every 45 days)
mortgage_readyBorrower meets credit criteria - ready to return

​
End-to-End Workflow

Partner System                         Credzu
     │                                    │
     │  POST /create-lead                 │
     │ ─────────────────────────────────> │
     │                                    │
     │  { lead_id: 44921 }                │
     │ <───────────────────────────────── │
     │                                    │
     │                                    │ (Borrower onboards)
     │                                    │
     │  Webhook: lead_received            │
     │ <───────────────────────────────── │
     │                                    │
     │  Webhook: client_account_created   │
     │ <───────────────────────────────── │
     │                                    │
     │  Webhook: contract_signed          │
     │ <───────────────────────────────── │
     │                                    │
     │  Webhook: escrow_funded            │
     │ <───────────────────────────────── │
     │                                    │
     │  Webhook: score_update (45 days)   │
     │ <───────────────────────────────── │
     │                                    │
     │  Webhook: mortgage_ready           │
     │ <───────────────────────────────── │
     │                                    │
     │  POST /get-lead (optional)         │
     │ ─────────────────────────────────> │
     │                                    │

​
Partner Responsibilities

1

Include API key in every request

All authenticated endpoints require the Authorization: Credzu-Key YOUR_API_KEY header.
2

Send valid JSON

Request bodies must be valid JSON with the correct fields.
3

Store the Credzu lead ID

Save the lead_id returned when creating a lead - it’s used for status callbacks and lookups.
4

Handle webhooks

Implement a webhook endpoint to receive Credzu status updates and return 200 OK.
5

Use sandbox first

Test your integration in sandbox before going live.