Skip to main content

Quick Start Guide

Get up and running with Skippy in minutes. This guide will walk you through creating your first organization, project, template, and credential.

Prerequisites​

  • A Skippy account (sign up at skippy.id)
  • Basic understanding of verifiable credentials
  • API access (optional, for programmatic integration)

Step 1: Create Your Organization​

  1. Sign in to Skippy

    • Navigate to skippy.id
    • Sign in with your account

  2. Create Organization

    • Click "Create Organization" in the dashboard
    • Fill in your organization details:
      • Organization name
      • Description
      • Contact information
    • Click "Create"

Step 2: Create Your First API Key​

  1. Navigate to API Keys

    • From your organization dashboard, click "API Keys" in the sidebar
    • Or navigate to: https://skippy.id/organisation/{orgId}/apikeys

  2. Generate API Key

    • Click "Create API Key" or the "+" button
    • Enter a descriptive name (e.g., "Production API", "Development Testing")
    • Click "Generate Key"
    • Important: Copy the API key immediately - you won't be able to see it again

  3. Secure Your Key

    • Store the API key securely (password manager, environment variables)
    • Never commit API keys to version control
    • Use different keys for different environments

Step 3: Create Your First Project​

  1. Navigate to Projects

    • From your organization dashboard, click "Projects"
    • Click "Create New Project"

  2. Configure Project

    • Enter project name (e.g., "Employee Badges")
    • Add description
    • Set project settings
    • Click "Create Project"

Step 4: Create a Credential Template​

  1. Navigate to Templates

    • In your project, go to "Templates"
    • Click "Create Template"

  2. Choose Template Type

    • Select "SD-JWT Credential Template" or "OpenID VC Template"
    • Fill in template details:
      • Template name
      • Description
      • Credential schema

  3. Define Credential Structure

    {
    	"name": "Employee Badge",
    	"description": "Employee identification credential",
    	"type": "EmployeeBadge",
    	"attributes": {
    		"employeeId": {
    			"name": "Employee ID",
    			"type": "string",
    			"description": "Unique employee identifier",
    			"required": true
    		},
    		"fullName": {
    			"name": "Full Name",
    			"type": "string",
    			"description": "Employee's full name",
    			"required": true
    		},
    		"department": {
    			"name": "Department",
    			"type": "string",
    			"description": "Employee's department",
    			"required": false
    		},
    		"startDate": {
    			"name": "Start Date",
    			"type": "date",
    			"description": "Employee start date",
    			"required": false
    		}
    	}
    }

  4. Save Template

    • Review your template
    • Click "Create Template"

Step 5: Issue Your First Credential​

  1. Navigate to Credentials

    • In your project, go to "Credentials"
    • Click "Issue Credential"

  2. Select Template

    • Choose the template you created
    • Click "Continue"

  3. Fill Credential Data

    • Enter the credential data:
      • Employee ID: "EMP001"
      • Full Name: "John Doe"
      • Department: "Engineering"
      • Start Date: "2024-01-15"

  4. Configure Issuance

    • Enter recipient email address
    • Set expiration date (optional)
    • Add custom metadata (optional)
    • Click "Issue Credential"

Step 6: Verify a Credential​

  1. Navigate to Verification

    • Go to "Verification" in your project
    • Click "Verify Credential"

  2. Submit Credential

    • Paste the credential data or upload the credential file
    • Click "Verify"

  3. Review Results

    • View verification results
    • Check credential validity
    • Review credential details

Next Steps​

API Integration​

If you want to integrate Skippy programmatically:

  1. Use Your API Key

    • You already created an API key in Step 2
    • Use that key for all API calls

  2. Make Your First API Call

    curl -X GET "https://api.skippy.id/v1/org/{orgId}" \
      -H "Authorization: Bearer YOUR_API_KEY"
    Finding Your IDs
    • orgId: Dashboard URL → skippy.id/organisation/{orgId} or Organization Settings
    • projectId: Project URL → skippy.id/organisation/{orgId}/project/{projectId}
    • API Key: Organization → API Keys → Copy key (shown once)

  3. Create a Template via API

    curl -X POST "https://api.skippy.id/v1/template/credential" \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "name": "Employee Badge",
        "description": "Employee identification credential",
        "type": "EmployeeBadge",
        "attributes": {
          "employeeId": {
            "name": "Employee ID",
            "type": "string",
            "required": true
          }
        }
      }'

  4. Issue a Credential via API

    curl -X POST "https://api.skippy.id/v1/openidvc/offer" \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "templateId": "template-id",
        "credentialData": {
          "employeeId": "EMP001"
        },
        "recipientEmail": "john.doe@example.com"
      }'

Webhook Setup​

Set up webhooks for real-time notifications:

  1. Create Webhook

    • Go to "Webhooks" in your project
    • Click "Create Webhook"
    • Enter your webhook URL
    • Select events to listen for

  2. Test Webhook

    • Issue a test credential
    • Verify webhook delivery

Common Tasks​

Managing Users​

  • Invite Users: Go to "Users" → "Invite User"
  • Set Permissions: Configure user roles and permissions
  • Remove Users: Manage user access

Template Management​

  • Create Templates: Define credential structures
  • Version Templates: Update and version your templates
  • Archive Templates: Manage template lifecycle

Credential Lifecycle​

  • Issue Credentials: Create and distribute credentials
  • Revoke Credentials: Invalidate credentials when needed
  • Update Credentials: Modify existing credentials

Troubleshooting​

Common Issues​

  1. Template Creation Fails

    • Check schema format
    • Ensure all required fields are defined
    • Verify JSON syntax

  2. Credential Issuance Fails

    • Verify template exists
    • Check required fields are provided
    • Ensure API key has proper permissions

  3. Verification Fails

    • Check credential format
    • Verify credential hasn't expired
    • Ensure DID is resolvable

Getting Help​

  • Documentation: Explore the full documentation
  • API Reference: Check the API documentation
  • Support: Contact support for additional help

What's Next?​

Now that you've completed the quick start: