Documentation

Welcome to Spare Docs! Here you can learn more about how to integrate the Spare Open API and explore some of the Spare Platform features.

Quick Links:

Spare Platform →

Api Reference →

Spare Driver App →


Getting Started

Before getting started with your Rider API integration, please review our getting start guide:

Getting started with Spare Open API

Creating a Request

Step 1: Retrieving or Creating a Rider

First, you want to see if a rider exists. Get started by doing [GET /riders](<https://developers.sparelabs.com/docs/public/Open.oas.json/paths/~1riders/get>) and search by phoneNumber, or email. All phone numbers are validated using [libphonenumber](<https://github.com/google/libphonenumber>) and the format of your phone number must match the E.164 format.

If the rider search does not return a result, you will want to create a new rider. You can do this by running [POST /riders](<https://developers.sparelabs.com/docs/public/Open.oas.json/paths/~1riders/get>).