Skip to main content
API docs by Redocly

Co2 Backend (2023-11-03)

Download OpenAPI specification:Download

Public API for keyper's co2 pocket.

Testsystem

Please use https://api.dev.co2p.com/v1 for the test system and as JWT audience.

Account

Create a new account

Request Body schema: application/json
name
required
string
language
string or null
email
string or null
phone
string or null
object (CreateIdentityDto)
object (CreateIdentityDto)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "initialIdentity": {
    },
  • "otherIdentity": {
    }
}

Response samples

Content type
application/json
{
  • "accountKey": "a1ba9121-91cb-4c1e-a87d-5728c28cdd30",
  • "account_key": "8d097bc0-5265-47eb-90ab-cc8e3a1e4f74",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "language": "string",
  • "identities": [
    ],
  • "verificationLevel": "unverified"
}

Get data of currently logged in account

Responses

Response samples

Content type
application/json
{
  • "accountKey": "a1ba9121-91cb-4c1e-a87d-5728c28cdd30",
  • "account_key": "8d097bc0-5265-47eb-90ab-cc8e3a1e4f74",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "language": "string",
  • "identities": [
    ],
  • "verificationLevel": "unverified"
}

Delete currently logged in account

Responses

Response samples

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

Update account's profile

Request Body schema: application/json
name
string or null
email
string or null
phone
string or null
language
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "language": "string"
}

Response samples

Content type
application/json
{
  • "accountKey": "a1ba9121-91cb-4c1e-a87d-5728c28cdd30",
  • "account_key": "8d097bc0-5265-47eb-90ab-cc8e3a1e4f74",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "language": "string",
  • "identities": [
    ],
  • "verificationLevel": "unverified"
}

Get an accounts notification subscriptions

Responses

Response samples

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

Add a new notification subscription for an account

Request Body schema:
endpoint
required
string <email>
topics
required
Array of strings (AccountNotificationTopicEnum) non-empty
Items Value: "test_not_checked_in"

Responses

Request samples

Content type
{
  • "endpoint": "user@example.com",
  • "topics": [
    ]
}

Response samples

Content type
application/json
{
  • "subscriptionArn": "string",
  • "endpoint": "string",
  • "topics": [
    ]
}

Update an existing notification subscription for an account

Request Body schema:
subscriptionArn
required
string
topics
required
Array of strings (AccountNotificationTopicEnum) non-empty
Items Value: "test_not_checked_in"

Responses

Request samples

Content type
{
  • "subscriptionArn": "string",
  • "topics": [
    ]
}

Response samples

Content type
application/json
{
  • "subscriptionArn": "string",
  • "endpoint": "string",
  • "topics": [
    ]
}

Delete an existing notification subscription for an account

Request Body schema:
subscriptionArn
required
string

Responses

Request samples

Content type
{
  • "subscriptionArn": "string"
}

Response samples

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

Verify an account

Request Body schema: application/json
level
required
string (AccountVerificationLevelEnum)
Enum: "unverified" "person"
object (FieldsDto)

Responses

Request samples

Content type
application/json
{
  • "level": "unverified",
  • "fields": {
    }
}

Response samples

Content type
application/json
{
  • "currentLevel": "unverified",
  • "levels": [
    ]
}

Get account verification levels

Responses

Response samples

Content type
application/json
{
  • "currentLevel": "unverified",
  • "levels": [
    ]
}

Co2

Register a co2 project

Request Body schema:
name
required
string
type
required
string
startDate
required
string <date-time>
required
object (LocationDto)
updates
required
string
organizationReference
required
string
object or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "address": {
    },
  • "updates": "string",
  • "organizationReference": "string",
  • "metafields": {
    }
}

Response samples

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

Generate a co2 certificate

Request Body schema:
createdAt
required
string <date-time>
certifiedBy
string or null
co2e
required
number <double>
required
object (TimePeriodDto)
projectID
required
string
object or null

Responses

Request samples

