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

    Interface ONECore

    interface ONECore {
        backupInfo(): Promise<UnexportableEntities>;
        checkRevocation(
            credentialIds: string[],
            forceRefresh: boolean | undefined,
        ): Promise<CredentialRevocationCheckResponse[]>;
        continueIssuance(url: string): Promise<ContinueIssuanceResponse>;
        createBackup(password: string, outputPath: string): Promise<CreatedBackup>;
        createCredentialSchema(
            request: CreateCredentialSchemaRequest,
        ): Promise<string>;
        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>;
        deleteCache(types: CacheType[] | undefined): 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>;
        finalizeImport(): Promise<void>;
        generateKey(request: GenerateKeyRequest): Promise<string>;
        getConfig(): Promise<CoreConfig>;
        getCredential(credentialId: string): Promise<CredentialDetail>;
        getCredentialSchema(
            credentialSchemaId: string,
        ): Promise<CredentialSchemaDetail>;
        getCredentialTrustInformation(
            credentialId: string,
        ): Promise<TrustInformationDetail>;
        getHistoryEntry(historyId: string): Promise<HistoryListItem>;
        getIdentifier(id: string): Promise<IdentifierDetail>;
        getOrganisation(id: string): Promise<OrganisationDetail>;
        getPresentationDefinitionV2(
            proofId: string,
        ): Promise<PresentationDefinitionV2>;
        getProof(proofId: string): Promise<ProofDetail>;
        getProofSchema(proofSchemaId: string): Promise<ProofSchemaDetail>;
        getProofTrustInformation(proofId: string): Promise<TrustInformationDetail>;
        getVersion(): Promise<Version>;
        handleInvitation(
            request: HandleInvitationRequest,
        ): Promise<HandleInvitationResponse>;
        holderAcceptCredential(
            request: HolderAcceptCredentialRequest,
        ): Promise<HolderAcceptCredentialResponse>;
        holderActivateInstance(
            id: string,
            request: HolderActivateInstanceRequest,
        ): Promise<HolderActivateInstanceResponse>;
        holderGetInstance(id: string): Promise<HolderInstance>;
        holderGetTransactionData(
            proofId: string,
            transactionDataId: string,
        ): Promise<ProofTransactionData>;
        holderInstanceStatus(id: string): Promise<void>;
        holderRefreshCredential(
            interactionId: string,
        ): Promise<HolderRefreshCredentialResponse>;
        holderRegisterInstance(
            request: HolderRegisterInstanceRequest,
        ): Promise<HolderRegisterInstanceResponse>;
        holderRejectCredential(
            interactionId: string,
            credentialIds: string[] | undefined,
        ): Promise<void>;
        holderRejectProof(interactionId: string): Promise<void>;
        holderSubmitProofV2(
            interactionId: string,
            submission: Record<string, PresentationSubmitV2CredentialRequest[]>,
        ): 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>;
        nfcReadIsoMdlEngagement(request: NfcScanRequest): Promise<string>;
        nfcStopIsoMdlEngagement(): Promise<void>;
        proposeProof(request: ProposeProofRequest): Promise<ProposeProofResponse>;
        qesAuthorize(request: QesAuthorizeRequest): Promise<QesAuthorizeResponse>;
        qesSign(request: QesSignRequest): Promise<QesSignResponse>;
        resolveJsonldContext(url: string): Promise<ResolvedJsonLdContext>;
        rollbackImport(): Promise<void>;
        runTask(task: string, params: string | undefined): 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>;
        updateOrganisation(request: UpdateOrganisationRequest): Promise<void>;
    }

    Hierarchy

    • Omit<OneCore, "version" | "getConfig">
      • ONECore
    Index
    backupInfo checkRevocation continueIssuance createBackup createCredentialSchema createDid createIdentifier createOrganisation createProof createProofSchema deleteCache deleteCredential deleteCredentialSchema deleteIdentifier deleteProof deleteProofClaims deleteProofSchema finalizeImport generateKey getConfig getCredential getCredentialSchema getCredentialTrustInformation getHistoryEntry getIdentifier getOrganisation getPresentationDefinitionV2 getProof getProofSchema getProofTrustInformation getVersion handleInvitation holderAcceptCredential holderActivateInstance holderGetInstance holderGetTransactionData holderInstanceStatus holderRefreshCredential holderRegisterInstance holderRejectCredential holderRejectProof holderSubmitProofV2 importCredentialSchema importProofSchema initiateIssuance listCredentials listCredentialSchemas listDids listHistory listIdentifiers listProofs listProofSchemas nfcReadIsoMdlEngagement nfcStopIsoMdlEngagement proposeProof qesAuthorize qesSign resolveJsonldContext rollbackImport runTask shareCredentialSchema shareProof shareProofSchema uninitialize unpackBackup updateOrganisation

    • 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: boolean | undefined

      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 and returns its ID. Choose what information to request via a proof schema, an identifier, and which protocol to use for making the request.

      For online protocols, the request is created in CREATED state; share it with the wallet using shareProof. For ISO_MDL, the wallet starts the exchange: pass the device engagement data from the wallet in isoMdlEngagement. The request is created directly in PENDING state and needs no sharing.

      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 entries from the system cache. See Caching for details on cached entity types.

      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.

      For ISO_MDL, this also closes the BLE session.

      Parameters

      • proofId: string

      Returns Promise<void>

    • Deletes the claim data shared by the wallet holder for a proof request, without waiting for the retention period set by the expireDuration of the proof schema. The proof request itself is kept, and claimsRemovedAt records when the claims were deleted.

      Parameters

      • proofId: string

      Returns Promise<void>

    • Parameters

      • proofSchemaId: string

      Returns Promise<void>

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

      Returns Promise<void>

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

    • For wallets, returns what a proof request asks for and which of the wallet's credentials can satisfy it. Use the result to build the submission for holderSubmitProofV2.

      For ISO_MDL requests, every claim has required: false, since the protocol cannot mark claims as mandatory. An incomplete submission may be rejected if the verifier requires claims not submitted.

      Parameters

      • proofId: string

      Returns Promise<PresentationDefinitionV2>

    • Returns detailed information about a proof request.

      Poll this method to follow the state of the request.

      Parameters

      • proofId: string

      Returns Promise<ProofDetail>

    • For wallets; returns the details of a single transaction data entry of a proof request, including human-readable display data and the raw transaction data received from the verifier. The transactionDataId is obtained from getPresentationDefinitionV2. See Transaction Authorization for Wallets for more information.

      Parameters

      • proofId: string
      • transactionDataId: string

      Returns Promise<ProofTransactionData>

    • Checks the status of an instance with the provider. Successful calls return 204. To see the result, call holderGetInstance.

      Parameters

      • id: string

      Returns Promise<void>

    • Rejects credentials or individual batch items. Selecting a batch parent rejects all its items. Without credential_ids, all credentials of the interaction are rejected. A batch format is notified as rejected and excluded from refreshes only when all its items are rejected.

      Parameters

      • interactionId: string
      • credentialIds: string[] | undefined

      Returns Promise<void>

    • For wallets, rejects a proof request. Pass the interactionId of the request, not the proof ID.

      For ISO_MDL, the wallet sends an empty response to the verifier and closes the BLE session.

      Parameters

      • interactionId: string

      Returns Promise<void>

    • For wallets, submits a presentation using DCQL as a query language. Use this after getPresentationDefinitionV2. Pass the interactionId of the request, not the proof ID.

      submission maps each credential query ID from the presentation definition to the credentials chosen for it.

      Parameters

      Returns Promise<void>

    • Cancel previously started NFC scan via nfc_read_iso_mdl_engagement.

      Returns Promise<void>

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

      For ISO_MDL, this creates a proof in PENDING state and starts BLE according to the bleMode set in your configuration. Poll getProof until the state is REQUESTED, then call getPresentationDefinitionV2.

      Parameters

      Returns Promise<ProposeProofResponse>

    • Discards the restored database and continues using the original.

      Returns Promise<void>

    • Triggers a configured task by name. Pass the task name as defined in the task configuration object, and optionally a JSON string of task-specific parameters. Returns the result as a JSON string.

      Parameters

      • task: string
      • params: string | undefined

      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>

    Settings
    Member Visibility

    On This Page
    Methods
    backupInfocheckRevocationcontinueIssuancecreateBackupcreateCredentialSchemacreateDidcreateIdentifiercreateOrganisationcreateProofcreateProofSchemadeleteCachedeleteCredentialdeleteCredentialSchemadeleteIdentifierdeleteProofdeleteProofClaimsdeleteProofSchemafinalizeImportgenerateKeygetConfiggetCredentialgetCredentialSchemagetCredentialTrustInformationgetHistoryEntrygetIdentifiergetOrganisationgetPresentationDefinitionV2getProofgetProofSchemagetProofTrustInformationgetVersionhandleInvitationholderAcceptCredentialholderActivateInstanceholderGetInstanceholderGetTransactionDataholderInstanceStatusholderRefreshCredentialholderRegisterInstanceholderRejectCredentialholderRejectProofholderSubmitProofV2importCredentialSchemaimportProofSchemainitiateIssuancelistCredentialslistCredentialSchemaslistDidslistHistorylistIdentifierslistProofslistProofSchemasnfcReadIsoMdlEngagementnfcStopIsoMdlEngagementproposeProofqesAuthorizeqesSignresolveJsonldContextrollbackImportrunTaskshareCredentialSchemashareProofshareProofSchemauninitializeunpackBackupupdateOrganisation