short-term-api-service

Short Term API Service

Icons

Padlock icons are used to indicate whether a bearer token is required to access an endpoint.

: A bearer token is required.
: A bearer token is not required.

Screens

A breakdown of the main screens throughout the application.

Initial Screen

The first screen the user sees when opening the application. Documentation

Reset Password

The screens seen by the user when resetting their password. Documentation

Home Screen

The screens seen by the user after they register or sign into the application. Documentation

My Vehicles

The screens seen by the user to view or edit their vehicles. Documentation

My Details

The screens seen by the user to view or edit their personal information and preferences. Documentation

Contact Us

The screens seen by the user when they wish to get in contact. Documentation

Endpoints

Endpoints that are used throughout the application to retrieve information or to perform actions such as create or update. The process of performing the actions are the same, however where appropriate responses specific to the actions they describe will be displayed.

Address

Endpoints for retrieving or updating a users address. Documentation

Configuration

Endpoint for retrieving the site configuration. Documentation

Metadata

Endpoints for retrieving metadata data lists. Documentation

Trustpilot

Endpoint for retrieving Trustpilot information. Documentation

User

Endpoints for retrieving and updating user and user profile information. Documentation

Processes

This section describes processes that a user must complete in order to receive a policy.

Quoting

Describes the process of how the user receives a quote.

Payments

Describes how a user pays for a quote to receive a policy.