Clean REST API. Signed webhooks. Consent baked into every request. Resolve verified contact data at scale with a single integration.
Quick Start
Install the SDK, authenticate, and resolve. That's it.
1 — INSTALL
npm i @cardo/sdk
2 — INIT
import Cardo from '@cardo/sdk' const cardo = new Cardo(apiKey)
3 — RESOLVE
const contact = await cardo.resolve(email)
// Full example — resolve + webhook listener
import Cardo from '@cardo/sdk';
const cardo = new Cardo({
apiKey: process.env.CARDO_API_KEY,
webhookSecret: process.env.CARDO_WEBHOOK_SECRET,
});
// Resolve a contact — returns consented fields only
const contact = await cardo.resolve('user@example.com', {
fields: ['phone', 'address', 'email'],
});
console.log(contact);
// {
// phone: "+1 415 555 0123",
// email: "user@example.com",
// address: { street: "...", city: "...", zip: "..." },
// consent_ref: "crd_perm_abc123",
// freshness: "2026-04-10T17:00:00Z"
// }
// Listen for real-time updates via webhook
cardo.on('contact.updated', (event) => {
console.log(event.field + ' changed for ' + event.contact_id);
// => "phone changed for usr_abc123"
});API Capabilities
Look up any CIRQL user by email, phone, or ID. Returns only fields the user has explicitly consented to share.
Get push notifications when contact data changes. Signed payloads, retry logic, and delivery receipts included.
Query consent status per user per field. Revocation is instant and propagates across all connected systems.
Full trail of who accessed what, when, and under which consent reference. Exportable for compliance reporting.
Create read-only, webhook-only, or admin keys. Rotate credentials without downtime. Role-based access across teams.
Edge-deployed API with SLA-backed uptime. Federated architecture means no single point of failure.
SDK Support
Official SDKs for the most popular server-side languages. All open source.
Node.js
npm i @cardo/sdkPython
pip install cardoGo
go get cardo.id/sdkREST
curl api.cardo.id/v1Join the developer beta. We'll send you API keys, documentation, and a sandbox environment.