Skip to main content
gazetted

API Documentation

Integrate statutory notice placement directly into your case management system, CRM, or custom workflow. RESTful JSON API with webhook support.

Authentication

All authenticated endpoints require a Bearer token. Generate your API key from your portal settings page at Settings → API Keys.

Authorization headerhttp
Authorization: Bearer YOUR_API_KEY

Keep your API key secret. Do not expose it in client-side code. All requests must be made over HTTPS.

Endpoints

POST/api/v1/orders
Submit a new notice order
GET/api/v1/orders
List all orders for your account
GET/api/v1/orders/:id
Get order status, proof links, and certificate downloads
POST/api/v1/quote
Get an instant quote for a notice type and postcodeNo auth

Submit a probate notice

Example: placing a Section 27 (Trustee Act 1925) probate notice.

curlbash
curl -X POST https://gazetted.co.uk/api/v1/orders \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "section-27-probate",
    "postcode": "SW1A 1AA",
    "deceased_name": "John Smith",
    "date_of_death": "2025-12-15",
    "executor_name": "Jane Smith",
    "executor_address": "10 Downing Street, London SW1A 2AA",
    "solicitor_firm": "Smith & Partners LLP",
    "solicitor_ref": "JS/PROBATE/2025/001"
  }'
fetchjavascript
const response = await fetch("https://gazetted.co.uk/api/v1/orders", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    type: "section-27-probate",
    postcode: "SW1A 1AA",
    deceased_name: "John Smith",
    date_of_death: "2025-12-15",
    executor_name: "Jane Smith",
    executor_address: "10 Downing Street, London SW1A 2AA",
    solicitor_firm: "Smith & Partners LLP",
    solicitor_ref: "JS/PROBATE/2025/001",
  }),
});

const order = await response.json();
// {
//   "id": "ord_abc123",
//   "status": "draft",
//   "type": "section-27-probate",
//   "newspaper": "Evening Standard",
//   "price": 95.00,
//   "vat": 19.00,
//   "total": 114.00,
//   "created_at": "2025-12-20T10:30:00Z"
// }

Get a quote

The quote endpoint does not require authentication. Use it to show pricing in your own application before placing an order.

curlbash
curl -X POST https://gazetted.co.uk/api/v1/quote \
  -H "Content-Type: application/json" \
  -d '{
    "type": "hgv-operator-licence",
    "postcode": "M1 1AA"
  }'

# Response:
# {
#   "type": "hgv-operator-licence",
#   "postcode": "M1",
#   "newspaper": "Manchester Evening News",
#   "price": 89.00,
#   "vat": 17.80,
#   "total": 106.80
# }

Webhooks

Configure a webhook URL in your portal settings to receive real-time notifications when an order's status changes. We send a POST request to your URL with the event payload.

Status transitions: pending_payment → booked → urn_received → artwork_sent → delivered → published → cancel_requested → cancelled → cancel_rejected

Webhook payloadjson
// Webhook payload (POST to your URL)
{
  "event": "order.status_changed",
  "order_id": "ord_abc123",
  "status": "published",
  "timestamp": "2025-12-22T14:00:00Z",
  "data": {
    "type": "section-27-probate",
    "newspaper": "Evening Standard",
    "certificate_url": "https://gazetted.co.uk/api/v1/orders/ord_abc123/certificate"
  }
}

Interested in API access?

API access is available to firm account holders. Submit your details below and we'll get back to you with API credentials.