Activation

Serve kit activation page

get

Returns an HTML page for end users to activate their test kit and provide test-taker information

Query parameters

kit_idstringRequired

Supplier Kit ID from test kit packaging

Header parameters

X-Terra-Versionstring · enumOptional

The API version to serve this request in. Defaults to your account's pinned version; an account is pinned to the latest version on its first request.

Possible values:

Responses

200

HTML activation form

text/html

Responsestring

400

Invalid kit ID. An unsupported X-Terra-Version also returns 400 with code invalid_api_version.

text/html

500

Internal server error

text/html

get/api/v1/orders/activate

GET /api/v1/orders/activate?kit_id=text HTTP/1.1
Host: vantage.tryterra.co
Accept: */*

text

Activate a test kit

post

Registers test-taker details with the supplier and updates order item status. This endpoint is called after the test-taker receives their kit and provides their information.

Header parameters

X-Terra-Versionstring · enumOptional

The API version to serve this request in. Defaults to your account's pinned version; an account is pinned to the latest version on its first request.

Possible values:

Body

Information provided by test-taker when activating their kit

collection_datestringOptionalExample: 2025-11-15T09:00:00Z

supplier_kit_idstringOptionalExample: KIT123456789

Responses

200

Kit activated successfully

application/json

400

Invalid request body or kit already activated. An unsupported X-Terra-Version also returns 400 with code invalid_api_version.

application/json

404

Kit not found

application/json

409

Kit already activated, or another activation of the same kit is still in progress; retry shortly.

application/json

500

Internal server error

application/json

503

Supplier service unavailable

application/json

post/api/v1/orders/activate

POST /api/v1/orders/activate HTTP/1.1
Host: vantage.tryterra.co
Content-Type: application/json
Accept: */*
Content-Length: 428

{
  "address": {
    "address_line_1": "456 Oxford Street",
    "address_line_2": "Apt 7C",
    "administrative_area": "Greater Manchester",
    "city": "Manchester",
    "country_code": "GB",
    "postal_code": "M1 5GD"
  },
  "collection_date": "2025-11-15T09:00:00Z",
  "recipient": {
    "date_of_birth": "1985-03-20",
    "email": "[email protected]",
    "first_name": "John",
    "gender_at_birth": "male",
    "last_name": "Smith",
    "phone_number": "[phone]"
  },
  "supplier_kit_id": "KIT123456789"
}

{
  "kit_id": "KIT123456789",
  "message": "Kit activated successfully",
  "success": true
}