Interface OneCore

interface OneCore {
    backupInfo(): Promise<UnexportableEntities>;
    checkRevocation(
        credentialIds: string[],
        forceRefresh: undefined | boolean,
    ): Promise<CredentialRevocationCheckResponse[]>;
    continueIssuance(url: string): Promise<ContinueIssuanceResponse>;
    createBackup(password: string, outputPath: string): Promise<CreatedBackup>;
    createDid(request: CreateDidRequest): Promise<string>;
    createIdentifier(request: CreateIdentifierRequest): Promise<string>;
    createOrganisation(request: CreateOrganisationRequest): Promise<string>;
    createProof(request: CreateProofRequest): Promise<string>;
    createProofSchema(request: CreateProofSchemaRequest): Promise<string>;
    createRemoteTrustEntity(
        request: CreateRemoteTrustEntityRequest,
    ): Promise<string>;
    createTrustAnchor(anchor: CreateTrustAnchorRequest): Promise<string>;
    createTrustEntity(request: CreateTrustEntityRequest): Promise<string>;
    deleteCache(types: undefined | CacheType[]): Promise<void>;
    deleteCredential(credentialId: string): Promise<void>;
    deleteCredentialSchema(credentialSchemaId: string): Promise<void>;
    deleteIdentifier(id: string): Promise<void>;
    deleteProof(proofId: string): Promise<void>;
    deleteProofClaims(proofId: string): Promise<void>;
    deleteProofSchema(proofSchemaId: string): Promise<void>;
    deleteTrustAnchor(anchorId: string): Promise<void>;
    finalizeImport(): Promise<void>;
    generateKey(request: GenerateKeyRequest): Promise<string>;
    getConfig(): Promise<Config>;
    getCredential(credentialId: string): Promise<CredentialDetail>;
    getCredentialSchema(
        credentialSchemaId: string,
    ): Promise<CredentialSchemaDetail>;
    getHistoryEntry(historyId: string): Promise<HistoryListItem>;
    getIdentifier(id: string): Promise<IdentifierDetail>;
    getPresentationDefinition(proofId: string): Promise<PresentationDefinition>;
    getPresentationDefinitionV2(
        proofId: string,
    ): Promise<PresentationDefinitionV2>;
    getProof(proofId: string): Promise<ProofDetail>;
    getProofSchema(proofSchemaId: string): Promise<ProofSchemaDetail>;
    getRemoteTrustEntity(didId: string): Promise<RemoteTrustEntityDetail>;
    getTrustAnchor(trustAnchorId: string): Promise<TrustAnchorDetail>;
    getTrustEntity(trustEntityId: string): Promise<TrustEntityDetail>;
    getTrustEntityByDid(didId: string): Promise<TrustEntityDetail>;
    handleInvitation(
        request: HandleInvitationRequest,
    ): Promise<HandleInvitationResponse>;
    holderAcceptCredential(
        request: HolderAcceptCredentialRequest,
    ): Promise<string>;
    holderGetWalletUnit(id: string): Promise<HolderWalletUnit>;
    holderRegisterWalletUnit(
        request: HolderRegisterWalletUnitRequest,
    ): Promise<string>;
    holderRejectCredential(interactionId: string): Promise<void>;
    holderRejectProof(interactionId: string): Promise<void>;
    holderSubmitProof(
        interactionId: string,
        submitCredentials: Record<string, PresentationSubmitCredentialRequest[]>,
    ): Promise<void>;
    holderSubmitProofV2(
        interactionId: string,
        submission: Record<string, PresentationSubmitV2CredentialRequest[]>,
    ): Promise<void>;
    holderWalletUnitStatus(id: string): Promise<void>;
    importCredentialSchema(
        request: ImportCredentialSchemaRequest,
    ): Promise<string>;
    importProofSchema(request: ImportProofSchemaRequest): Promise<string>;
    initiateIssuance(
        request: InitiateIssuanceRequest,
    ): Promise<InitiateIssuanceResponse>;
    listCredentials(query: CredentialListQuery): Promise<CredentialList>;
    listCredentialSchemas(
        query: CredentialSchemaListQuery,
    ): Promise<CredentialSchemaList>;
    listDids(query: DidListQuery): Promise<DidList>;
    listHistory(query: HistoryListQuery): Promise<HistoryList>;
    listIdentifiers(query: IdentifierListQuery): Promise<IdentifierList>;
    listProofs(query: ProofListQuery): Promise<ProofList>;
    listProofSchemas(filter: ProofSchemaListQuery): Promise<ProofSchemaList>;
    listTrustAnchors(filters: TrustAnchorListQuery): Promise<TrustAnchorList>;
    listTrustEntities(filters: TrustEntityListQuery): Promise<TrustEntityList>;
    nfcReadIsoMdlEngagement(request: NfcScanRequest): Promise<string>;
    nfcStopIsoMdlEngagement(): Promise<void>;
    proposeProof(request: ProposeProofRequest): Promise<ProposeProofResponse>;
    resolveJsonldContext(url: string): Promise<ResolvedJsonLdContext>;
    resolveTrustEntityByIdentifier(
        request: ResolveTrustEntitiesRequest,
    ): Promise<Record<string, ResolvedTrustEntity[]>>;
    rollbackImport(): Promise<void>;
    runTask(task: string): Promise<string>;
    shareCredentialSchema(
        credentialSchemaId: string,
    ): Promise<CredentialSchemaShareResponse>;
    shareProof(
        proofId: string,
        params: ShareProofRequest,
    ): Promise<ShareProofResponse>;
    shareProofSchema(proofSchemaId: string): Promise<ProofSchemaShareResponse>;
    uninitialize(deleteData: boolean): Promise<void>;
    unpackBackup(password: string, inputPath: string): Promise<Metadata>;
    updateRemoteTrustEntity(
        request: UpdateRemoteTrustEntityRequest,
    ): Promise<void>;
    upsertOrganisation(request: UpsertOrganisationRequest): Promise<void>;
    version(): Version;
}