Content type
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "certifiedBy": "string",
  • "co2e": 0,
  • "timePeriod": {
    },
  • "projectID": "string",
  • "metafields": {
    }
}

Response samples

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

Upload pdf document

path Parameters
type
required
string (DocumentTypeEnum)
Enum: "organization" "project" "certificate" "model"
query Parameters
reference
string
Request Body schema: multipart/form-data
ContentType
string
ContentDisposition
string
object
Length
integer <int64>
Name
string
FileName
string

Responses

Get pdf documents

path Parameters
type
required
string (DocumentTypeEnum)
Enum: "organization" "project" "certificate" "model"
query Parameters
reference
string

Responses

Get all organization's projects

path Parameters
organizationReference
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all project's certificates

path Parameters
projectReference
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data of a certificate

path Parameters
certificateReference
required
string

Responses

Response samples

Content type
application/json
{
  • "test_code": "string",
  • "test_type": "unknown",
  • "test": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "state": "not_started",
  • "result": "unknown",
  • "external_reference": "string",
  • "flags": {
    },
  • "result_options": [
    ],
  • "projectName": "string",
  • "projectType": "string",
  • "certificateInfo": {
    },
  • "projectInfo": {
    },
  • "organizationInfo": {
    }
}

Get data of a project

path Parameters
projectReference
required
string

Responses

Response samples

Content type
application/json
{
  • "test_code": "string",
  • "test_type": "unknown",
  • "test": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "state": "not_started",
  • "result": "unknown",
  • "external_reference": "string",
  • "flags": {
    },
  • "result_options": [
    ],
  • "projectName": "string",
  • "projectType": "string",
  • "certificateInfo": {
    },
  • "projectInfo": {
    },
  • "organizationInfo": {
    }
}

Get data of an organization

path Parameters
organizationReference
required
string

Responses

Response samples

Content type
application/json
{
  • "test_code": "string",
  • "test_type": "unknown",
  • "test": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "state": "not_started",
  • "result": "unknown",
  • "external_reference": "string",
  • "flags": {
    },
  • "result_options": [
    ],
  • "projectName": "string",
  • "projectType": "string",
  • "certificateInfo": {
    },
  • "projectInfo": {
    },
  • "organizationInfo": {
    }
}

Get all account's organizations

path Parameters
accountKey
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "test_code": "string",
  • "test_type": "unknown",
  • "test": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "state": "not_started",
  • "result": "unknown",
  • "external_reference": "string",
  • "flags": {
    },
  • "result_options": [
    ],
  • "projectName": "string",
  • "projectType": "string",
  • "certificateInfo": {
    },
  • "projectInfo": {
    },
  • "organizationInfo": {
    }
}

Save result

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

Responses

Request samples

Content type
application/json
{
  • "testCode": "string",
  • "result": "unknown",
  • "metafields": null
}

Response samples

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

Generate co2 calculation model

query Parameters
appID
string

Responses

Response samples

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

Get all verified models

Responses

Response samples

Content type
application/json
{
  • "test_code": "string",
  • "test_type": "unknown",
  • "test": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "state": "not_started",
  • "result": "unknown",
  • "external_reference": "string",
  • "flags": {
    },
  • "result_options": [
    ],
  • "projectName": "string",
  • "projectType": "string",
  • "certificateInfo": {
    },
  • "projectInfo": {
    },
  • "organizationInfo": {
    }
}

Import data

query Parameters
Language
string
ProjectReference
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/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Customize

Get customize layout of the domain

path Parameters
domain
required
string

Responses

Response samples

Content type
application/json
{
  • "groupName": "unknown",
  • "backgroundColor": "string",
  • "mainColor": "string",
  • "mainDarkColor": "string",
  • "mainLightColor": "string",
  • "mainLightest": "string",
  • "orangeColor": "string",
  • "orangeBackground": "string",
  • "textColor": "string",
  • "textOrange": "string",
  • "linkedText": "string",
  • "textMidColor": "string",
  • "logoUrl": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z"
}

CFP

Get an organizations events

