Cloud Agent API | Hyperledger Identus

📄️ Introduction

The Identus Cloud Agent API facilitates the integration and management of self-sovereign identity capabilities within applications.

📄️ Accept a new connection invitation received out-of-band from another peer Agent.

Accept an new connection invitation received out-of-band from another peer Agent.

📄️ As a holder, accept a new credential offer invitation received from another issuer Agent.

As a holder, accept a new credential offer invitation received from an issuer Agent.

📄️ As a holder, accept a new credential offer received from another issuer Agent.

As a holder, accept a new credential offer received from an issuer Agent.

📄️ Decode the invitation extract Request Presentation and Create the proof presentation record with RequestReceived state.

Accept Invitation for request presentation

📄️ Register the `apikey` for the entity

📄️ Create a new connection invitation that can be delivered out-of-band to a peer Agent.

Create a new connection invitation that can be delivered out-of-band to a peer Agent, regardless of whether it resides in Cloud Agent or edge environment.

📄️ Create a new credential configuration

Create a new credential configuration for the issuer.

📄️ Publish new definition to the definition registry, resolvable by DID url

Create the new credential definition record with metadata and internal JSON Schema on behalf of the Cloud Agent. The credential definition will be signed by the keys of Cloud Agent and issued by the DID that corresponds to it.

📄️ Publish new definition to the definition registry, resolvable by HTTP url

Create the new credential definition record with metadata and internal JSON Schema on behalf of Cloud Agent. The credential definition will be signed by the keys of Cloud Agent and issued by the DID that corresponds to it.

📄️ Create a new credential issuer

Create a new credential issuer

📄️ As a credential issuer, create a new credential offer Invitation that will be delivered as out-of-band to a peer Agent.

Creates a new credential offer invitation to be delivered as an out-of-band message.

📄️ As a credential issuer, create a new credential offer that will be sent to a holder Agent.

Creates a new credential offer that will be delivered, through a previously established DIDComm connection, to a holder Agent.

📄️ Create a new entity record

Create the new entity record. The entity record is a representation of the account in the system.

📄️ As a Verifier, create a new OOB Invitation as proof presentation request that can be delivered out-of-band to a invitee/prover.

Create a new presentation request invitation that can be delivered out-of-band to a peer Agent, regardless of whether it resides in Cloud Agent or edge environment.

📄️ Create a new presentation-definition

