Integrate Axle’s API into your platform, to provide instant insurance verification solutions for your customers.
destination clients
.
The platform is responsible for onboarding destination clients to Axle, and then can make requests to Axle’s APIs on behalf of the destination client.
Platforms can configure a new destination client using the POST /platform/clients
endpoint.
This will return a unique id
for your new destination client, which the platform should store in their database alongside their internal unique identifier for the destination client,
because it will be used to authorize requests to Axle’s APIs on behalf of the destination client.
Platforms should integrate Axle into their product or service using the process outlined in Axle’s Quickstart guide.
The only major difference is that in addition to providing the x-client-id
and x-client-secret
headers to authorize each request,
the platform should also provide the destination client id
in the additional x-destination-client-id
header.
x-client-id
and x-client-secret
, please
reach out to the Axle team!POST /platform/clients
endpoint to register it as a new destination client.
When registering a new client, you’ll be asked for the following information:
displayName
: A human-friendly name for the destination client. This will be used in Ignition and in the Axle dashboard.entity
: A url-friendly name for the destination client. These must be unique in the Axle system, so it is recommended to use a combination of your platform’s name and the destination client’s name.id
in your database alongside your internal unique identifier for the destination client. This will be used to authorize requests to Axle’s APIs on behalf of the destination client.
If you do happen to lose the destination client id
, you can retrieve it using the GET /platform/clients
endpoint to get a list of all destination clients registered with your platform.
x-destination-client-id
header. The following endpoints can be authorized on behalf of the destination client:
client
parameter with the destination client id
, so you can easily associate an event with the correct destination client. Please refer to the guides on Ignition events and Account or Policy events for more details.