POST
/
ignition
Header
Body
curl --request POST \
  --url https://api.axle.insure/ignition \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '{
  "redirectUri": "https://example.com/redirect",
  "webhookUri": "https://example.com/webhook"
}'
{
  "data": {
    "ignitionToken": "ur7EPeAa0km4wRlDrPJ4Z",
    "ignitionUri": "https://ignition.dev.axle.insure/?token=ur7EPeAa0km4wRlDrPJ4Z"
  },
  "success": true
}

Headers

x-client-id
string
required

Your client ID. This will be shared with you during onboarding.

x-client-secret
string
required

Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all!

x-destination-client-id
string

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.

x-encrypted-data
boolean

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.

Body

application/json
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 or exiting the Ignition session.

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 or Policy objects.

Response

200 - application/json
data
object
required
success
boolean
required

Indicates whether the operation was performed successfully.

OverviewIgnition Status Handling