Create a `presentation-definition` object according to the [presentation exchange protocol](https://identity.foundation/presentation-exchange/spec/v2.1.1/).

📄️ Publish new schema to the schema registry, did url resolvable

Create the new credential schema record with metadata and internal JSON Schema on behalf of Cloud Agent. The credential schema will be signed by the keys of Cloud Agent and issued by the DID that corresponds to it.

📄️ Publish new schema to the schema registry, http url resolvable

📄️ Create VDR entry

Create a new VDR entry from the request body by the driver specified in the query parameters

📄️ Create the new verification policy

Create the new verification policy

📄️ Create a UMA resource permission on an authorization server for the wallet.

Create a UMA resource permission on an authorization server for the wallet.

📄️ Create a new wallet

Create a new wallet with the option to provide the seed.

📄️ Deletes a specific connection flow record from the Agent's database based on its unique `connectionId`.

Delete a specific connection flow record from the Agent's database based in its unique `connectionId`.

📄️ Delete the credential configuration

Delete the credential configuration

📄️ Delete the credential issuer

Delete the credential issuer

📄️ Unregister the `apikey` for the entity

Unregister the `apikey` for the entity.

📄️ Delete the entity by `id`

Delete the entity by the unique identifier

📄️ Delete the wallet webhook notification by `id`

Delete the wallet webhook notification by `id`

📄️ Delete VDR entry

Delete VDR entry

📄️ Deleted the verification policy by id

Delete the verification policy by id

📄️ Delete a UMA resource permission on an authorization server for the wallet.

Remove a UMA resource permission on an authorization server for the wallet.

📄️ Get all entities

Get all entities with the pagination by `offset` and `limit` parameters

📄️ Gets the list of proof presentation records.

Get the list of proof presentation records and its status that the Agent have at moment

📄️ Retrieves a specific connection flow record from the Agent's database based on its unique `connectionId`.

Retrieve a specific connection flow record from the Agent's database based in its unique `connectionId`.

📄️ Retrieves the list of connection flow records available from the Agent's database.

Retrieve of a list containing connections available from the Agent's database.

📄️ Get the credential configuration

Get the credential configuration

📄️ Fetch the credential definition from the registry by `guid`, wrapped in an envelope

Fetch the credential definition by the unique identifier, it should have been crated via DID url, otherwise not found error is returned.

📄️ Fetch the credential definition from the registry by `guid`

Fetch the credential definition by the unique identifier

📄️ Fetch the inner definition field of the credential definition from the registry by `guid`, wrapped in an envelope

Fetch the inner definition fields of the credential definition by the unique identifier, it should have been crated via DID url, otherwise not found error is returned.

📄️ Fetch the inner definition field of the credential definition from the registry by `guid`

Fetch the inner definition fields of the credential definition by the unique identifier

📄️ List all credential issuers

List all credential issuers

📄️ Retrieves a specific issue credential flow record from the Agent's database based on its unique `recordId`.

Retrieves a specific issue credential flow record from the Agent's database based on its unique `recordId`.

📄️ Retrieves the list of issue credential records from the Agent's database.

Retrieves the list of issue credential records from the Agent's database.

📄️ Fetch credential status list by its ID

Fetch credential status list by its ID

📄️ Get a specific DID stored in the agent's wallet

Get a specific DID stored in the agent's wallet

📄️ List all DIDs stored in the agent's wallet

List all DIDs stored in the agent's wallet.

📄️ Resolve Prism DID to a W3C representation

Resolve Prism DID to a W3C DID document representation.

📄️ Get the entity by the `id`

Get the entity by the unique identifier

📄️ List wallet webhook notifications

List all registered webhook notifications.

📄️ Get the credential issuer metadata

Get the credential issuer metadata

📄️ Nonce Endpoint

The endpoint that returns a `nonce` value for the [Token Endpoint](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-nonce-endpoint)

📄️ Get a presentation-definition

Get a presentation-definition

📄️ Gets an existing proof presentation record by its unique identifier. More information on the error can be found in the response body.

Returns an existing presentation record by id.

📄️ Fetch the schema from the registry by `guid`

Fetch the credential schema by the unique identifier

📄️ Fetch the schema from the registry by `guid`

Fetch the credential schema by the unique identifier

📄️ Fetch the schema from the registry by `guid`

Fetch the credential schema by the unique identifier

📄️ Fetch the schema from the registry by `guid`

Fetch the credential schema by the unique identifier

📄️ Resolve VDR entry

Resolve VDR entry

📄️ Fetch the verification policy by id

Get the verification policy by id

📄️ Get the wallet by ID

Get the wallet by ID. If the role is tenant, only search the ID of permitted wallets.

📄️ List all permitted wallets

List all permitted wallets. If the role is admin, returns all the wallets. If the role is tenant, only return permitted wallets.

📄️ As an issuer, issues the verifiable credential related the identified issuance flow record.

As an issuer, issues the verifiable credential related the identified issuance flow record.

📄️ List all presentation-definitions

List all `presentation-definitions` in the wallet.

📄️ Lookup credential definitions by indexed fields

Lookup DID url resolvable credential definitions by `author`, `name`, `tag` parameters and control the pagination by `offset` and `limit` parameters

📄️ Lookup credential definitions by indexed fields

Lookup credential definitions by `author`, `name`, `tag` parameters and control the pagination by `offset` and `limit` parameters

📄️ Lookup schemas by indexed fields

Lookup schemas by `author`, `name`, `tags` parameters and control the pagination by `offset` and `limit` parameters

📄️ Lookup schemas by indexed fields

Lookup schemas by `author`, `name`, `tags` parameters and control the pagination by `offset` and `limit` parameters

📄️ Lookup verification policies by query

Lookup verification policies by `name`, and control the pagination by `offset` and `limit` parameters

📄️ Create a new credential offer

Create a new credential offer and return a compliant `CredentialOffer` for the holder's

📄️ Credential Endpoint

OID for VCI [Credential Endpoint](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-credential-endpoint)

📄️ Revoke a credential by its ID

Marks credential to be ready for revocation, it will be revoked automatically

📄️ Deactivate DID in the agent's wallet and post deactivate operation to the VDR

Deactivate DID in the agent's wallet and post deactivate operation to the VDR.

📄️ Publish the DID stored in the agent's wallet to the VDR

Initiate the publication of the DID stored in the agent's wallet to the VDR.

📄️ Update DID in the agent's wallet and post update operation to the VDR

Update DID in the agent's wallet and post the update operation to the VDR.

📄️ Create an unpublished PRISM DID and store it in the agent's wallet

Create an unpublished PRISM DID and store it in the agent's wallet.

📄️ Create wallet webhook notifications

Create a new wallet webhook notification and subscribe to events.

📄️ As a Verifier, create a new proof presentation request and send it to the Prover.

Holder presents proof derived from the verifiable credential to verifier.

📄️ Check the health status of the running service

Returns the health info object of the running service

📄️ Collect the runtime metrics of the running service

Returns the metrics of the running service from the internal Prometheus registry

📄️ Update the credential issuer

Update the credential issuer

📄️ Update the entity record name by `id`

Update the entity record name by `id`

📄️ Update the entity record `walletId` by `id`

Update the entity record `walletId` field by `id`

📄️ Updates the proof presentation record matching the unique identifier, with the specific action to perform.

Accept or reject presentation of proof request.

📄️ Publish the new version of the credential schema to the schema registry

Publish the new version of the credential schema record with metadata and internal JSON Schema on behalf of Cloud Agent. The credential schema will be signed by the keys of Cloud Agent and issued by the DID that corresponds to it.

📄️ Publish the new version of the credential schema to the schema registry

📄️ Update VDR entry

Update VDR entry

📄️ Update the verification policy object by id

Update the verification policy entry

📄️ Get a proof of VDR entry

Get a proof of VDR entry

📄️ Verify a set of credentials as a Verifier

Endpoint to verify a set of verifiable credentials as a Verifier.