Integrate ValueCard into your application. Verify identities, query trust scores, award points, and receive real-time webhook events — all through a clean REST API.
import { ValueCard } from '@valuecard/sdk';
const vc = new ValueCard({ apiKey: process.env.VALUECARD_API_KEY });
// Verify a user's identity and trust score
const profile = await vc.identity.verify('GK-48291');
console.log(profile.name); // "Kwame Mensah"
console.log(profile.tier); // "Gold"
console.log(profile.trustScore); // 84
console.log(profile.verified); // true
// Award points for a qualifying action
await vc.points.award({
cardId: 'GK-48291',
action: 'ticket_purchase',
metadata: { eventId: 'EVT-1024', type: 'vip' }
});
// Listen for tier changes
vc.webhooks.on('tier.changed', (event) => {
console.log(`${event.cardId} upgraded to ${event.newTier}`);
});API Products
Six API products covering identity, trust, events, NFC, points, and card management. RESTful. JSON responses. OAuth 2.0 authentication.
Verify a user's ValueCard identity in real time. Confirm their tier, trust score, and account status before granting access to your product or service.
GET /v1/identity/{card_id}
GET /v1/identity/verify
POST /v1/identity/validate-nfc
Query a user's current trust score (0–100) and tier. Use it for risk assessment, eligibility gating, or personalised experiences based on verified reputation.
GET /v1/score/{card_id}
GET /v1/score/{card_id}/tier
GET /v1/score/{card_id}/history
Receive real-time notifications when a user's tier changes, when a gate scan occurs, or when a score milestone is reached. Build reactive integrations.
POST /v1/webhooks/register
GET /v1/webhooks/list
DELETE /v1/webhooks/{webhook_id}
Read and validate NFC tap events from physical ValueCards. Parse the NDEF payload to extract the verified profile and deep link for contact saving.
POST /v1/nfc/read
GET /v1/nfc/profile/{card_id}
GET /v1/nfc/vcard/{card_id}
Submit qualifying activities to award ValuePoints to users within your integration. Track point balances and tier progression.
POST /v1/points/award
GET /v1/points/{card_id}/balance
GET /v1/points/{card_id}/activity
Manage card issuance workflows. Request physical card upgrades, track delivery status, and manage card lifecycle events for your users.
POST /v1/cards/request-upgrade
GET /v1/cards/{card_id}/status
GET /v1/cards/{card_id}/tier
Quick Start
Register your application and receive API credentials. Each key is scoped to your integration with rate limits based on your plan.
Choose your platform — JavaScript, Python, Flutter, or raw REST. Install the SDK and initialise with your API key.
Verify a user's identity, query their trust score, or award points. Every response includes the user's current tier and verification status.
Available SDKs
npm install @valuecard/sdkpip install valuecardflutter pub add valuecardcurl -H "Authorization: Bearer YOUR_KEY" https://api.valuecard.io/v1/...Use Cases
Verify attendee identity at the gate. Award points for ticket purchases and attendance. Enable VIP access based on card tier.
Gate physical or digital access behind ValueCard tier requirements. Only Gold and above get early access. Only verified users enter.
Display seller trust scores to buyers. Filter listings by verified reputation. Reduce fraud with identity verification at checkout.
Streamline onboarding with pre-verified identity. A user's ValueCard history tells you more than a form ever could.
API Principles
Industry-standard authentication. Scoped API keys with granular permissions per integration.
User consent required for data access. You only see what the user has authorised you to see.
Sub-100ms response times globally. Score lookups and identity verification designed for real-time use.
Semantic versioning. Breaking changes are announced 90 days in advance. Deprecations are documented.
Request your API key and start building on verified trust. Our developer relations team is here to help you ship.