Skip to main content
API docs by Redocly

keyper HPS Admin API (v1)

Download OpenAPI specification:Download

E-mail: developers@keyper.io

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).

Test

Import new test-codes

Import new test-codes that can be used to perform tests. Please ensure, these codes are unique within the system. It´s recommeded to prefix them.

The test.write scopes is required.

Authorizations:
Bearer
Request Body schema: application/json
Array of objects or null (ImportTestDto)
Array
test_code
required
string <= 100 characters

Responses

Request samples

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

Response samples

Content type
No sample

Test Execution

Get basic information about a test execution

Get info about a test execution.

The test-execution.read scopes is required.

Authorizations:
Bearer
path Parameters
testCode
required
string
query Parameters
includeMetadata
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "test_execution_id": 0,
  • "organizationId": "string",
  • "code": "string",
  • "type": "string",
  • "manufacturer": "string",
  • "material": "string",
  • "name": "string",
  • "external_reference": "string",
  • "externalReference": "string",
  • "state": "not_started",
  • "result": "invalid",
  • "created_at": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

Get the Personal Identifiable Information (PII) for a test execution

Get PII for a test execution.

The pii.read and test-execution.read scopes are required.

Authorizations:
Bearer
path Parameters
testCode
required
string

Responses

Response samples

Content type
application/json
{
  • "salutation": "string",
  • "title": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "gender": "string",
  • "email": "string",
  • "phone": "string",
  • "date_of_birth": "2019-08-24T14:15:22Z",
  • "insurance_number": "string",
  • "id_number": "string",
  • "cfp_key": "string",
  • "city": "string",
  • "street": "string",
  • "country_code": "string",
  • "postal_code": "string"
}