Register a kit to a customer
POST/api/v1/kits/:kitID/register
Registers a kit to a customer, creating the customer automatically if they do not exist. Registration triggers asynchronous lab processing — the response confirms initiation, not completion.
Consent is required first. Call POST /api/v1/kits/{kitID}/consent and receive a
successful response before registering; a kit with no recorded consent returns
428 Precondition Required.
Access to this endpoint is enabled per account — contact your SiPhox account manager to have it
turned on for your API token. Calls made before access is granted return 503. Sandbox API
tokens are exempt from this gate.
Request
Responses
- 200
- 400
- 404
- 409
- 428
- 500
- 503
Kit registration initiated successfully
Validation failed
Kit not found, does not belong to this business, or belongs to the other environment — a sandbox key can only address SB_-prefixed kits, a live key only real kits
Kit has already been registered
Consent has not been recorded for this kit — call POST /api/v1/kits/{kitID}/consent first
Internal server error
Kit registration is not enabled for this account — contact your SiPhox account manager to request access. Live API tokens only; sandbox API tokens are exempt from this gate