POST
/
platform
/
clients
Create Client
curl --request POST \
  --url https://sandbox.axle.insure/platform/clients \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "displayName": "Honda of Pawnee",
  "entity": "superPlatform-honda-of-pawnee"
}'
{
  "success": true,
  "data": {
    "id": "<string>"
  }
}

Authorizations

​
x-client-secret
string
header
required

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.

Body

application/json
​
displayName
string
required

The name of the destination client to display to users (e.g., Honda of Pawnee).

​
entity
string
required

A standardized entity name for the destination client using all lowercase, and dashes instead of spaces. For example, yourPlatform-${yourCustomerId}. Entity names must be unique across all destination clients, and you will recieve a 409 response with a clear status message if the entity name has already been taken.

Note: Please keep in mind that the entity name may be public to your Ignition users, so it should not contain any sensitive information.

Response

​
success
boolean
required

Indicates whether the operation was performed successfully.

Example:

true

​
data
object
required