POST
/
platform
/
clients
Header
Body
curl --request POST \
  --url https://api.axle.insure/platform/clients \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '{
  "displayName": "My Destination Client",
  "entity": "my-destination-client"
}'
{
  "data": {
    "id": "<string>"
  },
  "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!

Body

application/json
displayName
string
required

The name of the destination client to display to the users.

entity
string
required

A standardized entity name for the destination client using all lowercase, and dashes instead of spaces. For example, my-destination-client. 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.

Response

200 - application/json
data
object
required
success
boolean
required

Indicates whether the operation was performed successfully.