Credential Issuance

Issue a Verifiable Credentials using Credential Issuance Service.

Install Dependency

Package: affinidi_tdk_credential_issuance_client

pip install affinidi_tdk_credential_issuance_client

You can check the latest version of this module on the PyPi repository or view the source code at the GitHub repository.

Classes and Methods

Configuration API

Manage the issuance configuration for the project. Project only one issuance configuration.

create_issuance_config

Create an issuance configuration for the project.

Parameters

CreateIssuanceConfigInput [Object]

JSON object to provide the details of the configuration. See more here.

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.ConfigurationApi(api_client)

    request_json = {
        "credentialSupported": [
            {
                "credentialTypeId": "SchemaOne",
                "jsonSchemaUrl": "https://schema.affinidi.io/SchemaOneV1R1.json",
                "jsonLdContextUrl": "https://schema.affinidi.io/SchemaOneV1R1.jsonld"
            }
        ],
        "issuerWalletId": "<Wallet_ID>",
        "credentialOfferDuration": 3600,
        "format": "ldp_vc",
    }

    create_issuance_config_input = affinidi_tdk_credential_issuance_client.CreateIssuanceConfigInput.from_dict(request_json)

    api_response = api_instance.create_issuance_config(create_issuance_config_input=create_issuance_config_input)

delete_issuance_config_by_id

Delete the issuance configuration by ID.

Parameters

configurationId [String]

ID of the issuance configuration to delete.

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.ConfigurationApi(api_client)

    configurationId = "<Config_ID>"

    api_response = api_instance.delete_issuance_config_by_id(configurationId)

get_issuance_config_by_id

Retrieves the Issuance Configuration details by ID.

Parameters

configurationId [String]

ID of the issuance configuration to retrieve.

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.ConfigurationApi(api_client)

    configurationId = "<Config_ID>"

    api_response = api_instance.get_issuance_config_by_id(configurationId)

get_issuance_config_list

Get the list of issuance configuration for the current project.

Parameters

No Parameters Required

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.ConfigurationApi(api_client)

    api_response = api_instance.get_issuance_config_list()

update_issuance_config_by_id

Update the existing Issuance Configuration by ID.

Parameters

configurationId [String]

ID of the issuance configuration to retrieve.

UpdateIssuanceConfigInput [Object]

JSON object to provide the details to update the issuance configuration. See more here.

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.ConfigurationApi(api_client)

    configurationId = "<Config_ID>"
    request_json = {
        "credentialSupported": [
            {
                "credentialTypeId": "SchemaOne",
                "jsonSchemaUrl": "https://schema.affinidi.io/SchemaOneV1R1.json",
                "jsonLdContextUrl": "https://schema.affinidi.io/SchemaOneV1R1.jsonld"
            }
        ],
        "issuerWalletId": "<Wallet_ID>",
        "credentialOfferDuration": 3600,
        "format": "ldp_vc",
    }

    update_issuance_config_input = affinidi_tdk_credential_issuance_client.UpdateIssuanceConfigInput.from_dict(request_json)

    api_response = api_instance.update_issuance_config_by_id(configurationId, update_issuance_config_input=update_issuance_config_input)

Issuance API

Use to initiate issuance of the credential and check the status.

issuance_state

Retrieve the status of issuance.

Parameters

issuanceId [String]

ID of the initiated issuance.

projectId [String]

Project ID from where the issuance was initiated.

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.IssuanceApi(api_client)

    issuanceId = "<Issuance_ID>"
    projectId = "<Project_ID>"

    api_response = api_instance.issuance_state(issuanceId, projectId)

list_issuance

Get the list of issuance initiated in the Project.

Parameters

projectId [String]

Project ID from where to list the issuance.

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.IssuanceApi(api_client)

    projectId = "<Project_ID>"

    api_response = api_instance.list_issuance(projectId)

start_issuance

Used to initiate the issuance of the credential.

Parameters

projectId [String]

Project ID from where to initiate the issuance.

StartIssuanceInput [Object]

JSON object to provide the details of the credentials to issue. See more here.

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.IssuanceApi(api_client)

    projectId = "<Project_ID>"
    request_json = {
        "data": [{
            "credentialTypeId": "SchemaOne",
            "credentialData": {
                "first_name": "FirstName",
                "last_name": "LastName",
                "dob": "1970-01-01",
            }
        }],
        "holderDid": "did:key:holder-did-value",
        "claimMode": "FIXED_HOLDER"
    }

    start_issuance_input = affinidi_tdk_credential_issuance_client.StartIssuanceInput.from_dict(request_json)

    api_response = api_instance.start_issuance(projectId, start_issuance_input=start_issuance_input)

