Get Account
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": true
}
Headers
Your client ID. This will be shared with you during onboarding.
Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all!
The access token required for access to the requested Account. Returned as part of the Token Exchange flow in exchangeToken.
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
The unique ID for the requested account. Returned as part of the Token Exchange flow in exchangeToken.
Query Parameters
Set to true if you would like to expand related entities (e.g., account, policy, client). Defaults to false.
Response
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.
Indicates whether the operation was performed successfully.
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": true
}