Record test taker consent for a kit
POST/api/v1/kits/:kitID/consent
Records the test taker's consent confirmations and identity for a kit. Call this and receive
a success response before POST /api/v1/kits/{kitID}/register — registering a kit with no
recorded consent returns 428 Precondition Required.
Send the same customer details as the registration endpoint (firstName, lastName, email,
dateOfBirth, sex, and optional contact/address fields); they are stored alongside the consent.
isTestTaker and hasAcceptedTos are mandatory and must be sent as true. By submitting them
you attest that the test taker has agreed to the following statements:
- isTestTaker — "I am the test taker and confirm that I am the same person registering this kit and taking the test."
- hasAcceptedTos — "I have read and accepted the Terms of Service and Privacy Policy."
In addition, the test taker must satisfy the New York State requirement in one of two ways —
send at least one of these as true (if neither is true, the request is rejected with 400):
- notNYResident — "I am not a resident of New York State."
- investigationalUseConsent — for a New York resident: your activation interface must present the investigational-use disclaimer, and the test taker consents to the investigational use of this test.
Your activation interface must present accessible links to the Terms of Service and Privacy Policy alongside these confirmations.
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
- 503
Consent recorded successfully
Validation failed — a required confirmation is missing/not true, or neither notNYResident nor investigationalUseConsent was set to true
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 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