Quick Start Guide: Create a verifier instance

Prerequisites

Before you start using the Vidos Verifier, ensure you have the following prerequisites in place:

  • Vidos Account: Sign up for a Vidos account if you don't already have one.
  • API Key: Obtain your API key from the Vidos dashboard.
  • Node.js: Ensure Node.js is installed on your system.

How to

Step 1: Dashboard

  1. Login to Vidos Dashboard: Navigate to the Vidos dashboard and log in with your credentials.
  2. Access Verifier Section: From the dashboard, access the Verifier section to manage your verification instances and settings.

Step 2: Create Instance

Create a New Verifier Instance:

  1. Click on the "Create Instance" button.
  2. Provide a name and description for your instance.
  3. Configure the settings and types of Verified Credentials that your instance will support.

New Verifier Instance

Step 3: Configuration

Configure Verification Settings:

  1. Define the verification policies and rules according to your requirements.
  2. Configure any additional settings, such as logging and notification preferences.

Step 4: API Key

Generate API Key:

  1. Navigate to the API Keys section in the dashboard.
  2. Click on "Generate New Key" to create an API key for your verifier instance.
  3. Copy the API key securely, as you will need it for API calls.

Step 5: Test Verification

Using the Test Environment

Ensure you have a set of sample VCs for testing purposes. You can use one of our provided test VCs here.

{
    "verifiableCredential": {
        "@context": [
            "https://www.w3.org/2018/credentials/v1",
            "https://w3id.org/security/suites/ed25519-2020/v1",
            "https://w3id.org/security/data-integrity/v2"
        ],
        "id": "urn:uuid:a9aef9b6-b9a0-44b4-b9cd-1ed5d155257d",
        "type": "VerifiableCredential",
        "credentialSubject": "did:key:z6MkhTNL7i2etLerDK8Acz5t528giE5KA4p75T6ka1E1D74r",
        "issuer": "did:key:zDnaeRpdr3KkQ1NtBhLAWFp76epvaU1spZzGH7AvKtY9KqjZr",
        "proof": {
            "created": "2024-07-15T13:52:31Z",
            "cryptosuite": "ecdsa-rdfc-2019",
            "proofPurpose": "assertionMethod",
            "proofValue": "z27HVZrACyBMSTkFJDL1gFT34kPCWfTfXYmUJXJnLkec3HN1pxXS8127oDjHBvtK2zz7sy18SzkETm1p6z5MmZRDp",
            "type": "DataIntegrityProof",
            "verificationMethod": "did:key:zDnaeRpdr3KkQ1NtBhLAWFp76epvaU1spZzGH7AvKtY9KqjZr#zDnaeRpdr3KkQ1NtBhLAWFp76epvaU1spZzGH7AvKtY9KqjZr"
        }
    }
}
  1. Make a Test API Call:

Use the following curl command to test the verification process:

Note

Remember to replace the Endpoint and API Key with your own details.

curl -X POST https://<Your API Endpoint>.verifier.service.eu.vidos.id/w3c-ccg/vc-api/v0.0.3/credentials/verify \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Your API Key>" \
  -d '{
        "verifiableCredential": {
            "@context": [
                "https://www.w3.org/2018/credentials/v1",
                "https://w3id.org/security/suites/ed25519-2020/v1",
                "https://w3id.org/security/data-integrity/v2"
            ],
            "id": "urn:uuid:a9aef9b6-b9a0-44b4-b9cd-1ed5d155257d",
            "type": "VerifiableCredential",
            "credentialSubject": "did:key:z6MkhTNL7i2etLerDK8Acz5t528giE5KA4p75T6ka1E1D74r",
            "issuer": "did:key:zDnaeRpdr3KkQ1NtBhLAWFp76epvaU1spZzGH7AvKtY9KqjZr",
            "proof": {
                "created": "2024-07-15T13:52:31Z",
                "cryptosuite": "ecdsa-rdfc-2019",
                "proofPurpose": "assertionMethod",
                "proofValue": "z27HVZrACyBMSTkFJDL1gFT34kPCWfTfXYmUJXJnLkec3HN1pxXS8127oDjHBvtK2zz7sy18SzkETm1p6z5MmZRDp",
                "type": "DataIntegrityProof",
                "verificationMethod": "did:key:zDnaeRpdr3KkQ1NtBhLAWFp76epvaU1spZzGH7AvKtY9KqjZr#zDnaeRpdr3KkQ1NtBhLAWFp76epvaU1spZzGH7AvKtY9KqjZr"
            }
        }
    }'
  1. Check the Response:
    • Review the response to ensure the VC has been verified successfully.
    • Use the logs and error messages to troubleshoot any issues.

By following these steps, you’ll be able to set up and start using the Vidos Verifier effectively. For more detailed information, refer to the subsequent sections on configuration, API usage, and advanced topics.