Skip to main content

VC Component Configuration

info

Please note that this content is under development and is not ready for implementation. This status message will be updated as content development progresses.

Description

The VC Component Configuration object contains the configuration details for the components to use VC services such as verifying a VC, issuing a VC, etc inside the component.

Definitions

PropertyRequiredDescriptionType
credentialPathYesThe path for the credential in the data. In some case, the credential can be the whole data or just be contained in the dataString
vckitAPIUrlYesThe URL for the vckit APIString
headersNoThe headers for the vckit API, example: { Authorization: "Bearer test123"}HTTP Headers

Example

{
"credentialPath": "/",
"vckitAPIUrl": "https://vckit-api.com",
"headers": { "Authorization": "Bearer test" }
}

This example shows the credential path is the root of the data, it means the whole data is the credential.

{
"credentialPath": "/credential",
"vckitAPIUrl": "https://vckit-api.com",
"headers": { "Authorization": "Bearer test" }
}

This example shows the credential path is /credential, it means the credential is inside the data at the path /credential.