For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesWhite-labelAPI Reference
GuidesWhite-labelAPI Reference
  • Get started
    • Introduction
    • Quickstart
    • Authentication
  • Core concepts
    • Callout lifecycle
    • Customers & customer sources
    • Subscriptions & coverage
  • Integration patterns
    • Overview
    • Personal Safety
    • Fixed Locations
    • IoT Devices
  • AURA-hosted
    • Customer signup
    • Web Dispatch
    • Subscription management
    • Webhooks
    • Go-live
LogoLogo
On this page
  • The signup journey
  • Return URL parameters
  • Embedding
  • In the API Reference
AURA-hosted

Customer signup

Was this page helpful?
Previous

Web Dispatch

Next
Built with

AURA can host the customer onboarding flow for you. You create a signup session, redirect the customer to an AURA-hosted URL where they enter their details and pay, and AURA returns them to you with the outcome — no onboarding UI to build yourself.

The signup journey

  1. Create a session — call Create a signup session with a returnUrl and a customer identifier (email or your customerReferenceId).
  2. AURA returns an onboarding URL — a secure, session-specific link.
  3. Present the URL — open it in the customer’s browser, or embed it in your app with a WebView for a seamless in-app experience.
  4. The customer completes onboarding — personal and contact details, payment to activate a subscription, and optionally adding sites (predefined locations).
  5. AURA redirects to your returnUrl with the outcome as query parameters.

Return URL parameters

ParameterValuesWhen
statuscompleted, failed, cancelledAlways
error_codee.g. payment_failedWhen status=failed
signupSessionIdthe session idAlways
customerIdthe created customer idIf a customer was created
siteIdthe created site idIf a site (predefined location) was created
https://your-app.example.com/signup-complete?status=completed&signupSessionId=...&customerId=...

Embedding

A minimal React Native (Expo) example showing how to embed the flow is available at Aura-app/embed-example-app.

Subscription and predefined-location management don’t yet have hosted web flows. To manage a subscription afterwards, retrieve the subscriptionId from the customerId returned during signup, then use the subscription endpoints.

In the API Reference

  • Create a signup session
  • Retrieve a signup session