@procivis/react-native-one-core
    Preparing search index...

    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>;
        getVerifierInstanceTrustCollections(id: string): Promise<TrustCollections>;
        handleInvitation(
            request: HandleInvitationRequest,
        ): Promise<HandleInvitationResponse>;
        holderAcceptCredential(
            request: HolderAcceptCredentialRequest,
        ): Promise<string>;
        holderGetWalletUnit(id: string): Promise<HolderWalletUnit>;
        holderGetWalletUnitTrustCollections(id: string): Promise<TrustCollections>;
        holderRegisterWalletUnit(
            request: HolderRegisterWalletUnitRequest,
        ): Promise<HolderRegisterWalletUnitResponse>;
        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>;
        holderWalletUnitUpdate(
            id: string,
            request: HolderWalletUnitUpdateRequest,
        ): 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>;
        registerVerifierInstance(
            request: RegisterVerifierInstanceRequest,
        ): Promise<RegisterVerifierInstanceResponse>;
        resolveJsonldContext(url: string): Promise<ResolvedJsonLdContext>;
        resolveTrustEntityByIdentifier(
            request: ResolveTrustEntitiesRequest,
        ): Promise<Record<string, ResolvedTrustEntity[]>>;
        rollbackImport(): Promise<void>;
        runTask(task: string, params: undefined | 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>;
        updateVerifierInstance(
            id: string,
            request: UpdateVerifierInstanceRequest,
        ): 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 getVerifierInstanceTrustCollections handleInvitation holderAcceptCredential holderGetWalletUnit holderGetWalletUnitTrustCollections holderRegisterWalletUnit holderRejectCredential holderRejectProof holderSubmitProof holderSubmitProofV2 holderWalletUnitStatus holderWalletUnitUpdate importCredentialSchema importProofSchema initiateIssuance listCredentials listCredentialSchemas listDids listHistory listIdentifiers listProofs listProofSchemas listTrustAnchors listTrustEntities nfcReadIsoMdlEngagement nfcStopIsoMdlEngagement proposeProof registerVerifierInstance resolveJsonldContext resolveTrustEntityByIdentifier rollbackImport runTask shareCredentialSchema shareProof shareProofSchema uninitialize unpackBackup updateRemoteTrustEntity updateVerifierInstance upsertOrganisation version

    Methods

    • Checks whether a held credential has been suspended or revoked.

      For list-based revocation methods, the signed lists and any DID documents containing public keys used to verify the lists are cached. Use forceRefresh to force the system to retrieve these from the external resource.

      For modcs, use forceRefresh to force the system to request a new MSO.

      Parameters

      • credentialIds: string[]
      • forceRefresh: undefined | boolean

      Returns Promise<CredentialRevocationCheckResponse[]>

    • 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>

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

      Parameters

      • password: string
      • outputPath: string

      Returns Promise<CreatedBackup>

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

      Parameters

      Returns Promise<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.

      Parameters

      Returns Promise<string>

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

      Parameters

      Returns Promise<void>

    • Parameters

      • credentialId: string

      Returns Promise<void>

    • Permanently removes a credential schema.

      Parameters

      • credentialSchemaId: string

      Returns Promise<void>

    • Parameters

      • id: string

      Returns Promise<void>

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

      Parameters

      • proofId: string

      Returns Promise<void>

    • Parameters

      • proofId: string

      Returns Promise<void>

    • Parameters

      • proofSchemaId: string

      Returns Promise<void>

    • Parameters

      • anchorId: string

      Returns Promise<void>

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

      Returns Promise<void>

    • Returns the system configuration.

      Returns Promise<Config>

    • Returns detailed information about a credential in the system.

      Parameters

      • credentialId: string

      Returns Promise<CredentialDetail>

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

      Parameters

      • credentialSchemaId: string

      Returns Promise<CredentialSchemaDetail>

    • Returns details on a single event.

      Parameters

      • historyId: string

      Returns Promise<HistoryListItem>

    • Returns detailed information about a proof request.

      Parameters

      • proofId: string

      Returns Promise<ProofDetail>

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

      Parameters

      Returns Promise<string>

    • Returns wallet registration details from the Wallet Provider.

      Parameters

      • id: string

      Returns Promise<HolderWalletUnit>

    • Rejects an offered credential.

      Parameters

      • interactionId: string

      Returns Promise<void>

    • Rejects a proof request.

      Parameters

      • interactionId: string

      Returns Promise<void>

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

      Parameters

      Returns Promise<void>

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

      Parameters

      Returns 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>

    • Scan NFC for ISO 18013-5 engagment.

      Parameters

      Returns Promise<string>

    • Cancel previously started NFC scan via nfc_read_iso_mdl_engagement.

      Returns Promise<void>

    • Discards the restored database and continues using the original.

      Returns Promise<void>

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

      Parameters

      • task: string
      • params: undefined | string

      Returns Promise<string>

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

      Parameters

      • deleteData: boolean

      Returns Promise<void>

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

      Parameters

      • password: string
      • inputPath: string

      Returns Promise<Metadata>

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

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods
    backupInfocheckRevocationcontinueIssuancecreateBackupcreateDidcreateIdentifiercreateOrganisationcreateProofcreateProofSchemacreateRemoteTrustEntitycreateTrustAnchorcreateTrustEntitydeleteCachedeleteCredentialdeleteCredentialSchemadeleteIdentifierdeleteProofdeleteProofClaimsdeleteProofSchemadeleteTrustAnchorfinalizeImportgenerateKeygetConfiggetCredentialgetCredentialSchemagetHistoryEntrygetIdentifiergetPresentationDefinitiongetPresentationDefinitionV2getProofgetProofSchemagetRemoteTrustEntitygetTrustAnchorgetTrustEntitygetTrustEntityByDidgetVerifierInstanceTrustCollectionshandleInvitationholderAcceptCredentialholderGetWalletUnitholderGetWalletUnitTrustCollectionsholderRegisterWalletUnitholderRejectCredentialholderRejectProofholderSubmitProofholderSubmitProofV2holderWalletUnitStatusholderWalletUnitUpdateimportCredentialSchemaimportProofSchemainitiateIssuancelistCredentialslistCredentialSchemaslistDidslistHistorylistIdentifierslistProofslistProofSchemaslistTrustAnchorslistTrustEntitiesnfcReadIsoMdlEngagementnfcStopIsoMdlEngagementproposeProofregisterVerifierInstanceresolveJsonldContextresolveTrustEntityByIdentifierrollbackImportrunTaskshareCredentialSchemashareProofshareProofSchemauninitializeunpackBackupupdateRemoteTrustEntityupdateVerifierInstanceupsertOrganisationversion