Ignition
Start Ignition
Ignition
Start Ignition
Start an Ignition session. Returns the ignitionUri to direct the user to authenticate.
POST
/ignition
x-client-id*
x-client-secret*
curl --request POST \
--url https://api.axle.insure/ignition \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <x-client-secret>'
Headers
x-client-idrequired
string
Your client ID. This will be shared with you during onboarding.
x-client-secretrequired
string
Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all!
Body
metadata
object
Optional object to store ephermeral information about the session, such as reservationTime
. Will be returned in webhook events.
redirectUri
string
The URI we should direct the user to after authenticating successfully.
user
object
User to attach to Ignition session. If user is set, unique id
must be provided.
webhookUri
string
The URI we should send updates about this session or the resulting account to.
Response
datarequired
object
successrequired
boolean
Indicates whether the operation was performed successfully.
curl --request POST \
--url https://api.axle.insure/ignition \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <x-client-secret>'