Lead Intake API

Use this API to submit new client leads into The Claim System.

Endpoint

POST /api/leads/{key}

The {key} is your unique endpoint key provided by The Claim System.

Authentication

Authentication is handled using the endpoint key in the URL.

Only active endpoint keys are accepted. Invalid or inactive keys return 404.

Request Body

Field Required Example
referenceNoEXT-123
titleYesMr
first_nameYesJohn
middle_nameNoEdward
last_nameYesSmith
preferred_nameNoJohnny
dobYes1985-05-20
emailNojohn@example.com
phoneYes+447123456789
 
{
  "reference": "EXT-123",
  "title": "Mr",
  "first_name": "John",
  "middle_name": null,
  "last_name": "Smith",
  "preferred_name": null,
  "dob": "1985-05-20",
  "email": "john@example.com",
  "phone": "+447123456789"
}

Success Response

Status: 201 Created

{
  "success": true,
  "message": "Client and claim created successfully.",
  "data": {
    "client_id": 123,
    "claim_id": 456,
    "reference": "EXT-123"
  }
}

Validation Error

Status: 422 Unprocessable Entity

{
  "message": "The given data was invalid.",
  "errors": {
    "phone": [
      "The phone format is invalid."
    ]
  }
}

cURL Example

curl -X POST https://your-domain.com/api/leads/YOUR_ENDPOINT_KEY \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "reference": "EXT-123",
    "title": "Mr",
    "first_name": "John",
    "last_name": "Smith",
    "dob": "1985-05-20",
    "email": "john@example.com",
    "phone": "+447123456789"
  }'

Important Notes