Blockchain Credential API Developer Guide

Introduction to Credential APIs

Blockchain credential APIs enable programmatic issuance and verification of credentials. This guide covers integration best practices.

API Capabilities Overview

Certificate Issuance

• Create new certificates
• Attach metadata
• Generate verification links
• Trigger blockchain recording

Certificate Verification

• Validate certificate authenticity
• Check certificate status
• Retrieve certificate metadata
• Confirm issuer identity

Certificate Management

• Revoke certificates
• Update metadata
• Retrieve issuance history
• Generate reports

Authentication

API Key Authentication

All API requests require authentication:

Authorization: Bearer YOUR_API_KEY

API keys can be generated in your OnChainCert dashboard under Settings > API.

Security Best Practices

• Store API keys securely
• Use environment variables
• Rotate keys periodically
• Use separate keys for production and development

Core Endpoints

Issue Certificate

POST /api/v1/certificates

Request body:

• recipient_name: Recipient full name
• recipient_email: Email address
• title: Certificate title
• description: Certificate description
• issued_date: Issue date
• metadata: Additional custom fields

Verify Certificate

GET /api/v1/verify/{certificate_id}

Returns:

• valid: Boolean verification status
• certificate: Certificate details
• blockchain: Blockchain transaction info
• issuer: Issuer information

Revoke Certificate

POST /api/v1/certificates/{id}/revoke

Request body:

• reason: Revocation reason

Integration Patterns

LMS Integration

Trigger certificate issuance on course completion:

1. Configure webhook from LMS
2. Receive completion event
3. Call issuance API
4. Return certificate link to LMS

HR System Integration

Verify credentials during hiring:

1. Candidate provides certificate ID
2. Call verification API
3. Display verification result
4. Store verification record

Bulk Operations

For high-volume issuance:

1. Prepare CSV with recipient data
2. Call bulk issuance endpoint
3. Monitor job status
4. Retrieve issued certificates

Webhook Events

Subscribe to events for real-time updates:

• certificate.issued: New certificate created
• certificate.verified: Certificate verified
• certificate.revoked: Certificate revoked
• blockchain.confirmed: Transaction confirmed

Error Handling

Common Error Codes

• 400: Invalid request parameters
• 401: Authentication failed
• 404: Certificate not found
• 429: Rate limit exceeded
• 500: Server error

Rate Limiting

API requests are rate limited:

• Free tier: 100 requests/hour
• Paid plans: Higher limits based on plan

SDKs and Libraries

Official SDKs available for:

• JavaScript/Node.js
• Python
• Ruby
• PHP

Testing

Sandbox Environment

Use sandbox for development:

• Separate API endpoint
• Test credentials
• No blockchain costs
• Full functionality

Getting Started

1. Sign up for OnChainCert account
2. Generate API key
3. Review API documentation
4. Start with sandbox testing
5. Deploy to production

Access full API documentation →