Events are logged whenever something interesting happens in the system for the organization (e.g. test checkin, result entered, etc.)

query Parameters
limit
integer <int32> [ 1 .. 50 ]
starting_after
string
starting_at
string
topic
string

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "next_event_id": "string"
}

Get a specific event by it´s id

path Parameters
eventID
required
string

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "next_event_id": "string"
}

Identity

Create a new identity

Request Body schema:
type
string (IdentityType)
Enum: "Undefined" "IDCard" "UsernamePassword" "Microsoft" "ApiKey" "Keycloak"
identity
string or null
key
string or null

Responses

Request samples

Content type
{
  • "type": "Undefined",
  • "identity": "string",
  • "key": "string"
}

Update id card PIN

path Parameters
externalIdentityID
required
string
Request Body schema:
oldPin
required
string
newPin
required
string

Responses

Request samples

Content type
{
  • "oldPin": "string",
  • "newPin": "string"
}

Reset ID-Card

Resetting an ID-Card means generating a new PIN and (if possible) send it per SMS to the account owner.

path Parameters
externalIdentityID
required
string

Responses

Send the id card link per sms to the accounts communication channel.

path Parameters
externalIdentityID
required
string
Request Body schema:
domain
required
string

Responses

Request samples

Content type
{
  • "domain": "string"
}

Remove identity from logged in account

path Parameters
identityType
required
string (IdentityType)
Enum: "Undefined" "IDCard" "UsernamePassword" "Microsoft" "ApiKey" "Keycloak"
externalIdentityID
required
string

Responses

Login

Login an account by an identity

Request Body schema:
type
string (IdentityType)
Enum: "Undefined" "IDCard" "UsernamePassword" "Microsoft" "ApiKey" "Keycloak"
identity
string or null
key
string or null

Responses

Request samples

Content type
{
  • "type": "Undefined",
  • "identity": "string",
  • "key": "string"
}

Login the default app account for an organization

Request Body schema:
appId
required
string
organizationId
required
string
secretKey
required
string
scope
required
string

Responses

Request samples

Content type
{
  • "appId": "string",
  • "organizationId": "string",
  • "secretKey": "string",
  • "scope": "string"
}

Response samples

Content type
No sample

Login an account for a specific organization

path Parameters
organizationID
required
string
Request Body schema:
platform
string (PlatformEnum)
Enum: "Unknown" "web" "ios" "android"

Responses

Request samples

Content type
{
  • "platform": "Unknown"
}

RefreshToken

Refresh JWT from Refresh Token

Request Body schema:
refreshToken
required
string

Responses

Request samples

Content type
{
  • "refreshToken": "string"
}

User

Get user data

Responses

Marketplace

Get public apps from marketplace

Responses

Get all apps of the users current organization

Responses

Create a new app

Request Body schema:
name
required
string
apiVersion
required
string
iconUrl
string or null
scopes
required
Array of strings (AppScopeEnum)
Items Enum: "test.read" "test.write" "pii.read" "test-execution.read" "test-execution.write" "organization.read" "organization.write" "booking.read" "booking.write" "test.pool.manage" "test.result.write"

Responses

Request samples

Content type
{
  • "name": "string",
  • "apiVersion": "string",
  • "iconUrl": "string",
  • "scopes": [
    ]
}

Update an existing app

path Parameters
appID
required
string
Request Body schema:
name
required
string
apiVersion
required
string
iconUrl
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "apiVersion": "string",
  • "iconUrl": "string"
}

Delete an app

path Parameters
appID
required
string

Responses

Webhook

Register a new webhook

path Parameters
appID
required
string
Request Body schema:
url
string or null
topic
string or null

Responses

Request samples

Content type
{
  • "url": "string",
  • "topic": "string"
}

Test a webhook registration

path Parameters
appID
required
string
topic
required
string

Responses

Organization

/organization

