affinidi_tdk_credential_verification_client 1.31.0

VerificationService

affinidi_tdk_credential_verification_client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

For more information, please visit https://github.com/affinidi/affinidi-tdk

Documentation is available at https://docs.affinidi.com/dev-tools/affinidi-tdk/clients/credential-verification

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install affinidi_tdk_credential_verification_client

Then import the package:

import affinidi_tdk_credential_verification_client

Setuptools

Install via Setuptools.

python setup.py install --user

Then import the package:

import affinidi_tdk_credential_verification_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import affinidi_tdk_credential_verification_client
from affinidi_tdk_credential_verification_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://apse1.api.affinidi.io/ver
# See configuration.py for a list of all supported configuration parameters.
configuration = affinidi_tdk_credential_verification_client.Configuration(
    host = "https://apse1.api.affinidi.io/ver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ProjectTokenAuth
configuration.api_key['ProjectTokenAuth'] = os.environ["API_KEY"]

# Configure a hook to auto-refresh API key for your personal access token (PAT), if expired
import affinidi_tdk_auth_provider

stats = {
  apiGatewayUrl,
  keyId,
  passphrase,
  privateKey,
  projectId,
  tokenEndpoint,
  tokenId,
}
authProvider = affinidi_tdk_auth_provider.AuthProvider(stats)
configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_project_scoped_token()

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ProjectTokenAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with affinidi_tdk_credential_verification_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = affinidi_tdk_credential_verification_client.DefaultApi(api_client)
    verify_credential_input = affinidi_tdk_credential_verification_client.VerifyCredentialInput() # VerifyCredentialInput | VerifyCredentials

    try:
        # Verifying VC
        api_response = api_instance.verify_credentials(verify_credential_input)
        print("The response of DefaultApi->verify_credentials:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->verify_credentials: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://apse1.api.affinidi.io/ver

Class	Method	HTTP request	Description
DefaultApi	verify_credentials	POST /v1/verifier/verify-vcs	Verifying VC
DefaultApi	verify_presentation	POST /v1/verifier/verify-vp	Verifying VP

Documentation For Models

• Constraints
• ConstraintsStatuses
• CredentialRequirements
• CredentialRequirementsConstraints
• Descriptor
• Error
• ErrorDetail
• EvaluateVpOutput
• Field
• Filter
• FilterConst
• FilterItems
• Format
• FreeFormObject
• HolderSubject
• InputDescriptor
• InvalidParameterError
• JwtObject
• LdpObject
• NestedDescriptor
• NotFoundError
• NotFoundErrorDetailsInner
• PdStatus
• PresentationDefinition
• PresentationSubmission
• SubmissionRequirement
• ValidateJwtInput
• ValidateJwtOutput
• VerifyCredentialInput
• VerifyCredentialOutput
• VerifyPresentationInput
• VerifyPresentationOutput
• VerifyPresentationOutputErrors
• W3cCredential
• W3cCredentialCredentialSchema
• W3cCredentialCredentialSubject
• W3cCredentialHolder
• W3cCredentialStatus
• W3cPresentation
• W3cPresentationContext
• W3cPresentationContextOneOfInner
• W3cProof

Documentation For Authorization

Authentication schemes defined for the API:

UserTokenAuth

• Type: API key
• API key parameter name: authorization
• Location: HTTP header

ProjectTokenAuth

• Type: API key
• API key parameter name: authorization
• Location: HTTP header

Author

[e-mail]