API Documentation

Use the RiskAdvisor API to manage clients and risk profiles, and to read policies, quote form submissions, and call-in quotes.

Getting started

To get started, create an API token in your account settings, then call the HTTP API with that token.

Guides

Authentication

Learn how to authenticate your API requests.

Read more

Pagination

Understand how to work with paginated responses.

Read more

Errors

Read about the different types of errors returned by the API.

Read more

Resources

Clients

Learn about the client model and how to create, retrieve, update, delete, and list clients.

Risk Profiles

List and create risk profiles, then add drivers, vehicles, and notes.

Policies

List policy link results, including the client, risk profile, and decoded policy payload.

Call-in quotes

List call-in quote submissions for the current team.

Quote forms

List submitted quote forms for the current team.

Custom quote forms

List submitted custom quote forms, including field responses.

Teams

List the teams the authenticated user belongs to.

Current user

Retrieve the user behind the current API token.