Request Body schema:
name
required
string
keyperApiKey
required
string
timezone
required
string
groupName
required
string (GroupTypeEnum)
Enum: "unknown" "cov19" "co2" "edu" "doc" "vaccine"
gln
string or null
contactPhone
string or null
contactEmail
string or null
website
string or null <uri>
mainColor
string or null
object (SaveOrganizationAddressDto)
requiredVerificationLevel
string (AccountVerificationLevelEnum)
Enum: "unverified" "person"
object (SaveOrganizationFeatureDto)

Responses

Request samples

Content type
{
  • "name": "string",
  • "keyperApiKey": "string",
  • "timezone": "string",
  • "groupName": "unknown",
  • "gln": "string",
  • "contactPhone": "string",
  • "contactEmail": "string",
  • "website": "http://example.com",
  • "mainColor": "string",
  • "address": {
    },
  • "requiredVerificationLevel": "unverified",
  • "features": {
    }
}

/organization/{organizationID}

path Parameters
organizationID
required
string
Request Body schema:
name
required
string
timezone
required
string
gln
string or null
contactPhone
string or null
contactEmail
string or null
website
string or null
mainColor
string or null
object (SaveOrganizationAddressDto)
requiredVerificationLevel
string (AccountVerificationLevelEnum)
Enum: "unverified" "person"
object (SaveOrganizationFeatureDto)

Responses

Request samples

Content type
{
  • "name": "string",
  • "timezone": "string",
  • "gln": "string",
  • "contactPhone": "string",
  • "contactEmail": "string",
  • "website": "string",
  • "mainColor": "string",
  • "address": {
    },
  • "requiredVerificationLevel": "unverified",
  • "features": {
    }
}

/organization/{organizationID}

path Parameters
organizationID
required
string

Responses

/organization/{organizationID}/communication-options

path Parameters
organizationID
required
string

Responses

/organization/{organizationID}/communication-options

path Parameters
organizationID
required
string
Request Body schema:
required
Array of objects (SaveCommunicationOptionDto)
Array
id
required
string (CommunicationOptionEnum)
Enum: "email" "sms" "customer_card"
disabled
boolean
selected
boolean

Responses

Request samples

Content type
{
  • "options": [
    ]
}

Organization accounts

Get all accounts that are linked to the organization.

path Parameters
organizationID
required
string
query Parameters
search
string
role
Array of strings
communicationChannel
Array of strings (CommunicationChannelTypeEnum)
Items Enum: "phone" "email"
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ],
  • "totalNumber": 0
}

Create a new account and link in to the organization.

path Parameters
organizationID
required
string
Request Body schema:
name
required
string
language
string or null
email
string or null
phone
string or null
object (CreateIdentityDto)
object (CreateIdentityDto)
roles
required
Array of strings (RoleEnum)
Items Enum: "test.checkin.write" "test.result.write" "organization.manage" "cfp.read" "apps.read" "apps.manage" "vaccination.checkin.write" "organization.test.manage" "support" "security.token.exchange" "test.label.generate" "organization.write" "roles.unspecified"
additionalOrganizations
Array of strings or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "initialIdentity": {
    },
  • "otherIdentity": {
    },
  • "roles": [
    ],
  • "additionalOrganizations": [
    ]
}

Response samples

Content type
application/json
{
  • "accountKey": "a1ba9121-91cb-4c1e-a87d-5728c28cdd30",
  • "account_key": "8d097bc0-5265-47eb-90ab-cc8e3a1e4f74",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "language": "string",
  • "identities": [
    ],
  • "verificationLevel": "unverified",
  • "roles": [
    ],
  • "identityCount": 0,
  • "identity_count": 0,
  • "organizations": [
    ]
}

Get a single linked accounts data.

path Parameters
accountKey
required
string <uuid>
organizationID
required
string

Responses

Response samples

Content type
application/json
{
  • "accountKey": "a1ba9121-91cb-4c1e-a87d-5728c28cdd30",
  • "account_key": "8d097bc0-5265-47eb-90ab-cc8e3a1e4f74",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "language": "string",
  • "identities": [
    ],
  • "verificationLevel": "unverified",
  • "roles": [
    ],
  • "identityCount": 0,
  • "identity_count": 0,
  • "organizations": [
    ]
}

