Learn how to use your own authentication system to register Spot kits.

Custom registration flow

Spot

Home Testing for Health & Wellness Companies

Introduction

Learn how to authenticate your requests with the Spot API

Authentication

The status codes and error format for Spot's API

Errors & status codes

Get started right away and place your first order.

Quickstart

The basics you need to understand how Spot operates

Core concepts

Learn how events shape the life of a kit as it travels to the customer and then to the lab to be processed.

Order, sample & kit lifecycles

Advanced kit workflows

This guide will help you understand requisitions and how to use them.

Using requisitions

Learn how to link your ecommerce store to your Spot account to automatically fulfil orders.

Ecommerce Integrations

Create an order for delivering kits to a client, which will be created with a status of 'pending'.The order will be created with the user making the request as the 'placed_by' user.

Create order

Get a list of your orders sorted by recently updated. Providing any query params will further filter the results to only those that match the query params.

List orders

Get order by ID

Replace the metadata for an order with a new set of values

Update order metadata

Query your kits and return a summary, sorted by creation date. Providing any query params will further filter the results to only those that match the query params.

List kits

Returns an individual kit with the given kit id.

Get kit by ID

Create requisition

List requisitions

Get requisition

Create patient

Generate a one-time-use registration token for a patient with a lifetime of 10 minutes.

Welcome

Basic Guides

Advanced Guides

Integrations

API Reference - Orders

API Reference - Kits

API Reference - Requisitions

API Reference - Registration

Custom registration flow