A REST API for everything the dashboard can do

API keys per workspace, OAuth for integrations

Each Ubique workspace can issue its own API keys from Settings → Developers. Keys are scoped (read, write, payroll, webhooks) and can be restricted to an IP allow-list. A key belongs to the workspace, not to the person who created it, so it survives staff changes. Rotate a key and the old one keeps working for 24 hours.

If you are building an integration that many Ubique customers will install, use OAuth 2.0 with the authorization-code flow. Your app requests scopes, the customer's admin approves them in their dashboard, and you receive a refresh token per workspace. We review and list OAuth apps on the Integrations page.

Keys prefixed ubq_live_ hit production. Keys prefixed ubq_test_ hit the sandbox. Both use the same base URL; the key decides the environment.

# List payroll runs for October 2026
curl https://api.ubiquehq.co.uk/v1/payroll_runs?period=2026-10 \
  -H "Authorization: Bearer ubq_live_7f3a..."

# Response (truncated)
{
  "data": [
    {
      "id": "pr_01J9K2M4N6P8",
      "country": "DE",
      "period": "2026-10",
      "status": "completed",
      "employee_count": 14,
      "total_employer_cost": { "amount": 9842017, "currency": "EUR" },
      "pay_date": "2026-10-28"
    }
  ],
  "has_more": false
}

Amounts are integers in minor units (cents, pence). Dates are ISO 8601. IDs are prefixed by resource type.

Be told when something happens

Register an HTTPS endpoint per workspace and choose the events. Every delivery is signed with an HMAC-SHA256 signature in the Ubique-Signature header, using a secret shown once when you create the endpoint. Deliveries that do not return a 2xx are retried with exponential backoff for 72 hours, and you can replay any event from the dashboard.

• employee.created when a new employee is added, before the contract is sent.
• contract.signed when all parties have signed a contract or amendment.
• payroll.run.completed when a country's payroll for a period is finalised and funds are sent.
• invoice.issued when a Ubique invoice is created, with a link to the PDF and line items.

Also available: contractor.risk_score.changed, leave_request.created, expense.approved and employee.offboarded.

# Example payload: payroll.run.completed
{
  "id": "evt_01J9K3R7T2V5",
  "type": "payroll.run.completed",
  "created_at": "2026-10-28T09:14:03Z",
  "data": {
    "payroll_run_id": "pr_01J9K2M4N6P8",
    "country": "DE",
    "period": "2026-10",
    "employee_count": 14,
    "pay_date": "2026-10-28"
  }
}

# Verify the signature (Node)
import { verifyWebhook } from "@ubique/sdk";
const event = verifyWebhook(req.rawBody, req.headers["ubique-signature"], process.env.UBIQUE_WEBHOOK_SECRET);

Already on Merge? Ubique is a supported HRIS

If your product integrates with HR systems through Merge's unified API, Ubique is available as a connector in the HRIS and Payroll categories. Your customers authorise Ubique once in Merge Link and you read employees, employments, time off and payroll runs through Merge's common model, with no Ubique-specific code.

The direct API is still the better choice when you need Ubique-specific fields such as the contractor risk score, the employment model (EOR, PEO, VEO) or country lead times, or when you want to write data back.