GET
/
accounts
/
{id}
curl --request GET \
  --url https://sandbox.axle.insure/accounts/{id} \
  --header 'x-access-token: <x-access-token>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <api-key>'
{
  "success": true,
  "data": {
    "id": "<string>",
    "carrier": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "policies": [
      "<string>"
    ],
    "connection": {
      "status": "active",
      "updatedAt": "<string>"
    },
    "createdAt": "<string>",
    "modifiedAt": "<string>",
    "refreshedAt": "<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.

​
x-access-token
string
required

The access token required for access to the requested Account. Returned as part of Exchange Token.

​
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.

Path Parameters

​
id
string
required

The unique ID for the requested account. Returned as part of the Token Exchange flow in exchangeToken.

Query Parameters

​
expand
enum<string>

Set to true if you would like to expand related entities (e.g., account, policy, client). Defaults to false.

Available options:
true,
false

Response

200
application/json
​
success
boolean

Indicates whether the operation was performed successfully.

Example:

true

​
data
object

An Account represents an account with an insurance carrier and includes high-level account information (e.g. name) and any Policy objects associated with the Account.