Get Account
The Get Account method will return an Account object including high-level account information (e.g., name) and any children objects (e.g., Policies) associated with the Account. Please note that this method will NOT refresh the Account object.
Authorizations
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
Your client ID. This will be shared with you during onboarding.
The access token required for access to the requested Account. Returned as part of Exchange Token.
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
Indicates whether the operation was performed successfully.
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.