Index

Methods

backupInfo checkRevocation continueIssuance createBackup createDid createIdentifier createOrganisation createProof createProofSchema createRemoteTrustEntity createTrustAnchor createTrustEntity deleteCache deleteCredential deleteCredentialSchema deleteIdentifier deleteProof deleteProofClaims deleteProofSchema deleteTrustAnchor finalizeImport generateKey getConfig getCredential getCredentialSchema getHistoryEntry getIdentifier getPresentationDefinition getPresentationDefinitionV2 getProof getProofSchema getRemoteTrustEntity getTrustAnchor getTrustEntity getTrustEntityByDid handleInvitation holderAcceptCredential holderGetWalletUnit holderRegisterWalletUnit holderRejectCredential holderRejectProof holderSubmitProof holderSubmitProofV2 holderWalletUnitStatus importCredentialSchema importProofSchema initiateIssuance listCredentials listCredentialSchemas listDids listHistory listIdentifiers listProofs listProofSchemas listTrustAnchors listTrustEntities nfcReadIsoMdlEngagement nfcStopIsoMdlEngagement proposeProof resolveJsonldContext resolveTrustEntityByIdentifier rollbackImport runTask shareCredentialSchema shareProof shareProofSchema uninitialize unpackBackup updateRemoteTrustEntity upsertOrganisation version

Methods

backupInfo

backupInfo(): Promise<UnexportableEntities>
Returns Promise<UnexportableEntities>

checkRevocation

checkRevocation(
credentialIds: string[],
forceRefresh: undefined | boolean,
): Promise<CredentialRevocationCheckResponse[]>
Parameters
- credentialIds: string[]
- forceRefresh: undefined | boolean
Returns Promise<CredentialRevocationCheckResponse[]>

continueIssuance

continueIssuance(url: string): Promise<ContinueIssuanceResponse>
For wallet-initiated flows, continues the OpenID4VCI issuance process after completing authorization.
- url - Starts with the redirectUri and is used to continue the Authorization Code Flow issuance process. For example: myapp://example/credential-offer?code=xxx&clientId=myWallet&...
Parameters
- url: string
Returns Promise<ContinueIssuanceResponse>

createBackup

createBackup(password: string, outputPath: string): Promise<CreatedBackup>
Parameters
- password: string
- outputPath: string
Returns Promise<CreatedBackup>

createDid

createDid(request: CreateDidRequest): Promise<string>
Parameters
- request: CreateDidRequest
Returns Promise<string>

createIdentifier

createIdentifier(request: CreateIdentifierRequest): Promise<string>
Parameters
- request: CreateIdentifierRequest
Returns Promise<string>

createOrganisation

createOrganisation(request: CreateOrganisationRequest): Promise<string>
Parameters
- request: CreateOrganisationRequest
Returns Promise<string>

createProof

