Axle home pagelight logo
Accounts
Get Account
GET

/accounts/{id}

id*
curl --request GET \
  --url https://api.axle.insure/accounts/{id} \
  --header 'x-access-token: <x-access-token>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <x-client-secret>'
{
  "data": {
    "carrier": "state-farm",
    "connection": {
      "status": "active",
      "updatedAt": "2022-01-01T00:00:00.000Z"
    },
    "createdAt": "2022-01-01T00:00:00.000Z",
    "email": "john.smith@grr.la",
    "firstName": "John",
    "id": "acc_gM2wn_gaqUv76ZljeVXOv",
    "lastName": "Smith",
    "modifiedAt": "2022-01-01T00:00:00.000Z",
    "policies": [
      "pol_CbxGmGWnp9bGAFCC-eod2"
    ],
    "refreshedAt": "2022-01-01T00:00:00.000Z"
  },
  "success": "boolean"
}
x-client-idrequired
string

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

x-client-secretrequired
string

Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all!

x-access-tokenrequired
string

The access token required for access to the requested user’s Account. Returned as part of the Token Exchange flow in exchangeToken.

​
Path Parameters

idrequired
string

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

​
Query Parameters

expand
boolean

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

​
Response

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.

success
boolean

Indicates whether the operation was performed successfully.