v1REST + Webhooks — Node, Python, Go SDKs

Integrate with CARDO™ in minutes

Clean REST API. Signed webhooks. Consent baked into every request. Resolve verified contact data at scale with a single integration.

Quick Start

Three lines to verified data

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

Everything you need to build on verified identity

🔍

Contact Resolution

Look up any CIRQL user by email, phone, or ID. Returns only fields the user has explicitly consented to share.

🔔

Webhook Events

Get push notifications when contact data changes. Signed payloads, retry logic, and delivery receipts included.

🔒

Consent Management

Query consent status per user per field. Revocation is instant and propagates across all connected systems.

📊

Audit Logs

Full trail of who accessed what, when, and under which consent reference. Exportable for compliance reporting.

🔑

Scoped API Keys

Create read-only, webhook-only, or admin keys. Rotate credentials without downtime. Role-based access across teams.

Sub-50ms Latency

Edge-deployed API with SLA-backed uptime. Federated architecture means no single point of failure.

SDK Support

Your language. Your framework.

Official SDKs for the most popular server-side languages. All open source.

Node.js

npm i @cardo/sdk

Python

pip install cardo

Go

go get cardo.id/sdk

REST

curl api.cardo.id/v1

Get early API access

Join the developer beta. We'll send you API keys, documentation, and a sandbox environment.