OneCoreInterface

Inheritors

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
abstract suspend fun backupInfo(): UnexportableEntities

Returns information about items that will be excluded from the export.

Link copied to clipboard
abstract suspend fun checkRevocation(credentialIds: List<String>, forceRefresh: Boolean?): List<CredentialRevocationCheckResponse>

Checks whether a held credential has been suspended or revoked.

Link copied to clipboard

For wallet-initiated flows, continues the OpenID4VCI issuance process after completing authorization.

Link copied to clipboard
abstract suspend fun createBackup(password: String, outputPath: String): CreatedBackup

Creates a backup of the current database and writes it to a file.

Link copied to clipboard
abstract suspend fun createDid(request: CreateDidRequest): String

Deprecated. Use the createIdentifier method.

Link copied to clipboard
abstract suspend fun createIdentifier(request: CreateIdentifierRequest): String

Creates a new identifier.

Link copied to clipboard
abstract suspend fun createOrganisation(request: CreateOrganisationRequest): String

Creates an organization.

Link copied to clipboard
abstract suspend fun createProof(request: CreateProofRequest): String

For verifiers, creates a proof request. Choose what information to request via a proof schema, an identifier, and which protocol to use for making the request.

Link copied to clipboard
abstract suspend fun createProofSchema(request: CreateProofSchemaRequest): String

Creates a proof schema, which defines the credentials and claims to request from a wallet. Proof schemas reference credential schemas already created in your own system; create or import those first before building a proof schema that includes their claims.

Link copied to clipboard
Link copied to clipboard
abstract suspend fun createTrustAnchor(anchor: CreateTrustAnchorRequest): String
Link copied to clipboard
abstract suspend fun createTrustEntity(request: CreateTrustEntityRequest): String
Link copied to clipboard
abstract suspend fun deleteCache(types: List<CacheType>?)

Deletes the system cache. See the Caching guide for details on cached entities.

Link copied to clipboard
abstract suspend fun deleteCredential(credentialId: String)
Link copied to clipboard
abstract suspend fun deleteCredentialSchema(credentialSchemaId: String)

Permanently removes a credential schema.

Link copied to clipboard
abstract suspend fun deleteIdentifier(id: String)
Link copied to clipboard
abstract suspend fun deleteProof(proofId: String)

Deletes an incomplete proof request. If the request is in REQUESTED state the proof is retracted instead, retaining history of the interaction.

Link copied to clipboard
abstract suspend fun deleteProofClaims(proofId: String)
Link copied to clipboard
abstract suspend fun deleteProofSchema(proofSchemaId: String)
Link copied to clipboard
abstract suspend fun deleteTrustAnchor(anchorId: String)
Link copied to clipboard
abstract suspend fun finalizeImport()

Commits to the restored database, replacing the original. The old database is deleted.

Link copied to clipboard
abstract suspend fun generateKey(request: GenerateKeyRequest): String
Link copied to clipboard
abstract suspend fun getConfig(): Config

Returns the system configuration.

Link copied to clipboard
abstract suspend fun getCredential(credentialId: String): CredentialDetail

Returns detailed information about a credential in the system.

Link copied to clipboard
abstract suspend fun getCredentialSchema(credentialSchemaId: String): CredentialSchemaDetail

Returns detailed information about a credential schema. A credential schema defines the structure and format of a credential, including the attributes that issuers make claims about. Schemas also specify how issued credentials should be presented in wallets, whether a revocation method is used to manage credential status, and issuer preferences for suitable key storage types for wallets to use.

Link copied to clipboard
abstract suspend fun getHistoryEntry(historyId: String): HistoryListItem

Returns details on a single event.

Link copied to clipboard
abstract suspend fun getIdentifier(id: String): IdentifierDetail
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract suspend fun getProof(proofId: String): ProofDetail

Returns detailed information about a proof request.

Link copied to clipboard
abstract suspend fun getProofSchema(proofSchemaId: String): ProofSchemaDetail
Link copied to clipboard
Link copied to clipboard
abstract suspend fun getTrustAnchor(trustAnchorId: String): TrustAnchorDetail
Link copied to clipboard
abstract suspend fun getTrustEntity(trustEntityId: String): TrustEntityDetail
Link copied to clipboard
abstract suspend fun getTrustEntityByDid(didId: String): TrustEntityDetail
Link copied to clipboard

Returns trust collections curated by the Verifier Provider.

Link copied to clipboard

For a wallet, handles the interaction once the wallet connects to a share endpoint URL (for example, scans the QR code of an offered credential or request for proof).

Link copied to clipboard

Accepts an offered credential. The system will generate a new identifier that matches issuer's restrictions. Alternatively, you can specify an existing identifier.

Link copied to clipboard
abstract suspend fun holderGetWalletUnit(id: String): HolderWalletUnit

Returns wallet registration details from the Wallet Provider.