createProof(request: CreateProofRequest): Promise<string>
For verifiers, creates a proof request.
Parameters
- request: CreateProofRequest
Returns Promise<string>

createProofSchema

createProofSchema(request: CreateProofSchemaRequest): Promise<string>
Parameters
- request: CreateProofSchemaRequest
Returns Promise<string>

createRemoteTrustEntity

createRemoteTrustEntity(
request: CreateRemoteTrustEntityRequest,
): Promise<string>
Parameters
- request: CreateRemoteTrustEntityRequest
Returns Promise<string>

createTrustAnchor

createTrustAnchor(anchor: CreateTrustAnchorRequest): Promise<string>
Parameters
- anchor: CreateTrustAnchorRequest
Returns Promise<string>

createTrustEntity

createTrustEntity(request: CreateTrustEntityRequest): Promise<string>
Parameters
- request: CreateTrustEntityRequest
Returns Promise<string>

deleteCache

deleteCache(types: undefined | CacheType[]): Promise<void>
Parameters
- types: undefined | CacheType[]
Returns Promise<void>

deleteCredential

deleteCredential(credentialId: string): Promise<void>
Parameters
- credentialId: string
Returns Promise<void>

deleteCredentialSchema

deleteCredentialSchema(credentialSchemaId: string): Promise<void>
Parameters
- credentialSchemaId: string
Returns Promise<void>

deleteIdentifier

deleteIdentifier(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>

deleteProof

deleteProof(proofId: string): Promise<void>
Parameters
- proofId: string
Returns Promise<void>

deleteProofClaims

deleteProofClaims(proofId: string): Promise<void>
Parameters
- proofId: string
Returns Promise<void>

deleteProofSchema

deleteProofSchema(proofSchemaId: string): Promise<void>
Parameters
- proofSchemaId: string
Returns Promise<void>

deleteTrustAnchor

deleteTrustAnchor(anchorId: string): Promise<void>
Parameters
- anchorId: string
Returns Promise<void>

finalizeImport

finalizeImport(): Promise<void>
Returns Promise<void>

generateKey

generateKey(request: GenerateKeyRequest): Promise<string>
Parameters
- request: GenerateKeyRequest
Returns Promise<string>

getConfig

getConfig(): Promise<Config>
Returns Promise<Config>

getCredential

getCredential(credentialId: string): Promise<CredentialDetail>
Parameters
- credentialId: string
Returns Promise<CredentialDetail>

getCredentialSchema

getCredentialSchema(credentialSchemaId: string): Promise<CredentialSchemaDetail>
Parameters
- credentialSchemaId: string
Returns Promise<CredentialSchemaDetail>

getHistoryEntry

getHistoryEntry(historyId: string): Promise<HistoryListItem>
Parameters
- historyId: string
Returns Promise<HistoryListItem>

getIdentifier

getIdentifier(id: string): Promise<IdentifierDetail>
Parameters
- id: string
Returns Promise<IdentifierDetail>

getPresentationDefinition

getPresentationDefinition(proofId: string): Promise<PresentationDefinition>
Parameters
- proofId: string
Returns Promise<PresentationDefinition>

getPresentationDefinitionV2

getPresentationDefinitionV2(proofId: string): Promise<PresentationDefinitionV2>
Parameters
- proofId: string
Returns Promise<PresentationDefinitionV2>

getProof

getProof(proofId: string): Promise<ProofDetail>
Parameters
- proofId: string
Returns Promise<ProofDetail>

getProofSchema

getProofSchema(proofSchemaId: string): Promise<ProofSchemaDetail>
Parameters
- proofSchemaId: string
Returns Promise<ProofSchemaDetail>

getRemoteTrustEntity

getRemoteTrustEntity(didId: string): Promise<RemoteTrustEntityDetail>
Parameters
- didId: string
Returns Promise<RemoteTrustEntityDetail>

getTrustAnchor

getTrustAnchor(trustAnchorId: string): Promise<TrustAnchorDetail>
Parameters
- trustAnchorId: string
Returns Promise<TrustAnchorDetail>

getTrustEntity

getTrustEntity(trustEntityId: string): Promise<TrustEntityDetail>
Parameters
- trustEntityId: string
Returns Promise<TrustEntityDetail>

getTrustEntityByDid

getTrustEntityByDid(didId: string): Promise<TrustEntityDetail>
Parameters
- didId: string
Returns Promise<TrustEntityDetail>

handleInvitation

handleInvitation(
request: HandleInvitationRequest,
): Promise<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).
Parameters
- request: HandleInvitationRequest
Returns Promise<HandleInvitationResponse>