Remove an account from an organization. The account will NOT be deleted!

path Parameters
accountKey
required
string <uuid>
organizationID
required
string

Responses

Response samples

Content type
application/json
{
  • "accountKey": "a1ba9121-91cb-4c1e-a87d-5728c28cdd30",
  • "account_key": "8d097bc0-5265-47eb-90ab-cc8e3a1e4f74",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "language": "string",
  • "identities": [
    ],
  • "verificationLevel": "unverified",
  • "roles": [
    ],
  • "identityCount": 0,
  • "identity_count": 0,
  • "organizations": [
    ]
}

Link an existing account to an organization.

path Parameters
accountKey
required
string <uuid>
organizationID
required
string
Request Body schema:
roles
Array of strings or null (RoleEnum)
Enum: "test.checkin.write" "test.result.write" "organization.manage" "cfp.read" "apps.read" "apps.manage" "vaccination.checkin.write" "organization.test.manage" "support" "security.token.exchange" "test.label.generate" "organization.write" "roles.unspecified"

Responses

Request samples

Content type
{
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "accountKey": "a1ba9121-91cb-4c1e-a87d-5728c28cdd30",
  • "account_key": "8d097bc0-5265-47eb-90ab-cc8e3a1e4f74",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "language": "string",
  • "identities": [
    ],
  • "verificationLevel": "unverified",
  • "roles": [
    ],
  • "identityCount": 0,
  • "identity_count": 0,
  • "organizations": [
    ]
}

Update an accounts roles in the organization.

path Parameters
accountKey
required
string <uuid>
organizationID
required
string
Request Body schema:
roles
Array of strings or null (RoleEnum)
Enum: "test.checkin.write" "test.result.write" "organization.manage" "cfp.read" "apps.read" "apps.manage" "vaccination.checkin.write" "organization.test.manage" "support" "security.token.exchange" "test.label.generate" "organization.write" "roles.unspecified"

Responses

Request samples

Content type
{
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "accountKey": "a1ba9121-91cb-4c1e-a87d-5728c28cdd30",
  • "account_key": "8d097bc0-5265-47eb-90ab-cc8e3a1e4f74",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "language": "string",
  • "identities": [
    ],
  • "verificationLevel": "unverified",
  • "roles": [
    ],
  • "identityCount": 0,
  • "identity_count": 0,
  • "organizations": [
    ]
}

Update an accounts name in the organization.

path Parameters
accountKey
required
string <uuid>
organizationID
required
string
Request Body schema:
updatedName
required
string

Responses

Request samples

Content type
{
  • "updatedName": "string"
}

Response samples

Content type
application/json
{
  • "accountKey": "a1ba9121-91cb-4c1e-a87d-5728c28cdd30",
  • "account_key": "8d097bc0-5265-47eb-90ab-cc8e3a1e4f74",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "language": "string",
  • "identities": [
    ],
  • "verificationLevel": "unverified",
  • "roles": [
    ],
  • "identityCount": 0,
  • "identity_count": 0,
  • "organizations": [
    ]
}

Update an accounts organizations in the organization.

path Parameters
accountKey
required
string <uuid>
organizationID
required
string
Request Body schema:
updatedOrganizations
Array of strings or null
isDeleted
boolean

Responses

Request samples

Content type
{
  • "updatedOrganizations": [
    ],
  • "isDeleted": true
}

Response samples

Content type
application/json
{
  • "accountKey": "a1ba9121-91cb-4c1e-a87d-5728c28cdd30",
  • "account_key": "8d097bc0-5265-47eb-90ab-cc8e3a1e4f74",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "language": "string",
  • "identities": [
    ],
  • "verificationLevel": "unverified",
  • "roles": [
    ],
  • "identityCount": 0,
  • "identity_count": 0,
  • "organizations": [
    ]
}

