Generating a statement
A statement is for collecting usage premium. In the case of a pay-by-mile policy, the usage is distance driven and is aggregated over a given period.
Capturing a journey
The By Bits platform is agnostic to where journey data (or usage data) comes from.
Creating a policy
To create a policy, you will need to hit POST /policys with a policy object. A policy object is a detailed JSON payload
Webhooks explained
Webhooks notify your application when an event happens in your account. Webhooks are particularly useful for real-time events.
API error codes explained
Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided. Codes in the 5xx range indicate an error with internal server errors.
Environments explained
The By Bits API endpoints have three different environments (mock, sandbox and production) that can be defined in the headers of API requests.
Logging in a policyholder
The POST /auth/token endpoint is required to create authentication flow for a policyholder to login to a mobile or web application.
Authentication explained
All requests to the By Bits API endpoints need to be authenticated.
