Built, with privacy first. Not open yet.
Guardian's API is for organisations that want Guardian's weekly numbers inside their own systems. The client dashboard and the Org API are built and tested in a sandbox. No organisation uses them yet, and they are not open to the public. Access is by agreement, during pilots. The Partner API for ride and transport apps is built but switched off.
-
Built
Client dashboard
Admin logins for HR, transport and security leads. Weekly counts, enrolment codes, shift times, and reports to print or save as CSV.
-
Built
Org API
Read-only counts, enrolment and service status over HTTPS, with signed webhooks. Sandbox first.
-
By agreement
Pilot access
An agreement, a sandbox, a test key, then Guardian approves live access.
-
Switched off
Partner API
For cab and transport platforms: offer a watched trip to a rider who linked her account.
The same counts, in a browser.
Guardian invites your first admin with a link that works for 7 days. After that, your people sign in with an email and password.
- Owner. Everything, including admins, shift times, and asking for API access and go-live.
- Developer. Reports, enrolment codes, API keys and webhooks.
- Viewer. Reports and enrolment codes.
The dashboard shows the same numbers the API returns. Reports can be printed, saved as PDF from your browser, or downloaded as CSV.
Counts for employers and colleges.
Details may still change before the first client goes live.
Read-only, except shifts and webhooks. Every answer is a count or a notice. There is no endpoint, event or field for a single person, trip or SOS. Numbers are for finished weeks only, never live.
- Weekly summary. A finished week's counts, with small numbers hidden.
- History. Weekly counts over up to 26 weeks, for your own charts, and the weekly report as a CSV file.
- Enrolment. How many joined, how many have a trusted contact, and who joined or left this week, per enrolment code.
- Service status. Whether Guardian is operating normally, any open notice, and the helper desk's published hours.
- Shifts. You send your shift names and end times, never people. It helps time trip reminders.
- Webhooks. Signed notices when the weekly report is ready, when enrolment reaches a milestone, and when a service incident opens or is resolved.
The endpoint list, fields and a sample response are shared with your developers when the agreement is signed and your sandbox key is issued.
Offer a watched trip home.
Off on the server. Every partner address answers "not found" until Guardian switches it on.
A ride ends at the drop point, but her trip doesn't. With the Partner API, a cab or delivery app can offer a Guardian trip to a rider who linked her account. The partner only offers. She starts the trip herself, on the normal Start screen, with her own choices. A partner never starts Watch Over Me for her.
- Link a rider. The partner starts a link. The rider signs in to Guardian, sees what the partner can and cannot see, and approves. She can unlink at any time.
- Offer a trip. The partner offers a watched trip to a linked rider. The offer lasts 10 minutes and she decides.
- End the ride. Her trip continues until she ends it. An offer she has not started is withdrawn.
- Status only. Offered, declined, expired, active, needs attention, arrived or ended. Never why.
- Weekly counts. Links, offers and how trips ended. 1 to 4 is shown as "fewer than 5".
The partner reference is shared under agreement, once the Partner API is switched on.
- A partner is never told about an SOS. No field, event, count or timing in any partner answer can reveal one.
- A partner never gets her name, phone, email, contacts, location, route, destination or device.
- Unlinking never stops a trip she is on. The partner hears nothing more about it.
Conventions.
| Keys | Each key has limited scopes. A key is shown once and stored only as a hash. It expires after a year by default, can be limited to certain IP addresses, and can be rotated. Keys are separate from app and staff logins. |
|---|---|
| Sandbox | A test key returns a made-up organisation with made-up members, in the same shape and with the same hiding rules. A test key can never reach a real person. |
| Going live | Your owner asks for go-live once the agreement is on file. A Guardian admin approves it. Guardian can suspend an organisation's keys and webhooks at once. |
| Webhooks | Signed so you can verify they came from Guardian, and retried if your server is down. |
| Weeks | Weeks run Monday to Monday in India time. Only finished weeks are returned. |
What no Guardian API returns.
- Names, phone numbers, emails or device identifiers.
- Trusted contacts.
- Locations, addresses, places or routes.
- Any single trip or SOS.
- Check-in answers, movement data or evidence files.
Every number from 1 to 4 is shown as "fewer than 5". Timings are shown only when 5 or more events are behind them. A group of fewer than 10 people gets enrolment counts only. The server checks every report and answer for forbidden fields before it sends it, and tests cover that check.
Ask for access.
The API is not open to the public. Access is by agreement during pilots. If you run a security command centre, a transport system or a ride platform, tell us what you'd connect and we will reply by email.
