Skip to main content

client.identity

IdentityClient Objects​

class IdentityClient()

Represents a client for interacting with the Bloock Identity service.

__init__​

def __init__(config_data=None) -> None

Creates a new instance of the IdentityClient with the provided configuration.

create_holder​

def create_holder(holder_key: Key, did_method: DidMethod) -> Holder

Creates a new holder identity.

create_issuer​

def create_issuer(issuer_key: Key,
                  publish_interval: PublishIntervalParams,
                  did_method: DidMethod,
                  name: str = None,
                  description: str = None,
                  image: str = None) -> Issuer

Creates a new issuer on the Bloock Identity service.

import_issuer​

def import_issuer(issuer_key: Key, did_method: DidMethod) -> Issuer

Retrieves the issuer based on the issuer key and DID method.

build_schema​

def build_schema(display_name: str, schema_type: str, version: str,
                 description: str) -> SchemaBuilder

Creates a new schema builder for defining a schema on the Bloock Identity service.

get_schema​

def get_schema(schema_id: str) -> Schema

Gets a schema from the Bloock Identity service based on the schema ID (ex: Qma1t4uzbnB93E4rasNdu5UWMDh5qg3wMkPm68cnEyfnoM).

build_credential​

def build_credential(issuer: Issuer, display_name: str, holder_did: str,
                     expiration: int, version: int) -> CredentialBuilder

Creates a new credential builder for defining a credential on the Bloock Identity service.

get_credential​

def get_credential(credential_id: str) -> Credential

Retrieves the Verifiable Credential entity based on the credential ID (UUID). (ex: 1bf0c79e-55e6-4f14-aa9d-fb55619ba0cf)

get_credential_offer​

def get_credential_offer(issuer: Issuer, credential_id: str) -> str

Retrieves the json raw offer based on the credential ID (UUID). (ex: 1bf0c79e-55e6-4f14-aa9d-fb55619ba0cf)

force_publish_issuer_state​

def force_publish_issuer_state(issuer: Issuer) -> IssuerStateReceipt

Publishes the state of an issuer on the Bloock Identity service.

get_credential_proof​

def get_credential_proof(issuer_did: str,
                         credential_id: str) -> CredentialProof

Gets the proof of a credential on the Bloock Identity service.

revoke_credential​

def revoke_credential(credential: Credential, issuer: Issuer) -> bool

Revokes a credential on the Bloock Identity service.

create_verification​

def create_verification(proof_request: str) -> VerificationReceipt

Creates a new verification session on the identity managed API provided.

wait_verification​

def wait_verification(session_id: int, timeout=120000) -> bool

Waits for the completion of a verification session on the identity managed API provided.

get_verification_status​

def get_verification_status(session_id: int) -> bool

Gets the status of a verification session on the identity managed API provided.

Last updated on