Seald Healthcare

create is the SDK’s entry point. It resolves to a SealdHealthcare object, which your application holds before connecting to a tenant. With a SealdHealthcare object, your application can:

• enroll a device
• connect an existing enrollment
• forget an enrollment
• verify an evidence pack offline

create

create creates the SDK bound to a platform. It fetches nothing, because the trust root and the timestamp authorities’ roots are built into the SDK.

TypeScript

function create(config: Config): Promise<SealdHealthcare>

Swift

static func create(_ config: Config) async throws -> SealdHealthcare

Kotlin

suspend fun create(config: Config): SealdHealthcare

Parameters

Name	Type	Description
config	Config	The client kind, the application’s release, and its adapters.

Returns: SealdHealthcare, the entry point bound to this platform.

Records: Nothing. Not a decision.

Errors: None. create contacts nothing and cannot fail with a SealdHealthcareError.

contract

The SDK API major this SDK implements, and the Cloud API major it calls.

TypeScript

readonly contract: { sdkApi: number; cloudApi: number }

Swift

var contract: (sdkApi: Int, cloudApi: Int) { get }

Kotlin

val contract: Contract

Returns: The two majors. Show them in a support ticket to say which contract your application runs against.

Records: Nothing. Not a decision.

enrollments

The enrollments this device holds, one per tenant.

TypeScript

enrollments(): Promise<EnrollmentSummary[]>

Swift

func enrollments() async throws -> [EnrollmentSummary]

Kotlin

suspend fun enrollments(): List<EnrollmentSummary>

Returns: One EnrollmentSummary per tenant this device is enrolled in.

Records: Nothing. Not a decision.

enroll

A new device asks for a device certificate (card). enroll signs in, generates the device key, and submits the request. The Enrollment it returns starts in state pending.

TypeScript

enroll(request: EnrollRequest): Promise<Enrollment>

Swift

func enroll(_ request: EnrollRequest) async throws -> Enrollment

Kotlin

suspend fun enroll(request: EnrollRequest): Enrollment

Parameters

Name	Type	Description
request	EnrollRequest	The hostname, the tenant, and either the card being replaced or a founding token.

Returns: The Enrollment your application shows the person the code on, and waits on.

Records: Nothing. Not a decision.

Errors

• trust-failed: the tenant’s registration or a card fails its check against the trust root built into the SDK.
• unreachable: the Seald Healthcare Cloud cannot be reached.
• canceled: the person does not complete the unlock or the sign-in.

resumeEnrollment

resumeEnrollment returns the request the device still waits on after a restart. A resumed wait starts no second request.

TypeScript

resumeEnrollment(requestId: string): Promise<Enrollment>

Swift

func resumeEnrollment(_ requestId: String) async throws -> Enrollment

Kotlin

suspend fun resumeEnrollment(requestId: String): Enrollment

Parameters

Name	Type	Description
requestId	string	The request id from the Enrollment this device was waiting on before the restart.

Returns: The same Enrollment, at its current state.

Records: Nothing. Not a decision.

Errors: not-found if the SDK holds no such request.

connect

Unlocks the device key of one tenant’s enrollment and returns its Client, with no session open yet.

TypeScript

connect(tenantId: TenantId): Promise<Client>

Swift

func connect(_ tenantId: TenantId) async throws -> Client

Kotlin

suspend fun connect(tenantId: TenantId): Client

Parameters

Name	Type	Description
tenantId	TenantId	The tenant to connect this device’s enrollment to.

Returns: The Client for that tenant. Calls the unlock adapter.

Records: Nothing. Not a decision.

Errors

• locked: the unlock adapter cannot obtain the person’s secret.
• not-found: this device holds no enrollment for the tenant.
• revoked: this device’s card is no longer active.
• release-below-floor: the application’s release is below the tenant’s version floor.

forget

forget removes an enrollment from this device. The card stays active until someone revokes it in the tenant.

TypeScript

forget(tenantId: TenantId): Promise<void>

Swift

func forget(_ tenantId: TenantId) async throws

Kotlin

suspend fun forget(tenantId: TenantId)

Parameters

Name	Type	Description
tenantId	TenantId	The tenant whose enrollment this device forgets.

Returns: Nothing.

Records: Nothing. Not a decision.

verifyPack

verifyPack verifies an evidence pack offline against the trust root built into the SDK and the timestamp authorities’ roots. It needs no enrollment and no key. It resolves no ref.

TypeScript

verifyPack(pack: Bytes): Promise<PackVerification>

Swift

func verifyPack(_ pack: Data) async throws -> PackVerification

Kotlin

suspend fun verifyPack(pack: ByteArray): PackVerification

Parameters

Name	Type	Description
pack	Bytes	The evidence pack’s raw bytes, as evidence.export produced them.

Returns: A PackVerification: whether the pack verifies and, if not, the first failure.

Records: Nothing. Not a decision.

Who may call it: Anyone, from a Seald Healthcare object created with no enrollment. Verification needs no key.

Types

Config

The configuration create takes.

TypeScript

interface Config {
  kind: ClientKind;
  release: string;
  adapters: Adapters;
}

Swift

struct Config {
  let kind: ClientKind
  let release: String
  let adapters: Adapters
}

Kotlin

data class Config(
  val kind: ClientKind,
  val release: String,
  val adapters: Adapters,
)

Field	Type	Description
kind	ClientKind	The kind of Seald Healthcare Client, stated on every session. The version floor is per kind.
release	string	The application’s release, major.minor.patch, checked against the customer’s version floor.
adapters	Adapters	What this platform and this application supply. See Adapters.

Contract

The shape contract returns in Kotlin, where a return type needs a name.

Kotlin

data class Contract(val sdkApi: Int, val cloudApi: Int)

Field	Type	Description
sdkApi	Int	The SDK API major this SDK implements.
cloudApi	Int	The Cloud API major this SDK calls.

EnrollmentSummary

One row of SealdHealthcare.enrollments(): one enrollment this device holds.

TypeScript

interface EnrollmentSummary {
  tenantId: TenantId;
  hostname: string;
  recipientId: RecipientId;
  person: Person;
  cardState: Card['state'];
}

Swift

struct EnrollmentSummary {
  let tenantId: TenantId
  let hostname: String
  let recipientId: RecipientId
  let person: Person
  let cardState: Card.State
}

Kotlin

data class EnrollmentSummary(
  val tenantId: TenantId,
  val hostname: String,
  val recipientId: RecipientId,
  val person: Person,
  val cardState: Card.State,
)

Field	Type	Description
tenantId	TenantId	The tenant this enrollment is in.
hostname	string	The Seald Healthcare Cloud hostname this device enrolled with.
recipientId	RecipientId	This device’s own recipient id in that tenant.
person	Person	The person this device is enrolled as.
cardState	Card’s state	The card’s state as last learned from the Seald Healthcare Cloud. The SDK learns the withdrawal feed’s latest state on the next request.