Link copied to clipboard

Returns trust collections curated by the Wallet Provider.

Link copied to clipboard

Registers the wallet unit with a Wallet Provider.

Link copied to clipboard
abstract suspend fun holderRejectCredential(interactionId: String)

Rejects an offered credential.

Link copied to clipboard
abstract suspend fun holderRejectProof(interactionId: String)

Rejects a proof request.

Link copied to clipboard
abstract suspend fun holderSubmitProof(interactionId: String, submitCredentials: Map<String, List<PresentationSubmitCredentialRequest>>)

Submits a presentation using Presentation Exchange as the query language; this should be used after getPresentationDefinition.

Link copied to clipboard
abstract suspend fun holderSubmitProofV2(interactionId: String, submission: Map<String, List<PresentationSubmitV2CredentialRequest>>)

Submits a presentation using DCQL as a query language; this should be used after getPresentationDefinitionv2.

Link copied to clipboard
abstract suspend fun holderWalletUnitStatus(id: String)

Check status of wallet unit with the Wallet Provider. Will return an error if the unit has been revoked.

Link copied to clipboard
abstract suspend fun holderWalletUnitUpdate(id: String, request: HolderWalletUnitUpdateRequest)

Modifies wallet unit's settings.

Link copied to clipboard

Imports a credential schema shared from another mobile verifier device using the one-core.

Link copied to clipboard
abstract suspend fun importProofSchema(request: ImportProofSchemaRequest): String
Link copied to clipboard

For wallets, starts the OpenID4VCI Authorization Code Flow.

Link copied to clipboard
abstract suspend fun listCredentials(query: CredentialListQuery): CredentialList

Returns a filterable list of credentials in the system.

Link copied to clipboard

Returns a filterable list of credential schemas.

Link copied to clipboard
abstract suspend fun listDids(query: DidListQuery): DidList

Deprecated. Use the listIdentifiers method.

Link copied to clipboard
abstract suspend fun listHistory(query: HistoryListQuery): HistoryList

Returns a filterable list of history events.

Link copied to clipboard
abstract suspend fun listIdentifiers(query: IdentifierListQuery): IdentifierList

Returns a filterable list of identifiers.

Link copied to clipboard
abstract suspend fun listProofs(query: ProofListQuery): ProofList

Returns a filterable list of proof requests.

Link copied to clipboard
Link copied to clipboard
abstract suspend fun listTrustAnchors(filters: TrustAnchorListQuery): TrustAnchorList
Link copied to clipboard
Link copied to clipboard
abstract suspend fun nfcReadIsoMdlEngagement(request: NfcScanRequest): String

Scan NFC for ISO 18013-5 engagment.

Link copied to clipboard
abstract suspend fun nfcStopIsoMdlEngagement()

Cancel previously started NFC scan via nfc_read_iso_mdl_engagement.

Link copied to clipboard
abstract suspend fun proposeProof(request: ProposeProofRequest): ProposeProofResponse

For wallets, initiates device engagement for offline flows. Reference the verificationEngagement entry of your configuration for your options for engagement.

Link copied to clipboard

Registers the verifier unit with a Verifier Provider.

Link copied to clipboard

Returns the @context of a JSON-LD credential. The result is cached.

Link copied to clipboard
abstract suspend fun rollbackImport()

Discards the restored database and continues using the original.

Link copied to clipboard
abstract suspend fun runTask(task: String, params: String?): String

Runs a task. Check the task object of your configuration and reference the configured instance.

Link copied to clipboard
abstract suspend fun shareCredentialSchema(credentialSchemaId: String): CredentialSchemaShareResponse

Produces a URL for sharing a credential schema with another mobile verifier device using the one-core.

Link copied to clipboard
abstract suspend fun shareProof(proofId: String, params: ShareProofRequest): ShareProofResponse

Creates a share URL from a proof request. A wallet holder can use this URL to access the request.

Link copied to clipboard
abstract suspend fun shareProofSchema(proofSchemaId: String): ProofSchemaShareResponse
Link copied to clipboard
abstract suspend fun uninitialize(deleteData: Boolean)

Deleting data while uninitializing the Core erases all wallet data permanently. If data is not deleted it is reused when Core is reinitialized.

Link copied to clipboard
abstract suspend fun unpackBackup(password: String, inputPath: String): Metadata

Makes the restored database active for calls. Follow by calling either finalizeImport or rollbackImport.

Link copied to clipboard
Link copied to clipboard
abstract suspend fun updateVerifierInstance(id: String, request: UpdateVerifierInstanceRequest)

Modifies verifier unit's settings.

Link copied to clipboard
abstract suspend fun upsertOrganisation(request: UpsertOrganisationRequest)

Updates or deactivates an organization if it exists, otherwise creates a new organization using the provided UUID and name.

Link copied to clipboard
abstract fun version(): Version

Returns build information.