Skip to main content
API docs by Redocly

C19T Connect API (v1)

Download OpenAPI specification:Download

E-mail: developers@keyper.com

This API can currently be only used by apps. In order to create your own app, please contact our support.

You must authenticate using the OAuth2.0 Client-Credentials flow. You can find there OIDC Discovery Document here.

If you want to interact on an organization, please provide organizationID:appID as client_id in order to login for the correct organization/tenant. The client_secret is your apps secret (also used to sign webhooks).

Cert

Create certificate code

Create new, custom certificate codes that can be used for cert executions

Authorizations:
Bearer
Request Body schema: application/json
certCodes
required
Array of strings non-empty

Cetificate codes that can be used for cert executions.

Responses

Request samples

Content type
application/json
{
  • "certCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "certCodes": [
    ]
}

Submit single cert result

Submit a result for a single certificate

Authorizations:
Bearer
path Parameters
certCode
required
string
Request Body schema: application/json
result
required
string (TestResultEnum)
Enum: "unknown" "positive" "negative" "invalid" "done" "complex"
metafields
any or null

Add custom metafields that can be used in the certificate report.

object (OverwriteTestDto)

Responses

Request samples

Content type
application/json
{
  • "result": "unknown",
  • "metafields": {
    },
  • "overwriteCert": {
    }
}

Response samples

Content type
application/json
{
  • "certCode": "ANY_CERT_CODE",
  • "result": "unknown"
}

Submit intermediate certificate state

Submit intermediate state of a certificate

Authorizations:
Bearer
path Parameters
certCode
required
string
Request Body schema: application/json
customMessage
string or null

Custom message from connector

Responses

Request samples

Content type
application/json
{
  • "customMessage": "string"
}

Response samples

Content type
application/json
{
  • "certCode": "ANY_CERT_CODE",
  • "result": "unknown"
}

Upload pdf report

Upload the report in PDF form. This report can later be downloaded in the admin area

Authorizations:
Bearer
path Parameters
certCode
required
string
Request Body schema: multipart/form-data
ContentType
string
ContentDisposition
string
object
Length
integer <int64>
Name
string
FileName
string

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

Test

Create test code

Create new, custom test codes that can be used for test executions or as test pool header.

Authorizations:
Bearer
Request Body schema: application/json
testCodes
required
Array of strings non-empty

Test codes that can be used for test executions or as test pool header.

Responses

Request samples

Content type
application/json
{
  • "testCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "testCodes": [
    ]
}

Submit single test result

Submit a result for a single test (Antigen rapid test, RT-PCR, etc.)

Authorizations:
Bearer
path Parameters
testCode
required
string

Header code that identifies the pool.

Request Body schema: application/json
result
required
string (TestResultEnum)
Enum: "unknown" "positive" "negative" "invalid" "done" "complex"
suppressCustomerNotification
boolean or null

Set this property when notifications to the customer should be suppressed.

suppressHealthauthorityNotification
boolean or null

Set this property when report to the health authority should be suppressed.

metafields
any or null

Add custom metafields that can be used in the test report.

object (OverwriteTestDto)

Responses

Request samples

Content type
application/json
{
  • "result": "unknown",
  • "suppressCustomerNotification": false,
  • "suppressHealthauthorityNotification": false,
  • "metafields": {
    },
  • "overwriteTest": {
    }
}

Response samples

Content type
application/json
{
  • "testCode": "C19AAP01-ABCD1234-56EF-G7-H8I9",
  • "result": "unknown"
}

Submit intermediate test state

Submit intermediate state of a single test (e.g. laboratory started processing PCR test, pool has to be split up due to a positive pool result, etc.

Authorizations:
Bearer
path Parameters
testCode
required
string

Code of the test.

Request Body schema: application/json
suppressCustomerNotification
boolean or null

Set this property when notifications to the customer should be suppressed.

customMessage
string or null

Custom message from lab

Responses

Request samples

Content type
application/json
{
  • "suppressCustomerNotification": false,
  • "customMessage": "string"
}

Response samples

Content type
application/json
{
  • "testCode": "C19AAP01-ABCD1234-56EF-G7-H8I9",
  • "result": "unknown"
}

Upload dcc

Upload the digital covid certificate in PDF form. This dcc can later be downloaded in the admin area of the C19T tool or be sent to the customer.

Authorizations:
Bearer
path Parameters
testCode
required
string

The code of the test

Request Body schema: multipart/form-data
ContentType
string
ContentDisposition
string
object
Length
integer <int64>
Name
string
FileName
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Upload pdf report

Upload the laboratory report in PDF form. This report can later be downloaded in the admin area of the C19T tool or be sent to the customer.

Authorizations:
Bearer
path Parameters
testCode
required
string

The code of the test

Request Body schema: multipart/form-data
ContentType
string
ContentDisposition
string
object
Length
integer <int64>
Name
string
FileName
string

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

Get organization information for a test.

Get organization information for single test

Authorizations:
Bearer
path Parameters
testCode
required
string

Code of the test.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "contactEmail": "string",
  • "contactPhone": "string"
}

Test pool

Create new pool

Create a new test pool. You are required to have you app installed in all organizations that own the test. Further, every test has to be checked in.

Authorizations:
Bearer
Request Body schema: application/json
poolHeader
required
string

Header code that identifies the pool.

externalReference
string or null

Reference to the pool in the laboratory system.

testCodes
required
Array of strings non-empty

List of test-codes in the pool.

Responses

Request samples

Content type
application/json
{
  • "poolHeader": "string",
  • "externalReference": "string",
  • "testCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "poolHeader": "string",
  • "result": "unknown",
  • "testCodes": {
    }
}

Submit pool result

When submitting a negative result all tests are set to negative. When submitting a positive result, only the pool is set to positive but customers and health authorities are not informed.

Authorizations:
Bearer
path Parameters
poolHeader
required
string

Header code that identifies the pool.

Request Body schema: application/json
result
required
string (TestResultEnum)
Enum: "unknown" "positive" "negative" "invalid" "done" "complex"
suppressCustomerNotification
boolean or null

Set this property when notifications to the customers should be suppressed.

suppressHealthauthorityNotification
boolean or null

Set this property when reports to the health authorities should be suppressed.

Responses

Request samples

Content type
application/json
{
  • "result": "unknown",
  • "suppressCustomerNotification": true,
  • "suppressHealthauthorityNotification": true
}

Response samples

Content type
application/json
{
  • "poolHeader": "string",
  • "result": "unknown",
  • "testCodes": {
    }
}