Skip to main content
POST
/
api
/
v2
/
tokens
/
patient_registration
cURL
curl --request POST \
  --url https://app.spotdx.com/api/v2/tokens/patient_registration/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "patient_id": "<string>",
  "kit_type": "health_kit_1"
}
'
{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtYXgiOjEsInN1YiI6InBhdGllbnRfcmVnaXN0cmF0aW9uIiwibW9kIjoibiIsImp0aSI6MzYsImV4cCI6MTY2MTg4NjgzOCwiaWF0IjoxNjYxODg2MjM4fQ.byD8FThgvNGm3csx_QzrpZQUrsfFW3rmBU3mLQQlL2I"
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotdx.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint is only needed if you want to use your own authentication system to manage kit registration. It’s not needed in most cases. Speak to us if you want to build your registration flow this way.
This endpoint generates a one-time-use token that can be passed to your kit registration page to allow for a more convenient registration process for repeat patients. This token is patient-specific. “patient_id” is Spot’s unique identifier for a patient. It is returned by any of our api endpoints that supply patient information, such as sample and order retrieval. 
{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtYXgiOjEsInN1YiI6InBhdGllbnRfcmVnaXN0cmF0aW9uIiwibW9kIjoibiIsImp0aSI6MzYsImV4cCI6MTY2MTg4NjgzOCwiaWF0IjoxNjYxODg2MjM4fQ.byD8FThgvNGm3csx_QzrpZQUrsfFW3rmBU3mLQQlL2I"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

​
patient_id
string
required

UUID of a patient you've already created.

​
kit_type
string

If this is a multi-purpose kit, optionally specify the kit type it should become. For more information about multi-purpose kits, read the advanced kit workflows guide.

Example:

"health_kit_1"

Response

​
token
string
required
read-only
Example:

"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtYXgiOjEsInN1YiI6InBhdGllbnRfcmVnaXN0cmF0aW9uIiwibW9kIjoibiIsImp0aSI6MzYsImV4cCI6MTY2MTg4NjgzOCwiaWF0IjoxNjYxODg2MjM4fQ.byD8FThgvNGm3csx_QzrpZQUrsfFW3rmBU3mLQQlL2I"