Start Ignition
Generate an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire.
Authorizations
Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all! Your secret will be matched with your client ID to authenticate your requests.
Headers
Your client ID. This will be shared with you during onboarding.
The client ID of the destination client. This is optional and only used by platform clients. See the Axle for Platforms guide for more information.
Set to true if you would like to send an encrypted base64 string as the request body, instead of a JSON string. The body must be encrypted using an Axle-provided public key with RSA_PKCS1_OAEP_PADDING and SHA256 hashing. Defaults to false.
Note - If your client is configured to use the Ignition landing page to collect additional user information, the provided Ignition user and metadata can be accessed by the user that is sent a generated Ignition session.
Optionally provided to pre-authenticate a user that has previously shared insurance information via Axle and may be reconnecting the same insurance account. See Monitoring for more details on usage. Returned as part of Exchange Token.
Body
The URI Ignition should direct the user to after authenticating successfully or exiting the Ignition session.
The URI Axle should send updates about this session or the resulting Account or Policy objects.
User to attach to Ignition session. If user is set, unique id must be provided. Will be returned in webhook events.
Optional object to store ephermeral information about the session, such as reservationTime. Will be returned in webhook events.