Get all organization's accounts that should send to them delete warning

path Parameters
organizationID
required
string

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ],
  • "totalNumber": 0
}

Send a delete warning to the list of accounts in the organization.

path Parameters
organizationID
required
string
Request Body schema:
Array of objects or null (AccountInParameter)
Array
accountKey
string <uuid>

Responses

Request samples

Content type
{
  • "accounts": [
    ]
}

Response samples

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

Get all organization's accounts that should be deleted

path Parameters
organizationID
required
string
query Parameters
daysToWait
integer <int32>
Default: 7

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ],
  • "totalNumber": 0
}

Remove a list of accounts in the organization.

path Parameters
organizationID
required
string
Request Body schema:
Array of objects or null (AccountInParameter)
Array
accountKey
string <uuid>

Responses

Request samples

Content type
{
  • "accounts": [
    ]
}

Response samples

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

Create a personal access token

path Parameters
organizationID
required
string
Request Body schema:
tokenName
string or null
expireDate
string <date-time>
roles
Array of strings or null (RoleEnum)
Enum: "test.checkin.write" "test.result.write" "organization.manage" "cfp.read" "apps.read" "apps.manage" "vaccination.checkin.write" "organization.test.manage" "support" "security.token.exchange" "test.label.generate" "organization.write" "roles.unspecified"

Responses

Request samples

Content type
{
  • "tokenName": "string",
  • "expireDate": "2019-08-24T14:15:22Z",
  • "roles": [
    ]
}

Response samples

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

account organizations

Get all organizations that are linked to the account with role admin

path Parameters
accountKey
required
string <uuid>
organizationID
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organization settings - Certificates (CFP)

Create certificate connection

Register a new person and company (for the provided organization) on the CFP blockchain.

path Parameters
organizationID
required
string
Request Body schema:
person_name
required
string
person_email
required
string
organization_name
required
string
organization_legal_id
required
string
self_service_url
string or null
test_types
required
Array of strings (TestTypeEnum)
Items Enum: "unknown" "cov19.antigen" "cov19.pcr" "cov19.pool_pcr" "cov19.antibody" "cov19.vaccine" "co2.org" "co2.project" "co2.cert" "co2.model" "co2.container" "plastic.cert" "plastic.container"

Responses

Request samples

Content type
{
  • "person_name": "string",
  • "person_email": "string",
  • "organization_name": "string",
  • "organization_legal_id": "string",
  • "self_service_url": "string",
  • "test_types": [
    ]
}

Response samples

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

Organization settings - Communication texts

Create new communication text

path Parameters
organizationID
required
string
Request Body schema: application/json
type
required
string (CommunicationChannelTypeEnum)
Enum: "phone" "email"
eventType
required
string
testType
string (TestTypeEnum)
Enum: "unknown" "cov19.antigen" "cov19.pcr" "cov19.pool_pcr" "cov19.antibody" "cov19.vaccine" "co2.org" "co2.project" "co2.cert" "co2.model" "co2.container" "plastic.cert" "plastic.container"
result
required
string (TestResultEnum)
Enum: "unknown" "positive" "negative" "invalid" "done" "complex" "verified"
title
string or null
body
required
string
Array of objects or null (EventCommunicationTextTranslationDto)

Responses

Request samples

Content type
application/json
{
  • "type": "phone",
  • "eventType": "string",
  • "testType": "unknown",
  • "result": "unknown",
  • "title": "string",
  • "body": "string",
  • "translations": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "phone",
  • "testType": "unknown",
  • "result": "unknown",
  • "title": "string",
  • "body": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "translations": [
    ]
}

Get all communication texts

path Parameters
organizationID
required
string

Responses

Response samples

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

Update a communication text