holderAcceptCredential

holderAcceptCredential(request: HolderAcceptCredentialRequest): Promise<string>
Accepts an offered credential. The system will generate a new identifier that matches issuer's restrictions. Alternatively, you can specify an existing identifier.
Parameters
- request: HolderAcceptCredentialRequest
Returns Promise<string>

holderGetWalletUnit

holderGetWalletUnit(id: string): Promise<HolderWalletUnit>
Parameters
- id: string
Returns Promise<HolderWalletUnit>

holderRegisterWalletUnit

holderRegisterWalletUnit(
request: HolderRegisterWalletUnitRequest,
): Promise<string>
Register with a Wallet Provider.
Parameters
- request: HolderRegisterWalletUnitRequest
Returns Promise<string>

holderRejectCredential

holderRejectCredential(interactionId: string): Promise<void>
Rejects an offered credential.
Parameters
- interactionId: string
Returns Promise<void>

holderRejectProof

holderRejectProof(interactionId: string): Promise<void>
Parameters
- interactionId: string
Returns Promise<void>

holderSubmitProof

holderSubmitProof(
interactionId: string,
submitCredentials: Record<string, PresentationSubmitCredentialRequest[]>,
): Promise<void>
Parameters
- interactionId: string
- submitCredentials: Record<string, PresentationSubmitCredentialRequest[]>
Returns Promise<void>

holderSubmitProofV2

holderSubmitProofV2(
interactionId: string,
submission: Record<string, PresentationSubmitV2CredentialRequest[]>,
): Promise<void>
Parameters
- interactionId: string
- submission: Record<string, PresentationSubmitV2CredentialRequest[]>
Returns Promise<void>

holderWalletUnitStatus

holderWalletUnitStatus(id: string): Promise<void>
Check status of wallet unit with the Wallet Provider. Will return an error if the unit has been revoked.
Parameters
- id: string
Returns Promise<void>

importCredentialSchema

importCredentialSchema(request: ImportCredentialSchemaRequest): Promise<string>
Parameters
- request: ImportCredentialSchemaRequest
Returns Promise<string>

importProofSchema

importProofSchema(request: ImportProofSchemaRequest): Promise<string>
Parameters
- request: ImportProofSchemaRequest
Returns Promise<string>

initiateIssuance

initiateIssuance(
request: InitiateIssuanceRequest,
): Promise<InitiateIssuanceResponse>
For wallets, starts the OpenID4VCI Authorization Code Flow.
Parameters
- request: InitiateIssuanceRequest
Returns Promise<InitiateIssuanceResponse>

listCredentials

listCredentials(query: CredentialListQuery): Promise<CredentialList>
Parameters
- query: CredentialListQuery
Returns Promise<CredentialList>

listCredentialSchemas

listCredentialSchemas(
query: CredentialSchemaListQuery,
): Promise<CredentialSchemaList>
Parameters
- query: CredentialSchemaListQuery
Returns Promise<CredentialSchemaList>

listDids

listDids(query: DidListQuery): Promise<DidList>
Parameters
- query: DidListQuery
Returns Promise<DidList>

listHistory

listHistory(query: HistoryListQuery): Promise<HistoryList>
Parameters
- query: HistoryListQuery
Returns Promise<HistoryList>

listIdentifiers

listIdentifiers(query: IdentifierListQuery): Promise<IdentifierList>
Parameters
- query: IdentifierListQuery
Returns Promise<IdentifierList>

listProofs

listProofs(query: ProofListQuery): Promise<ProofList>
Parameters
- query: ProofListQuery
Returns Promise<ProofList>

listProofSchemas

listProofSchemas(filter: ProofSchemaListQuery): Promise<ProofSchemaList>
Parameters
- filter: ProofSchemaListQuery
Returns Promise<ProofSchemaList>

listTrustAnchors

listTrustAnchors(filters: TrustAnchorListQuery): Promise<TrustAnchorList>
Parameters
- filters: TrustAnchorListQuery
Returns Promise<TrustAnchorList>

listTrustEntities

listTrustEntities(filters: TrustEntityListQuery): Promise<TrustEntityList>
Parameters
- filters: TrustEntityListQuery
Returns Promise<TrustEntityList>

nfcReadIsoMdlEngagement

