Create customer signup session

Creates an Aura-hosted signup session for a customer onboarding flow. Use this when Aura should host part of the registration experience.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
returnUrlstringRequiredformat: "uri"
Your URL that AURA redirects the customer back to once signup completes.
emailstringOptional
customerReferenceIdstringOptional
Your own reference for the customer.
siteDetailsobjectOptional

Optional site details to pre-fill during signup.

Response

Successful.
sessionIdstring
customerIdinteger or null
returnUrlstringformat: "uri"

The AURA-hosted onboarding URL to redirect the customer to.

Errors

400
Bad Request Error
401
Unauthorized Error