API Documentation

Getting Started

Our REST API allows you to integrate Zynx with any system. All endpoints use JSON and require authentication via API key.

curl -X POST https://api.zynx.co.uk/v1/leads \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "amount": 5000}'

Authentication

Include your API key in the Authorization header:

Authorization: Bearer sk_live_...

Endpoints

POST /v1/leads

Submit a new lead for routing

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "loanAmount": 5000,
  "incomeMonthly": 3000,
  "postcode": "SW1A 1AA"
}

GET /v1/leads/{id}

Retrieve lead status and outcome

GET /v1/analytics

Get performance analytics and metrics

Webhooks

Configure webhooks to receive real-time notifications when lead status changes:

{
  "event": "lead.approved",
  "data": {
    "leadId": "L-123",
    "status": "APPROVED",
    "payout": 45.99,
    "lenderId": "LENDER_001"
  }
}