POST
/
ignition
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: <api-key>' \
  --data '{
  "redirectUri": "https://example.com/redirect",
  "webhookUri": "https://example.com/webhook"
}'
{
  "success": true,
  "data": {
    "ignitionToken": "ur7EPeAa0km4wRlDrPJ4Z",
    "ignitionUri": "https://ignition.dev.axle.insure/?token=ur7EPeAa0km4wRlDrPJ4Z"
  }
}

Authorizations

x-client-secret
string
headerrequired

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

x-client-id
string
required

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

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
redirectUri
string

The URI we should direct the user to after authenticating successfully or exiting the Ignition session.

webhookUri
string

The URI we should send updates about this session or the resulting Account or Policy objects.

user
object

User to attach to Ignition session. If user is set, unique id must be provided.

metadata
object

Optional object to store ephermeral information about the session, such as reservationTime. Will be returned in webhook events.

Response

200 - application/json
success
boolean
required

Indicates whether the operation was performed successfully.

data
object
required
OverviewExchange Token