# 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](https://github.com/affinidi/affinidi-tdk)
Documentation is available at [https://docs.affinidi.com/dev-tools/affinidi-tdk/clients/credential-verification](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:
```sh
pip install affinidi_tdk_credential_verification_client
```
Then import the package:
```python
import affinidi_tdk_credential_verification_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
Then import the package:
```python
import affinidi_tdk_credential_verification_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
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**](docs/DefaultApi.md#verify_credentials) | **POST** /v1/verifier/verify-vcs | Verifying VC |
| _DefaultApi_ | [**verify_presentation**](docs/DefaultApi.md#verify_presentation) | **POST** /v1/verifier/verify-vp | Verifying VP |
## Documentation For Models
- [Constraints](docs/Constraints.md)
- [ConstraintsStatuses](docs/ConstraintsStatuses.md)
- [CredentialRequirements](docs/CredentialRequirements.md)
- [CredentialRequirementsConstraints](docs/CredentialRequirementsConstraints.md)
- [Descriptor](docs/Descriptor.md)
- [Error](docs/Error.md)
- [ErrorDetail](docs/ErrorDetail.md)
- [EvaluateVpOutput](docs/EvaluateVpOutput.md)
- [Field](docs/Field.md)
- [Filter](docs/Filter.md)
- [FilterConst](docs/FilterConst.md)
- [FilterItems](docs/FilterItems.md)
- [Format](docs/Format.md)
- [FreeFormObject](docs/FreeFormObject.md)
- [HolderSubject](docs/HolderSubject.md)
- [InputDescriptor](docs/InputDescriptor.md)
- [InvalidParameterError](docs/InvalidParameterError.md)
- [JwtObject](docs/JwtObject.md)
- [LdpObject](docs/LdpObject.md)
- [NestedDescriptor](docs/NestedDescriptor.md)
- [NotFoundError](docs/NotFoundError.md)
- [NotFoundErrorDetailsInner](docs/NotFoundErrorDetailsInner.md)
- [PdStatus](docs/PdStatus.md)
- [PresentationDefinition](docs/PresentationDefinition.md)
- [PresentationSubmission](docs/PresentationSubmission.md)
- [SubmissionRequirement](docs/SubmissionRequirement.md)
- [ValidateJwtInput](docs/ValidateJwtInput.md)
- [ValidateJwtOutput](docs/ValidateJwtOutput.md)
- [VerifyCredentialInput](docs/VerifyCredentialInput.md)
- [VerifyCredentialOutput](docs/VerifyCredentialOutput.md)
- [VerifyPresentationInput](docs/VerifyPresentationInput.md)
- [VerifyPresentationOutput](docs/VerifyPresentationOutput.md)
- [VerifyPresentationOutputErrors](docs/VerifyPresentationOutputErrors.md)
- [W3cCredential](docs/W3cCredential.md)
- [W3cCredentialCredentialSchema](docs/W3cCredentialCredentialSchema.md)
- [W3cCredentialCredentialSubject](docs/W3cCredentialCredentialSubject.md)
- [W3cCredentialHolder](docs/W3cCredentialHolder.md)
- [W3cCredentialStatus](docs/W3cCredentialStatus.md)
- [W3cPresentation](docs/W3cPresentation.md)
- [W3cPresentationContext](docs/W3cPresentationContext.md)
- [W3cPresentationContextOneOfInner](docs/W3cPresentationContextOneOfInner.md)
- [W3cProof](docs/W3cProof.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="UserTokenAuth"></a>
### UserTokenAuth
- **Type**: API key
- **API key parameter name**: authorization
- **Location**: HTTP header
<a id="ProjectTokenAuth"></a>
### ProjectTokenAuth
- **Type**: API key
- **API key parameter name**: authorization
- **Location**: HTTP header
## Author
info@affinidi.com
Raw data
{
"_id": null,
"home_page": "https://github.com/affinidi/affinidi-tdk",
"name": "affinidi_tdk_credential_verification_client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, VerificationService",
"author": "Affinidi",
"author_email": "info@affinidi.com",
"download_url": "https://files.pythonhosted.org/packages/9d/65/a3b0b4fbe18e0bf620dc04031ce33fd5d40e71eca3a123ddf2e1abbe0155/affinidi_tdk_credential_verification_client-1.33.0.tar.gz",
"platform": null,
"description": "# affinidi_tdk_credential_verification_client\n\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nFor more information, please visit [https://github.com/affinidi/affinidi-tdk](https://github.com/affinidi/affinidi-tdk)\n\nDocumentation is available at [https://docs.affinidi.com/dev-tools/affinidi-tdk/clients/credential-verification](https://docs.affinidi.com/dev-tools/affinidi-tdk/clients/credential-verification)\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install affinidi_tdk_credential_verification_client\n```\n\nThen import the package:\n\n```python\nimport affinidi_tdk_credential_verification_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n\nThen import the package:\n\n```python\nimport affinidi_tdk_credential_verification_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport affinidi_tdk_credential_verification_client\nfrom affinidi_tdk_credential_verification_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://apse1.api.affinidi.io/ver\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = affinidi_tdk_credential_verification_client.Configuration(\n host = \"https://apse1.api.affinidi.io/ver\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: ProjectTokenAuth\nconfiguration.api_key['ProjectTokenAuth'] = os.environ[\"API_KEY\"]\n\n# Configure a hook to auto-refresh API key for your personal access token (PAT), if expired\nimport affinidi_tdk_auth_provider\n\nstats = {\n apiGatewayUrl,\n keyId,\n passphrase,\n privateKey,\n projectId,\n tokenEndpoint,\n tokenId,\n}\nauthProvider = affinidi_tdk_auth_provider.AuthProvider(stats)\nconfiguration.refresh_api_key_hook = lambda api_client: authProvider.fetch_project_scoped_token()\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['ProjectTokenAuth'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith affinidi_tdk_credential_verification_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = affinidi_tdk_credential_verification_client.DefaultApi(api_client)\n verify_credential_input = affinidi_tdk_credential_verification_client.VerifyCredentialInput() # VerifyCredentialInput | VerifyCredentials\n\n try:\n # Verifying VC\n api_response = api_instance.verify_credentials(verify_credential_input)\n print(\"The response of DefaultApi->verify_credentials:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->verify_credentials: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://apse1.api.affinidi.io/ver*\n\n| Class | Method | HTTP request | Description |\n| ------------ | ----------------------------------------------------------------- | -------------------------------- | ------------ |\n| _DefaultApi_ | [**verify_credentials**](docs/DefaultApi.md#verify_credentials) | **POST** /v1/verifier/verify-vcs | Verifying VC |\n| _DefaultApi_ | [**verify_presentation**](docs/DefaultApi.md#verify_presentation) | **POST** /v1/verifier/verify-vp | Verifying VP |\n\n## Documentation For Models\n\n- [Constraints](docs/Constraints.md)\n- [ConstraintsStatuses](docs/ConstraintsStatuses.md)\n- [CredentialRequirements](docs/CredentialRequirements.md)\n- [CredentialRequirementsConstraints](docs/CredentialRequirementsConstraints.md)\n- [Descriptor](docs/Descriptor.md)\n- [Error](docs/Error.md)\n- [ErrorDetail](docs/ErrorDetail.md)\n- [EvaluateVpOutput](docs/EvaluateVpOutput.md)\n- [Field](docs/Field.md)\n- [Filter](docs/Filter.md)\n- [FilterConst](docs/FilterConst.md)\n- [FilterItems](docs/FilterItems.md)\n- [Format](docs/Format.md)\n- [FreeFormObject](docs/FreeFormObject.md)\n- [HolderSubject](docs/HolderSubject.md)\n- [InputDescriptor](docs/InputDescriptor.md)\n- [InvalidParameterError](docs/InvalidParameterError.md)\n- [JwtObject](docs/JwtObject.md)\n- [LdpObject](docs/LdpObject.md)\n- [NestedDescriptor](docs/NestedDescriptor.md)\n- [NotFoundError](docs/NotFoundError.md)\n- [NotFoundErrorDetailsInner](docs/NotFoundErrorDetailsInner.md)\n- [PdStatus](docs/PdStatus.md)\n- [PresentationDefinition](docs/PresentationDefinition.md)\n- [PresentationSubmission](docs/PresentationSubmission.md)\n- [SubmissionRequirement](docs/SubmissionRequirement.md)\n- [ValidateJwtInput](docs/ValidateJwtInput.md)\n- [ValidateJwtOutput](docs/ValidateJwtOutput.md)\n- [VerifyCredentialInput](docs/VerifyCredentialInput.md)\n- [VerifyCredentialOutput](docs/VerifyCredentialOutput.md)\n- [VerifyPresentationInput](docs/VerifyPresentationInput.md)\n- [VerifyPresentationOutput](docs/VerifyPresentationOutput.md)\n- [VerifyPresentationOutputErrors](docs/VerifyPresentationOutputErrors.md)\n- [W3cCredential](docs/W3cCredential.md)\n- [W3cCredentialCredentialSchema](docs/W3cCredentialCredentialSchema.md)\n- [W3cCredentialCredentialSubject](docs/W3cCredentialCredentialSubject.md)\n- [W3cCredentialHolder](docs/W3cCredentialHolder.md)\n- [W3cCredentialStatus](docs/W3cCredentialStatus.md)\n- [W3cPresentation](docs/W3cPresentation.md)\n- [W3cPresentationContext](docs/W3cPresentationContext.md)\n- [W3cPresentationContextOneOfInner](docs/W3cPresentationContextOneOfInner.md)\n- [W3cProof](docs/W3cProof.md)\n\n<a id=\"documentation-for-authorization\"></a>\n\n## Documentation For Authorization\n\nAuthentication schemes defined for the API:\n<a id=\"UserTokenAuth\"></a>\n\n### UserTokenAuth\n\n- **Type**: API key\n- **API key parameter name**: authorization\n- **Location**: HTTP header\n\n<a id=\"ProjectTokenAuth\"></a>\n\n### ProjectTokenAuth\n\n- **Type**: API key\n- **API key parameter name**: authorization\n- **Location**: HTTP header\n\n## Author\n\ninfo@affinidi.com\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "VerificationService",
"version": "1.33.0",
"project_urls": {
"Homepage": "https://github.com/affinidi/affinidi-tdk",
"Repository": "https://github.com/affinidi/affinidi-tdk"
},
"split_keywords": [
"openapi",
" openapi-generator",
" verificationservice"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "830db54f39a88c20051bb5bb8e6e5f0cf941b108505086f7f026a5fec1e0f222",
"md5": "c8a9a6b90940ed038d7bdee8e0e2277a",
"sha256": "dbbc8153eb5ae9c9cf49db191f324da0bb59b63cd56dd5f5dcee130032152d4a"
},
"downloads": -1,
"filename": "affinidi_tdk_credential_verification_client-1.33.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c8a9a6b90940ed038d7bdee8e0e2277a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 84491,
"upload_time": "2024-12-18T08:51:10",
"upload_time_iso_8601": "2024-12-18T08:51:10.899676Z",
"url": "https://files.pythonhosted.org/packages/83/0d/b54f39a88c20051bb5bb8e6e5f0cf941b108505086f7f026a5fec1e0f222/affinidi_tdk_credential_verification_client-1.33.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9d65a3b0b4fbe18e0bf620dc04031ce33fd5d40e71eca3a123ddf2e1abbe0155",
"md5": "277d1e9b4f701af4162759fa2012162c",
"sha256": "ae682e1693f12f5bc89a8d7379c273cfee4bf31c2d288a191c8844086c329c64"
},
"downloads": -1,
"filename": "affinidi_tdk_credential_verification_client-1.33.0.tar.gz",
"has_sig": false,
"md5_digest": "277d1e9b4f701af4162759fa2012162c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 35728,
"upload_time": "2024-12-18T08:51:12",
"upload_time_iso_8601": "2024-12-18T08:51:12.263008Z",
"url": "https://files.pythonhosted.org/packages/9d/65/a3b0b4fbe18e0bf620dc04031ce33fd5d40e71eca3a123ddf2e1abbe0155/affinidi_tdk_credential_verification_client-1.33.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 08:51:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "affinidi",
"github_project": "affinidi-tdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "affinidi_tdk_credential_verification_client"
}
JSON
