Core concepts

Customers

A customer is the protected end user — the person (or site contact) AURA responds to. You create and manage customers through the API, and every callout and subscription belongs to a customer.

Customer profile

The essentials to create a customer are a name, surname, and mobile number (the mobile number is the customer’s unique identifier). Beyond that, the profile can carry context that helps responders:

  • Contact — email, gender, date of birth.
  • Vehicle — make, model, colour, and licence plate (useful for roadside or vehicle-related response).
  • Medical — medical-aid scheme/number/plan, conditions, medications, allergies, blood type, next-of-kin, and a family-doctor contact.
  • Your reference — externalReferenceId, your own id for the customer, so you can tie AURA’s customerId back to your system.

Create customers with POST /panic-api/v2/customers, update them with PUT, and retire them with a soft delete (note the legacy verb: it’s POST /panic-api/v2/customers/{customerId}/delete, not HTTP DELETE). You can also onboard customers through a hosted signup session.

The create call can also activate a subscription in the same request — include a subscription object (or link an existing one with subscriptionId; the two are mutually exclusive). This is the usual onboarding shortcut, since live callouts require an active subscription. See the With subscription example on Create a customer.

Linking a customer to a fixed location

A customer can be associated with a fixed location (a managed site). This supports the combined model where a customer is registered and linked to the fixed location(s) they’re responsible for — so a callout can be created for the person or for their fixed location. See Fixed Locations.

Customer sources

A customer source is the tenant your API keys belong to — it identifies your integration, and every customer you create is owned by your source. You rarely interact with it directly: it’s resolved automatically from the credentials you authenticate with.

For Property Protect integrations, a customer source may be a monitoring centre that manages Fixed Locations for one or more configured installers. The parent source can address its own sites and its installers’ sites, while an installer credential is limited to its own sites. Use List installers to discover the available installer identifiers before creating or updating installer-owned Fixed Locations.

In the API Reference

  • Customers — create, retrieve, update, and soft-delete customers.