nfcReadIsoMdlEngagement(request: NfcScanRequest): Promise<string>
Scan NFC for ISO 18013-5 engagment
Parameters
- request: NfcScanRequest
Returns Promise<string>

nfcStopIsoMdlEngagement

nfcStopIsoMdlEngagement(): Promise<void>
Cancel previously started NFC scan via nfc_read_iso_mdl_engagement

Returns Promise<void>

proposeProof

proposeProof(request: ProposeProofRequest): Promise<ProposeProofResponse>
For wallets, initiates device engagement for offline flows. Reference the verificationEngagement entry of your configuration for your options for engagement.
Parameters
- request: ProposeProofRequest
Returns Promise<ProposeProofResponse>

resolveJsonldContext

resolveJsonldContext(url: string): Promise<ResolvedJsonLdContext>
Parameters
- url: string
Returns Promise<ResolvedJsonLdContext>

resolveTrustEntityByIdentifier

resolveTrustEntityByIdentifier(
request: ResolveTrustEntitiesRequest,
): Promise<Record<string, ResolvedTrustEntity[]>>
Parameters
- request: ResolveTrustEntitiesRequest
Returns Promise<Record<string, ResolvedTrustEntity[]>>

rollbackImport

rollbackImport(): Promise<void>
Returns Promise<void>

runTask

runTask(task: string): Promise<string>
Parameters
- task: string
Returns Promise<string>

shareCredentialSchema

shareCredentialSchema(
credentialSchemaId: string,
): Promise<CredentialSchemaShareResponse>
Parameters
- credentialSchemaId: string
Returns Promise<CredentialSchemaShareResponse>

shareProof

shareProof(
proofId: string,
params: ShareProofRequest,
): Promise<ShareProofResponse>
Parameters
- proofId: string
- params: ShareProofRequest
Returns Promise<ShareProofResponse>

shareProofSchema

shareProofSchema(proofSchemaId: string): Promise<ProofSchemaShareResponse>
Parameters
- proofSchemaId: string
Returns Promise<ProofSchemaShareResponse>

uninitialize

uninitialize(deleteData: boolean): Promise<void>
Parameters
- deleteData: boolean
Returns Promise<void>

unpackBackup

unpackBackup(password: string, inputPath: string): Promise<Metadata>
Parameters
- password: string
- inputPath: string
Returns Promise<Metadata>

updateRemoteTrustEntity

updateRemoteTrustEntity(request: UpdateRemoteTrustEntityRequest): Promise<void>
Parameters
- request: UpdateRemoteTrustEntityRequest
Returns Promise<void>

upsertOrganisation

upsertOrganisation(request: UpsertOrganisationRequest): Promise<void>
Parameters
- request: UpsertOrganisationRequest
Returns Promise<void>

version

version(): Version
Returns Version

Interface OneCore

Index

Methods

Methods

backupInfo

Returns Promise<UnexportableEntities>

checkRevocation

Parameters

Returns Promise<CredentialRevocationCheckResponse[]>

continueIssuance

Parameters

Returns Promise<ContinueIssuanceResponse>

createBackup

Parameters

Returns Promise<CreatedBackup>

createDid

Parameters

Returns Promise<string>

createIdentifier

Parameters

Returns Promise<string>

createOrganisation

Parameters

Returns Promise<string>

createProof

Parameters

Returns Promise<string>

createProofSchema

Parameters

Returns Promise<string>

createRemoteTrustEntity

Parameters

Returns Promise<string>

createTrustAnchor

Parameters

Returns Promise<string>

createTrustEntity

Parameters

Returns Promise<string>

deleteCache

Parameters

Returns Promise<void>

deleteCredential

Parameters

Returns Promise<void>

deleteCredentialSchema

Parameters

Returns Promise<void>

deleteIdentifier

Parameters

Returns Promise<void>

deleteProof

Parameters

Returns Promise<void>

deleteProofClaims

Parameters

Returns Promise<void>

deleteProofSchema

Parameters

Returns Promise<void>

deleteTrustAnchor

Parameters

Returns Promise<void>

finalizeImport

Returns Promise<void>

generateKey

Parameters

Returns Promise<string>

getConfig

Returns Promise<Config>

getCredential

Parameters

Returns Promise<CredentialDetail>

getCredentialSchema

Parameters

Returns Promise<CredentialSchemaDetail>

getHistoryEntry

Parameters

Returns Promise<HistoryListItem>

getIdentifier