onecore/ch.procivis.one.core/OneCoreInterface

OneCoreInterface

interface OneCoreInterface

Inheritors

Types

Link copied to clipboard
object Companion

Functions

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

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
Link copied to clipboard
abstract suspend fun createDid(request: CreateDidRequest): String
Link copied to clipboard
abstract suspend fun createIdentifier(request: CreateIdentifierRequest): String
Link copied to clipboard
abstract suspend fun createOrganisation(request: CreateOrganisationRequest): String
Link copied to clipboard
abstract suspend fun createProof(request: CreateProofRequest): String

For verifiers, creates a proof request.

Link copied to clipboard
abstract suspend fun createProofSchema(request: CreateProofSchemaRequest): String
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>?)
Link copied to clipboard
abstract suspend fun deleteCredential(credentialId: String)
Link copied to clipboard
abstract suspend fun deleteCredentialSchema(credentialSchemaId: String)
Link copied to clipboard
abstract suspend fun deleteIdentifier(id: String)
Link copied to clipboard
abstract suspend fun deleteProof(proofId: String)
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()
Link copied to clipboard
abstract suspend fun generateKey(request: GenerateKeyRequest): String
Link copied to clipboard
abstract suspend fun getConfig(): Config
Link copied to clipboard
abstract suspend fun getCredential(credentialId: String): CredentialDetail
Link copied to clipboard
abstract suspend fun getCredentialSchema(credentialSchemaId: String): CredentialSchemaDetail
Link copied to clipboard
abstract suspend fun getHistoryEntry(historyId: String): HistoryListItem
Link copied to clipboard
abstract suspend fun getIdentifier(id: String): IdentifierDetail
Link copied to clipboard
abstract suspend fun getPresentationDefinition(proofId: String): PresentationDefinition
Link copied to clipboard
Link copied to clipboard
abstract suspend fun getProof(proofId: String): ProofDetail
Link copied to clipboard
abstract suspend fun getProofSchema(proofSchemaId: String): ProofSchemaDetail
Link copied to clipboard
abstract suspend fun getRemoteTrustEntity(didId: String): RemoteTrustEntityDetail
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
abstract suspend fun handleInvitation(request: HandleInvitationRequest): HandleInvitationResponse

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
abstract suspend fun holderAcceptCredential(request: HolderAcceptCredentialRequest): String

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
Link copied to clipboard
Link copied to clipboard
abstract suspend fun holderRegisterWalletUnit(request: HolderRegisterWalletUnitRequest): HolderRegisterWalletUnitResponse

Register 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)
Link copied to clipboard
abstract suspend fun holderSubmitProof(interactionId: String, submitCredentials: Map<String, List<PresentationSubmitCredentialRequest>>)
Link copied to clipboard
abstract suspend fun holderSubmitProofV2(interactionId: String, submission: Map<String, List<PresentationSubmitV2CredentialRequest>>)
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)

Edit holder wallet unit

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

For wallets, starts the OpenID4VCI Authorization Code Flow.

Link copied to clipboard
abstract suspend fun listCredentials(query: CredentialListQuery): CredentialList
Link copied to clipboard
Link copied to clipboard
abstract suspend fun listDids(query: DidListQuery): DidList
Link copied to clipboard
abstract suspend fun listHistory(query: HistoryListQuery): HistoryList
Link copied to clipboard
abstract suspend fun listIdentifiers(query: IdentifierListQuery): IdentifierList
Link copied to clipboard
abstract suspend fun listProofs(query: ProofListQuery): ProofList
Link copied to clipboard
abstract suspend fun listProofSchemas(filter: ProofSchemaListQuery): ProofSchemaList
Link copied to clipboard
abstract suspend fun listTrustAnchors(filters: TrustAnchorListQuery): TrustAnchorList
Link copied to clipboard
abstract suspend fun listTrustEntities(filters: TrustEntityListQuery): TrustEntityList
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
abstract suspend fun resolveJsonldContext(url: String): ResolvedJsonLdContext
Link copied to clipboard
Link copied to clipboard
abstract suspend fun rollbackImport()
Link copied to clipboard
abstract suspend fun runTask(task: String, params: String?): String
Link copied to clipboard
abstract suspend fun shareCredentialSchema(credentialSchemaId: String): CredentialSchemaShareResponse
Link copied to clipboard
abstract suspend fun shareProof(proofId: String, params: ShareProofRequest): ShareProofResponse
Link copied to clipboard
abstract suspend fun shareProofSchema(proofSchemaId: String): ProofSchemaShareResponse
Link copied to clipboard
abstract suspend fun uninitialize(deleteData: Boolean)
Link copied to clipboard
abstract suspend fun unpackBackup(password: String, inputPath: String): Metadata
Link copied to clipboard
Link copied to clipboard
abstract suspend fun upsertOrganisation(request: UpsertOrganisationRequest)
Link copied to clipboard
abstract fun version(): Version