Credentials API

Issue a Verifiable Credentials to the users.

generate_credentials

Generate and issue a credentil offer to the user.

Parameters

projectId [String]

Project ID from where you want to issue the credential.

CreateCredentialInput [Object]

JSON object to provide the details of the credential to generate. See more here.

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.CredentialsApi(api_client)

    projectId = "<Project_ID>"
    request_json = {
        "credential_identifier": "SchemaOne",
        "proof": {
            "proof_type": "jwt",
            "jwt":
            "eyJ0eXAiOiJvcGVuaWQ0dmNpLXByb29mK2p3dCIsImFsZyI6IkVTMjU2IiwiandrI
            jp7Imt0eSI6IkVDIiwiY3J2IjoiUC0yNTYiLCJ4IjoiblVXQW9BdjNYWml0aDhFN2k
            xOU9kYXhPTFlGT3dNLVoyRXVNMDJUaXJUNCIsInkiOiJIc2tIVThCalVpMVU5WHFpN
            1N3bWo4Z3dBS18weGtjRGpFV183MVNvc0VZIn19.eyJhdWQiOiJodHRwczovL2NyZW
            RlbnRpYWwtaXNzdWVyLmV4YW1wbGUuY29tIiwiaWF0IjoxNzAxOTYwNDQ0LCJub25j
            ZSI6IkxhclJHU2JtVVBZdFJZTzZCUTR5bjgifQ.-a3EDsxClUB4O3LeDD5DVGEnNMT
            01FCQW4P6-2-BNBqc_Zxf0Qw4CWayLEpqkAomlkLb9zioZoipdP-jvh1WlA"
        }
    }

    create_credential_input = affinidi_tdk_credential_issuance_client.CreateCredentialInput.from_dict(request_json)

    api_response = api_instance.generate_credentials(projectId, create_credential_input=create_credential_input)

Default API

Revoke a revocable Verifiable Credentials issued to the users.

change_credential_status

Updates the status of the credential (e.g., REVOKED).

Parameters

projectId [String]

Project ID from where the credential is issued.

configurationId [String]

Configuration ID from where the credential is issued.

ChangeCredentialStatusInput [Object]

JSON object with details of the credential to revoke. See more here.

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.DefaultApi(api_client)

    projectId = "<Project_ID>"
    configId = "<Config_ID>"

    request_json = {
        "changeReason": "INVALID_CREDENTIAL",
        "issuanceRecordId": "<Record_ID>"
    }

    change_credential_status_input = affinidi_tdk_credential_issuance_client.ChangeCredentialStatusInput.from_dict(request_json)

    api_response = api_instance.change_credential_status(projectId, configId, change_credential_status_input=change_credential_status_input)

list_issuance_data_records

Retrieves the list of records of revocable credentials. The list contains information about the issued credential, such as status, including the record ID, which you can use to revoke a particular credential.

Parameters

projectId [String]

Project ID from where the credential is issued.

configurationId [String]

Configuration ID from where the credential is issued.

limit [Integer]

Maximum number of records to fetch in a list.

exclusiveStartKey [String]

The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.DefaultApi(api_client)

    projectId = "<Project_ID>"
    configId = "<Config_ID>"

    api_response = api_instance.list_issuance_data_records(projectId, configId)

Offer API

Used to get the credential offer initiated by the Issuance API.

get_credential_offer

Retrieves the credential offer details.

Parameters

issuanceId [String]

ID of the issuance initiated.

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.OfferApi(api_client)

    projectId = "<Project_ID>"
    issuanceId = "<Issuance_ID>"

    api_response = api_instance.get_credential_offer(projectId, issuanceId)

WellKnown API

Used to get the WellKnown OpenID Credential Issuer information.

get_well_known_open_id_credential_issuer

Retrieves the credential issuer well-known configurations.

Parameters

No Parameters Required

Example


import affinidi_tdk_credential_issuance_client


configuration = affinidi_tdk_credential_issuance_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_credential_issuance_client.WellKnownApi(api_client)

    projectId = "<Project_ID>"

    api_response = api_instance.get_well_known_open_id_credential_issuer(projectId)

Was this page helpful?

Glad to hear it! Please tell us how we can improve more.

Sorry to hear that. Please tell us how we can improve.

Thank you for sharing your feedback so we can improve your experience.