path Parameters
organizationID
required
string
id
required
integer <int64>
Request Body schema: application/json
type
required
string (CommunicationChannelTypeEnum)
Enum: "phone" "email"
eventType
required
string
testType
string (TestTypeEnum)
Enum: "unknown" "cov19.antigen" "cov19.pcr" "cov19.pool_pcr" "cov19.antibody" "cov19.vaccine" "co2.org" "co2.project" "co2.cert" "co2.model" "co2.container" "plastic.cert" "plastic.container"
result
required
string (TestResultEnum)
Enum: "unknown" "positive" "negative" "invalid" "done" "complex" "verified"
title
string or null
body
required
string
Array of objects or null (EventCommunicationTextTranslationDto)

Responses

Request samples

Content type
application/json
{
  • "type": "phone",
  • "eventType": "string",
  • "testType": "unknown",
  • "result": "unknown",
  • "title": "string",
  • "body": "string",
  • "translations": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "phone",
  • "testType": "unknown",
  • "result": "unknown",
  • "title": "string",
  • "body": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "translations": [
    ]
}

Delete a communication text

path Parameters
organizationID
required
string
id
required
integer <int64>
query Parameters
language
string

Responses

Response samples

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

Create or update translation of a communication text

path Parameters
organizationID
required
string
id
required
integer <int64>
language
required
string
Request Body schema: application/json
language
string or null
type
string (CommunicationChannelTypeEnum)
Enum: "phone" "email"
title
string or null
body
string or null

Responses

Request samples

Content type
application/json
{
  • "language": "string",
  • "type": "phone",
  • "title": "string",
  • "body": "string"
}

Response samples

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

Delete a communication text translation.

path Parameters
organizationID
required
string
id
required
integer <int64>
language
required
string

Responses

Response samples

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

Get communication text template

path Parameters
organizationID
required
string
query Parameters
testType
string
type
required
string
result
required
string (TestResultEnum)
Enum: "unknown" "positive" "negative" "invalid" "done" "complex" "verified"
locale
string

Responses

Response samples

Content type
application/json
{
  • "body": "string",
  • "title": "string"
}

Organization dashboard

Get health dashboard for the organization

path Parameters
organizationID
required
string

Responses

Response samples

Content type
application/json
{
  • "otpValidTill": "2019-08-24T14:15:22Z",
  • "testCommunicationEvents": [
    ],
  • "accountCommunicationEvents": [
    ]
}

Organization notifications

Send notification to subscribed accounts

Send a notification about a topic to all subscribed accounts of this organization.

path Parameters
organizationID
required
string
Request Body schema:
topic
required
string (AccountNotificationTopicEnum)
Value: "test_not_checked_in"
message
required
string
object or null

Responses

Request samples

Content type
{
  • "topic": "test_not_checked_in",
  • "message": "string",
  • "metafields": {
    }
}

Response samples

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

Test type

Update the types for the organization

Update the types for the organization

path Parameters
organizationID
required
string
Request Body schema:
groupName
string (GroupTypeEnum)
Enum: "unknown" "cov19" "co2" "edu" "doc" "vaccine"
types
Array of strings or null
isDeleted
boolean

Responses

Request samples

Content type
{
  • "groupName": "unknown",
  • "types": [
    ],
  • "isDeleted": true
}

Response samples

Content type
application/json
{
  • "organizationID": "string",
  • "groupName": "unknown",
  • "types": [
    ]
}

Get test types for organization

Get all test types for an organization

path Parameters
organizationID
required
string
query Parameters
group
string (GroupTypeEnum)
Enum: "unknown" "cov19" "co2" "edu" "doc" "vaccine"

Responses

Response samples

Content type
application/json
{
  • "organizationID": "string",
  • "groupName": "unknown",
  • "types": [
    ]
}

Get standard types by group type for organization

Get all standard types by group for an organization

path Parameters
organizationID
required
string
query Parameters
group
string (GroupTypeEnum)
Enum: "unknown" "cov19" "co2" "edu" "doc" "vaccine"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete test type

Delete test type for a group

path Parameters
groupType
required
string (GroupTypeEnum)
Enum: "unknown" "cov19" "co2" "edu" "doc" "vaccine"
type
required
string
organizationID
required
string

Responses

Response samples

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